Package org.opensaml.xmlsec
Interface EncryptionConfiguration
-
- All Superinterfaces:
WhitelistBlacklistConfiguration
public interface EncryptionConfiguration extends WhitelistBlacklistConfiguration
The configuration information to use when generating encrypted XML.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.opensaml.xmlsec.WhitelistBlacklistConfiguration
WhitelistBlacklistConfiguration.Precedence
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<String>
getDataEncryptionAlgorithms()
Get the list of preferred data encryption algorithm URIs, in preference order.List<Credential>
getDataEncryptionCredentials()
Get the list of data encryption credentials to use, in preference order.NamedKeyInfoGeneratorManager
getDataKeyInfoGeneratorManager()
Get the KeyInfoGenerator manager to use when generating the EncryptedData/KeyInfo.KeyTransportAlgorithmPredicate
getKeyTransportAlgorithmPredicate()
Get the instance ofKeyTransportAlgorithmPredicate
.List<String>
getKeyTransportEncryptionAlgorithms()
Get the list of preferred key transport encryption algorithm URIs, in preference order.List<Credential>
getKeyTransportEncryptionCredentials()
Get the list of key transport encryption credentials to use, in preference order.NamedKeyInfoGeneratorManager
getKeyTransportKeyInfoGeneratorManager()
Get the KeyInfoGenerator manager to use when generating the EncryptedKey/KeyInfo.RSAOAEPParameters
getRSAOAEPParameters()
Get the instance ofRSAOAEPParameters
.boolean
isRSAOAEPParametersMerge()
Flag indicating whether to merge this configuration'sRSAOAEPParameters
values with those of a lower order of precedence, or to treat this configuration's parameters set as authoritative.-
Methods inherited from interface org.opensaml.xmlsec.WhitelistBlacklistConfiguration
getBlacklistedAlgorithms, getWhitelistBlacklistPrecedence, getWhitelistedAlgorithms, isBlacklistMerge, isWhitelistMerge
-
-
-
-
Method Detail
-
getDataEncryptionCredentials
@Nonnull @NonnullElements @Unmodifiable @NotLive List<Credential> getDataEncryptionCredentials()
Get the list of data encryption credentials to use, in preference order.- Returns:
- the list of encryption credentials, may be empty
-
getDataEncryptionAlgorithms
@Nonnull @NonnullElements @Unmodifiable @NotLive List<String> getDataEncryptionAlgorithms()
Get the list of preferred data encryption algorithm URIs, in preference order.- Returns:
- the list of algorithm URIs, may be empty
-
getKeyTransportEncryptionCredentials
@Nonnull @NonnullElements @Unmodifiable @NotLive List<Credential> getKeyTransportEncryptionCredentials()
Get the list of key transport encryption credentials to use, in preference order.- Returns:
- the list of encryption credentials, may be empty
-
getKeyTransportEncryptionAlgorithms
@Nonnull @NonnullElements @Unmodifiable @NotLive List<String> getKeyTransportEncryptionAlgorithms()
Get the list of preferred key transport encryption algorithm URIs, in preference order.- Returns:
- the list of algorithm URIs, may be empty
-
getDataKeyInfoGeneratorManager
@Nullable NamedKeyInfoGeneratorManager getDataKeyInfoGeneratorManager()
Get the KeyInfoGenerator manager to use when generating the EncryptedData/KeyInfo.- Returns:
- the KeyInfoGenerator manager instance
-
getKeyTransportKeyInfoGeneratorManager
@Nullable NamedKeyInfoGeneratorManager getKeyTransportKeyInfoGeneratorManager()
Get the KeyInfoGenerator manager to use when generating the EncryptedKey/KeyInfo.- Returns:
- the KeyInfoGenerator manager instance
-
getRSAOAEPParameters
@Nullable RSAOAEPParameters getRSAOAEPParameters()
Get the instance ofRSAOAEPParameters
.- Returns:
- the parameters instance
-
isRSAOAEPParametersMerge
boolean isRSAOAEPParametersMerge()
Flag indicating whether to merge this configuration'sRSAOAEPParameters
values with those of a lower order of precedence, or to treat this configuration's parameters set as authoritative.- Returns:
- true if should merge, false otherwise
-
getKeyTransportAlgorithmPredicate
@Nullable KeyTransportAlgorithmPredicate getKeyTransportAlgorithmPredicate()
Get the instance ofKeyTransportAlgorithmPredicate
.- Returns:
- the predicate instance
-
-