java.lang.Object
- com.mastercard.developer.encryption.FieldLevelEncryptionConfigBuilder

public class FieldLevelEncryptionConfigBuilder
extends Object

A builder class for FieldLevelEncryptionConfig.

Field Summary

Fields
Modifier and Type	Field	Description
`protected PrivateKey`	`decryptionKey`
`protected Map<String,String>`	`decryptionPaths`
`protected String`	`encryptedValueFieldName`
`protected Certificate`	`encryptionCertificate`
`protected PublicKey`	`encryptionKey`
`protected String`	`encryptionKeyFingerprint`
`protected Map<String,String>`	`encryptionPaths`
`protected Integer`	`ivSize`

Constructor Summary

Constructors
Constructor Description

FieldLevelEncryptionConfigBuilder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static FieldLevelEncryptionConfigBuilder`	`aFieldLevelEncryptionConfig()`	Get an instance of the builder.
`FieldLevelEncryptionConfig`	`build()`	Build a `FieldLevelEncryptionConfig`.
`FieldLevelEncryptionConfigBuilder`	`withDecryptionKey(PrivateKey decryptionKey)`	See: `EncryptionConfig.decryptionKey`.
`FieldLevelEncryptionConfigBuilder`	`withDecryptionPath(String jsonPathIn, String jsonPathOut)`	See: `EncryptionConfig.decryptionPaths`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptedKeyFieldName(String encryptedKeyFieldName)`	See: `FieldLevelEncryptionConfig.encryptedKeyFieldName`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptedKeyHeaderName(String encryptedKeyHeaderName)`	See: `FieldLevelEncryptionConfig.encryptedKeyHeaderName`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptedValueFieldName(String encryptedValueFieldName)`	See: `EncryptionConfig.encryptedValueFieldName`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptionCertificate(Certificate encryptionCertificate)`	See: `EncryptionConfig.encryptionCertificate`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptionCertificateFingerprint(String encryptionCertificateFingerprint)`	See: `FieldLevelEncryptionConfig.encryptionCertificateFingerprint`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptionCertificateFingerprintFieldName(String encryptionCertificateFingerprintFieldName)`	See: `FieldLevelEncryptionConfig.encryptionCertificateFingerprintFieldName`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptionCertificateFingerprintHeaderName(String encryptionCertificateFingerprintHeaderName)`	See: `FieldLevelEncryptionConfig.encryptionCertificateFingerprintHeaderName`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptionIVSize(Integer ivSize)`	See: `EncryptionConfig.ivSize`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptionKeyFingerprint(String encryptionKeyFingerprint)`	See: `EncryptionConfig.encryptionKeyFingerprint`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptionKeyFingerprintFieldName(String encryptionKeyFingerprintFieldName)`	See: `FieldLevelEncryptionConfig.encryptionKeyFingerprintFieldName`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptionKeyFingerprintHeaderName(String encryptionKeyFingerprintHeaderName)`	See: `FieldLevelEncryptionConfig.encryptionKeyFingerprintHeaderName`.
`FieldLevelEncryptionConfigBuilder`	`withEncryptionPath(String jsonPathIn, String jsonPathOut)`	See: `EncryptionConfig.encryptionPaths`.
`FieldLevelEncryptionConfigBuilder`	`withFieldValueEncoding(FieldLevelEncryptionConfig.FieldValueEncoding fieldValueEncoding)`	See: `FieldLevelEncryptionConfig.fieldValueEncoding`.
`FieldLevelEncryptionConfigBuilder`	`withIvFieldName(String ivFieldName)`	See: `FieldLevelEncryptionConfig.ivFieldName`.
`FieldLevelEncryptionConfigBuilder`	`withIvHeaderName(String ivHeaderName)`	See: `FieldLevelEncryptionConfig.ivHeaderName`.
`FieldLevelEncryptionConfigBuilder`	`withOaepPaddingDigestAlgorithm(String oaepPaddingDigestAlgorithm)`	See: `FieldLevelEncryptionConfig.oaepPaddingDigestAlgorithm`.
`FieldLevelEncryptionConfigBuilder`	`withOaepPaddingDigestAlgorithmFieldName(String oaepPaddingDigestAlgorithmFieldName)`	See: `FieldLevelEncryptionConfig.oaepPaddingDigestAlgorithmFieldName`.
`FieldLevelEncryptionConfigBuilder`	`withOaepPaddingDigestAlgorithmHeaderName(String oaepPaddingDigestAlgorithmHeaderName)`	See: `FieldLevelEncryptionConfig.oaepPaddingDigestAlgorithmHeaderName`.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

encryptionCertificate

protected Certificate encryptionCertificate

encryptionKey
```
protected PublicKey encryptionKey
```

encryptionKeyFingerprint

protected String encryptionKeyFingerprint

decryptionKey
```
protected PrivateKey decryptionKey
```

encryptionPaths

protected Map<String,String> encryptionPaths

decryptionPaths

protected Map<String,String> decryptionPaths

encryptedValueFieldName

protected String encryptedValueFieldName

ivSize
```
protected Integer ivSize
```

Constructor Detail
- FieldLevelEncryptionConfigBuilder
```
public FieldLevelEncryptionConfigBuilder()
```

