class DataProtectionBuilder
cangjie
public class DataProtectionBuilder功能：提供数据保护服务的链式配置能力。
成员概览
| 成员 | 功能 |
|---|---|
| func setApplicationName(String) | 设置当前应用的数据保护隔离名称。 |
| func disableAutomaticKeyGeneration() | 禁用密钥自动生成。 |
| func setDefaultKeyLifetime(Duration) | 设置新密钥的默认生存期。 |
| func addKeyManagementOptions((KeyManagementOptions) -> Unit) | 添加密钥管理选项配置委托。 |
| func addKeyEscrowSink(IKeyEscrowSink) | 注册密钥托管接收器。 |
| func persistKeysToFileSystem(Path) | 将密钥持久化到文件系统目录。 |
| func useCryptographicAlgorithms(AuthenticatedEncryptorConfiguration) | 设置认证加密器算法配置。 |
func setApplicationName(String)
cangjie
public func setApplicationName(applicationName: String): DataProtectionBuilder功能：设置当前应用的数据保护隔离名称。
参数：
- applicationName:
String- 应用隔离名称。
返回值：
- DataProtectionBuilder - 返回当前数据保护构建器。
func disableAutomaticKeyGeneration()
cangjie
public func disableAutomaticKeyGeneration(): DataProtectionBuilder功能：禁用密钥自动生成。
返回值：
- DataProtectionBuilder - 返回当前数据保护构建器。
func setDefaultKeyLifetime(Duration)
cangjie
public func setDefaultKeyLifetime(lifetime: Duration): DataProtectionBuilder功能：设置新密钥的默认生存期。
参数：
- lifetime:
Duration- 密钥生存期。
返回值：
- DataProtectionBuilder - 返回当前数据保护构建器。
异常：
IllegalArgumentException- 当密钥生存期为负数时抛出。
func addKeyManagementOptions((KeyManagementOptions) -> Unit)
cangjie
public func addKeyManagementOptions(configureOptions: (KeyManagementOptions) -> Unit): DataProtectionBuilder功能：添加密钥管理选项配置委托。
参数：
- configureOptions: (KeyManagementOptions) -> Unit - 用于配置密钥管理选项的委托。
返回值：
- DataProtectionBuilder - 返回当前数据保护构建器。
func addKeyEscrowSink(IKeyEscrowSink)
cangjie
public func addKeyEscrowSink(sink: IKeyEscrowSink): DataProtectionBuilder功能：注册密钥托管接收器。
参数：
- sink: IKeyEscrowSink - 在密钥持久化前接收明文密钥材料副本的接收器。
返回值：
- DataProtectionBuilder - 返回当前数据保护构建器。
func persistKeysToFileSystem(Path)
cangjie
public func persistKeysToFileSystem(path: Path): DataProtectionBuilder功能：将密钥持久化到文件系统目录。
参数：
- path:
Path- 密钥存储目录。
返回值：
- DataProtectionBuilder - 返回当前数据保护构建器。
func useCryptographicAlgorithms(AuthenticatedEncryptorConfiguration)
cangjie
public func useCryptographicAlgorithms(configuration: AuthenticatedEncryptorConfiguration): DataProtectionBuilder功能：设置认证加密器算法配置。
参数：
- configuration: AuthenticatedEncryptorConfiguration - 认证加密器算法配置。
返回值：
- DataProtectionBuilder - 返回当前数据保护构建器。