FcEncryptedUserType (formcycle: bom 8.5.6 API)

All Known Implementing Classes:

FcEncryptedBinaryType, FCEncryptedBinaryType, FcEncryptedIntegerType, FCEncryptedIntegerType, FcEncryptedStringType, FCEncryptedStringType, FormDataEncryptedBinaryType, FormDataEncryptedStringType
```
public interface FcEncryptedUserType
```
Base interface for all custom Hibernate types for encryption.

Since:

8.5.0

Author:

Norman Lorenz

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static String SCOPE
  The name of the property that defines the scope of the encryption.
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  Properties getConfig()
  Returns the encryption configuration for this type.

- Field Detail
  - SCOPE
```
static final String SCOPE
```
    The name of the property that defines the scope of the encryption.
    The scope can be used to differentiate between different encryption contexts, allowing for more granular control over the encryption process. By default, every encrypted type has a scope of null, which means that it uses the default encryption context (always encrypted). If you set the scope to a non-null value than encryption is only applied if this scope is enabled. Currently the only other encryption context that is supported is form, which is enabled if the form encryption feature in the database settings is enabled.
    
    Since:
    
    8.5.6
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getConfig
```
@Nullable
Properties getConfig()
```
    Returns the encryption configuration for this type.
    
    Returns:
    
    The configuration, may be null.