org.opensaml.xmlsec.impl

Class BasicEncryptionConfiguration

java.lang.Object

org.opensaml.xmlsec.impl.BasicWhitelistBlacklistConfiguration

org.opensaml.xmlsec.impl.BasicEncryptionConfiguration

All Implemented Interfaces:

EncryptionConfiguration, WhitelistBlacklistConfiguration

public class BasicEncryptionConfiguration
extends BasicWhitelistBlacklistConfiguration
implements EncryptionConfiguration

Basic implementation of EncryptionConfiguration.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensaml.xmlsec.WhitelistBlacklistConfiguration

WhitelistBlacklistConfiguration.Precedence

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.String>	dataEncryptionAlgorithms Data encryption algorithm URIs.
private java.util.List<Credential>	dataEncryptionCredentials Data encryption credentials.
private NamedKeyInfoGeneratorManager	dataKeyInfoGeneratorManager Manager for named KeyInfoGenerator instances for encrypting data.
private java.util.List<java.lang.String>	keyTransportEncryptionAlgorithms Key transport encryption algorithm URIs.
private java.util.List<Credential>	keyTransportEncryptionCredentials Key transport encryption credentials.
private NamedKeyInfoGeneratorManager	keyTransportKeyInfoGeneratorManager Manager for named KeyInfoGenerator instances for encrypting keys.
private KeyTransportAlgorithmPredicate	keyTransportPredicate Key transport algorithm predicate.
private org.slf4j.Logger	log Class logger.
private RSAOAEPParameters	rsaOAEPParameters RSA OAEP parameters.
private boolean	rsaOAEPParametersMerge Flag whether to merge RSA OAEP parameters.

Fields inherited from class org.opensaml.xmlsec.impl.BasicWhitelistBlacklistConfiguration

DEFAULT_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
BasicEncryptionConfiguration() Constructor.

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.
void	setDataEncryptionAlgorithms(java.util.List<java.lang.String> algorithms) Set the data encryption algorithms to use.
void	setDataEncryptionCredentials(java.util.List<Credential> credentials) Set the data encryption credentials to use.
void	setDataKeyInfoGeneratorManager(NamedKeyInfoGeneratorManager keyInfoManager) Set the manager for named KeyInfoGenerator instances encrypting data.
void	setKeyTransportAlgorithmPredicate(KeyTransportAlgorithmPredicate predicate) Set the instance of KeyTransportAlgorithmPredicate.
void	setKeyTransportEncryptionAlgorithms(java.util.List<java.lang.String> algorithms) Set the key transport encryption algorithms to use.
void	setKeyTransportEncryptionCredentials(java.util.List<Credential> credentials) Set the key transport encryption credentials to use.
void	setKeyTransportKeyInfoGeneratorManager(NamedKeyInfoGeneratorManager keyInfoManager) Set the manager for named KeyInfoGenerator instances for encrypting keys.
void	setRSAOAEPParameters(RSAOAEPParameters params) Set the instance of RSAOAEPParameters.
void	setRSAOAEPParametersMerge(boolean flag) Set the 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 class org.opensaml.xmlsec.impl.BasicWhitelistBlacklistConfiguration

getBlacklistedAlgorithms, getWhitelistBlacklistPrecedence, getWhitelistedAlgorithms, isBlacklistMerge, isWhitelistMerge, setBlacklistedAlgorithms, setBlacklistMerge, setWhitelistBlacklistPrecedence, setWhitelistedAlgorithms, setWhitelistMerge

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensaml.xmlsec.WhitelistBlacklistConfiguration

getBlacklistedAlgorithms, getWhitelistBlacklistPrecedence, getWhitelistedAlgorithms, isBlacklistMerge, isWhitelistMerge

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

dataEncryptionCredentials

@Nonnull
 @NonnullElements
private java.util.List<Credential> dataEncryptionCredentials

Data encryption credentials.

dataEncryptionAlgorithms

@Nonnull
 @NonnullElements
private java.util.List<java.lang.String> dataEncryptionAlgorithms

Data encryption algorithm URIs.

keyTransportEncryptionCredentials

@Nonnull
 @NonnullElements
private java.util.List<Credential> keyTransportEncryptionCredentials

Key transport encryption credentials.

keyTransportEncryptionAlgorithms

@Nonnull
 @NonnullElements
private java.util.List<java.lang.String> keyTransportEncryptionAlgorithms

Key transport encryption algorithm URIs.

dataKeyInfoGeneratorManager

@Nullable
private NamedKeyInfoGeneratorManager dataKeyInfoGeneratorManager

Manager for named KeyInfoGenerator instances for encrypting data.

keyTransportKeyInfoGeneratorManager

@Nullable
private NamedKeyInfoGeneratorManager keyTransportKeyInfoGeneratorManager

Manager for named KeyInfoGenerator instances for encrypting keys.

rsaOAEPParameters

@Nullable
private RSAOAEPParameters rsaOAEPParameters

RSA OAEP parameters.

rsaOAEPParametersMerge

private boolean rsaOAEPParametersMerge

Flag whether to merge RSA OAEP parameters.

keyTransportPredicate

@Nullable
private KeyTransportAlgorithmPredicate keyTransportPredicate

Key transport algorithm predicate.

Constructor Detail

BasicEncryptionConfiguration

public BasicEncryptionConfiguration()

Constructor.

Method Detail

getDataEncryptionCredentials