Method Detail

aFieldLevelEncryptionConfig

public static FieldLevelEncryptionConfigBuilder aFieldLevelEncryptionConfig()

Get an instance of the builder.

withEncryptionCertificate

public FieldLevelEncryptionConfigBuilder withEncryptionCertificate(Certificate encryptionCertificate)

See: EncryptionConfig.encryptionCertificate.

withEncryptionCertificateFingerprint

public FieldLevelEncryptionConfigBuilder withEncryptionCertificateFingerprint(String encryptionCertificateFingerprint)

See: FieldLevelEncryptionConfig.encryptionCertificateFingerprint.

withEncryptionKeyFingerprint

public FieldLevelEncryptionConfigBuilder withEncryptionKeyFingerprint(String encryptionKeyFingerprint)

See: EncryptionConfig.encryptionKeyFingerprint.

withDecryptionKey

public FieldLevelEncryptionConfigBuilder withDecryptionKey(PrivateKey decryptionKey)

See: EncryptionConfig.decryptionKey.

withEncryptionPath

public FieldLevelEncryptionConfigBuilder withEncryptionPath(String jsonPathIn,
                                                            String jsonPathOut)

See: EncryptionConfig.encryptionPaths.

withDecryptionPath

public FieldLevelEncryptionConfigBuilder withDecryptionPath(String jsonPathIn,
                                                            String jsonPathOut)

See: EncryptionConfig.decryptionPaths.

withOaepPaddingDigestAlgorithm

public FieldLevelEncryptionConfigBuilder withOaepPaddingDigestAlgorithm(String oaepPaddingDigestAlgorithm)

See: FieldLevelEncryptionConfig.oaepPaddingDigestAlgorithm.

withIvFieldName

public FieldLevelEncryptionConfigBuilder withIvFieldName(String ivFieldName)

See: FieldLevelEncryptionConfig.ivFieldName.

withOaepPaddingDigestAlgorithmFieldName

public FieldLevelEncryptionConfigBuilder withOaepPaddingDigestAlgorithmFieldName(String oaepPaddingDigestAlgorithmFieldName)

See: FieldLevelEncryptionConfig.oaepPaddingDigestAlgorithmFieldName.

withEncryptedKeyFieldName

public FieldLevelEncryptionConfigBuilder withEncryptedKeyFieldName(String encryptedKeyFieldName)

See: FieldLevelEncryptionConfig.encryptedKeyFieldName.

withEncryptedValueFieldName

public FieldLevelEncryptionConfigBuilder withEncryptedValueFieldName(String encryptedValueFieldName)

See: EncryptionConfig.encryptedValueFieldName.

withEncryptionCertificateFingerprintFieldName

public FieldLevelEncryptionConfigBuilder withEncryptionCertificateFingerprintFieldName(String encryptionCertificateFingerprintFieldName)

See: FieldLevelEncryptionConfig.encryptionCertificateFingerprintFieldName.

withEncryptionKeyFingerprintFieldName

public FieldLevelEncryptionConfigBuilder withEncryptionKeyFingerprintFieldName(String encryptionKeyFingerprintFieldName)

See: FieldLevelEncryptionConfig.encryptionKeyFingerprintFieldName.

withFieldValueEncoding

public FieldLevelEncryptionConfigBuilder withFieldValueEncoding(FieldLevelEncryptionConfig.FieldValueEncoding fieldValueEncoding)

See: FieldLevelEncryptionConfig.fieldValueEncoding.

withIvHeaderName

public FieldLevelEncryptionConfigBuilder withIvHeaderName(String ivHeaderName)

See: FieldLevelEncryptionConfig.ivHeaderName.

withOaepPaddingDigestAlgorithmHeaderName

public FieldLevelEncryptionConfigBuilder withOaepPaddingDigestAlgorithmHeaderName(String oaepPaddingDigestAlgorithmHeaderName)

See: FieldLevelEncryptionConfig.oaepPaddingDigestAlgorithmHeaderName.

withEncryptedKeyHeaderName

public FieldLevelEncryptionConfigBuilder withEncryptedKeyHeaderName(String encryptedKeyHeaderName)

See: FieldLevelEncryptionConfig.encryptedKeyHeaderName.

withEncryptionCertificateFingerprintHeaderName

public FieldLevelEncryptionConfigBuilder withEncryptionCertificateFingerprintHeaderName(String encryptionCertificateFingerprintHeaderName)

See: FieldLevelEncryptionConfig.encryptionCertificateFingerprintHeaderName.

withEncryptionKeyFingerprintHeaderName

public FieldLevelEncryptionConfigBuilder withEncryptionKeyFingerprintHeaderName(String encryptionKeyFingerprintHeaderName)

See: FieldLevelEncryptionConfig.encryptionKeyFingerprintHeaderName.

withEncryptionIVSize

public FieldLevelEncryptionConfigBuilder withEncryptionIVSize(Integer ivSize)

See: EncryptionConfig.ivSize.

build

public FieldLevelEncryptionConfig build()
                                 throws EncryptionException

Build a FieldLevelEncryptionConfig.

Throws:: EncryptionException

Class FieldLevelEncryptionConfigBuilder