org.opensaml.xmlsec

Interface EncryptionConfiguration

All Superinterfaces:

WhitelistBlacklistConfiguration

All Known Implementing Classes:

BasicEncryptionConfiguration

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

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDataEncryptionAlgorithms() Get the list of preferred data encryption algorithm URIs, in preference order.
java.util.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 of KeyTransportAlgorithmPredicate.
java.util.List<java.lang.String>	getKeyTransportEncryptionAlgorithms() Get the list of preferred key transport encryption algorithm URIs, in preference order.
java.util.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 of RSAOAEPParameters.
boolean	isRSAOAEPParametersMerge() Flag indicating whether to merge this configuration's RSAOAEPParameters 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
java.util.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
java.util.List<java.lang.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
java.util.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
java.util.List<java.lang.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 of RSAOAEPParameters.

Returns:

the parameters instance

isRSAOAEPParametersMerge

boolean isRSAOAEPParametersMerge()

Flag indicating whether to merge this configuration's RSAOAEPParameters 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 of KeyTransportAlgorithmPredicate.

Returns:

the predicate instance