@Nonnull
 @NonnullElements
 @Unmodifiable
 @NotLive
public java.util.List<Credential> getDataEncryptionCredentials()

Get the list of data encryption credentials to use, in preference order.

Specified by:

getDataEncryptionCredentials in interface EncryptionConfiguration

Returns:

the list of encryption credentials, may be empty

setDataEncryptionCredentials

public void setDataEncryptionCredentials(@Nullable
                                         java.util.List<Credential> credentials)

Set the data encryption credentials to use.

Parameters:

credentials - the list of data encryption credentials

getDataEncryptionAlgorithms

@Nonnull
 @NonnullElements
 @Unmodifiable
 @NotLive
public java.util.List<java.lang.String> getDataEncryptionAlgorithms()

Get the list of preferred data encryption algorithm URIs, in preference order.

Specified by:

getDataEncryptionAlgorithms in interface EncryptionConfiguration

Returns:

the list of algorithm URIs, may be empty

setDataEncryptionAlgorithms

public void setDataEncryptionAlgorithms(@Nullable
                                        java.util.List<java.lang.String> algorithms)

Set the data encryption algorithms to use.

Parameters:

algorithms - the list of algorithms

getKeyTransportEncryptionCredentials

@Nonnull
 @NonnullElements
 @Unmodifiable
 @NotLive
public java.util.List<Credential> getKeyTransportEncryptionCredentials()

Get the list of key transport encryption credentials to use, in preference order.

Specified by:

getKeyTransportEncryptionCredentials in interface EncryptionConfiguration

Returns:

the list of encryption credentials, may be empty

setKeyTransportEncryptionCredentials

public void setKeyTransportEncryptionCredentials(@Nullable
                                                 java.util.List<Credential> credentials)

Set the key transport encryption credentials to use.

Parameters:

credentials - the list of key transport encryption credentials

getKeyTransportEncryptionAlgorithms

@Nonnull
 @NonnullElements
 @Unmodifiable
 @NotLive
public java.util.List<java.lang.String> getKeyTransportEncryptionAlgorithms()

Get the list of preferred key transport encryption algorithm URIs, in preference order.

Specified by:

getKeyTransportEncryptionAlgorithms in interface EncryptionConfiguration

Returns:

the list of algorithm URIs, may be empty

setKeyTransportEncryptionAlgorithms

public void setKeyTransportEncryptionAlgorithms(@Nullable
                                                java.util.List<java.lang.String> algorithms)

Set the key transport encryption algorithms to use.

Parameters:

algorithms - the list of algorithms

getDataKeyInfoGeneratorManager

@Nullable
public NamedKeyInfoGeneratorManager getDataKeyInfoGeneratorManager()

Get the KeyInfoGenerator manager to use when generating the EncryptedData/KeyInfo.

Specified by:

getDataKeyInfoGeneratorManager in interface EncryptionConfiguration

Returns:

the KeyInfoGenerator manager instance

setDataKeyInfoGeneratorManager

public void setDataKeyInfoGeneratorManager(@Nullable
                                           NamedKeyInfoGeneratorManager keyInfoManager)

Set the manager for named KeyInfoGenerator instances encrypting data.

Parameters:

keyInfoManager - the KeyInfoGenerator manager to use

getKeyTransportKeyInfoGeneratorManager

@Nullable
public NamedKeyInfoGeneratorManager getKeyTransportKeyInfoGeneratorManager()

Get the KeyInfoGenerator manager to use when generating the EncryptedKey/KeyInfo.

Specified by:

getKeyTransportKeyInfoGeneratorManager in interface EncryptionConfiguration

Returns:

the KeyInfoGenerator manager instance

setKeyTransportKeyInfoGeneratorManager

public void setKeyTransportKeyInfoGeneratorManager(@Nullable
                                                   NamedKeyInfoGeneratorManager keyInfoManager)

Set the manager for named KeyInfoGenerator instances for encrypting keys.

Parameters:

keyInfoManager - the KeyInfoGenerator manager to use

getRSAOAEPParameters

@Nullable
public RSAOAEPParameters getRSAOAEPParameters()

Get the instance of RSAOAEPParameters.

Specified by:

getRSAOAEPParameters in interface EncryptionConfiguration

Returns:

the parameters instance

setRSAOAEPParameters

public void setRSAOAEPParameters(@Nullable
                                 RSAOAEPParameters params)

Set the instance of RSAOAEPParameters.

Parameters:

params - the new parameters instance

isRSAOAEPParametersMerge

public 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..

Defaults to: true

Specified by:

isRSAOAEPParametersMerge in interface EncryptionConfiguration

Returns:

true if should merge, false otherwise

setRSAOAEPParametersMerge

public void setRSAOAEPParametersMerge(boolean flag)

Set the 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.

Defaults to: true

Parameters:

flag - true if should merge, false otherwise

getKeyTransportAlgorithmPredicate

@Nullable
public KeyTransportAlgorithmPredicate getKeyTransportAlgorithmPredicate()

Get the instance of KeyTransportAlgorithmPredicate.

Specified by:

getKeyTransportAlgorithmPredicate in interface EncryptionConfiguration

Returns:

the predicate instance

setKeyTransportAlgorithmPredicate

public void setKeyTransportAlgorithmPredicate(KeyTransportAlgorithmPredicate predicate)

Set the instance of KeyTransportAlgorithmPredicate.

Parameters:

predicate - the new predicate instance