Package org.opensaml.xmlsec.impl

Class BasicEncryptionConfiguration

java.lang.Object

org.opensaml.xmlsec.impl.BasicWhitelistBlacklistConfiguration

org.opensaml.xmlsec.impl.BasicEncryptionConfiguration

All Implemented Interfaces:

org.opensaml.xmlsec.EncryptionConfiguration, org.opensaml.xmlsec.WhitelistBlacklistConfiguration

public class BasicEncryptionConfiguration
extends BasicWhitelistBlacklistConfiguration
implements org.opensaml.xmlsec.EncryptionConfiguration

Basic implementation of EncryptionConfiguration.

Nested Class Summary

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

org.opensaml.xmlsec.WhitelistBlacklistConfiguration.Precedence

Field Summary

Fields

Modifier and Type	Field	Description
private List<String>	dataEncryptionAlgorithms	Data encryption algorithm URIs.
private List<org.opensaml.security.credential.Credential>	dataEncryptionCredentials	Data encryption credentials.
private org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager	dataKeyInfoGeneratorManager	Manager for named KeyInfoGenerator instances for encrypting data.
private List<String>	keyTransportEncryptionAlgorithms	Key transport encryption algorithm URIs.
private List<org.opensaml.security.credential.Credential>	keyTransportEncryptionCredentials	Key transport encryption credentials.
private org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager	keyTransportKeyInfoGeneratorManager	Manager for named KeyInfoGenerator instances for encrypting keys.
private org.opensaml.xmlsec.KeyTransportAlgorithmPredicate	keyTransportPredicate	Key transport algorithm predicate.
private org.slf4j.Logger	log	Class logger.
private org.opensaml.xmlsec.encryption.support.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	Description
BasicEncryptionConfiguration()	Constructor.

Method Summary

Modifier and Type	Method	Description
List<String>	getDataEncryptionAlgorithms()
List<org.opensaml.security.credential.Credential>	getDataEncryptionCredentials()
org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager	getDataKeyInfoGeneratorManager()
org.opensaml.xmlsec.KeyTransportAlgorithmPredicate	getKeyTransportAlgorithmPredicate()
List<String>	getKeyTransportEncryptionAlgorithms()
List<org.opensaml.security.credential.Credential>	getKeyTransportEncryptionCredentials()
org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager	getKeyTransportKeyInfoGeneratorManager()
org.opensaml.xmlsec.encryption.support.RSAOAEPParameters	getRSAOAEPParameters()
boolean	isRSAOAEPParametersMerge()	.
void	setDataEncryptionAlgorithms(List<String> algorithms)	Set the data encryption algorithms to use.
void	setDataEncryptionCredentials(List<org.opensaml.security.credential.Credential> credentials)	Set the data encryption credentials to use.
void	setDataKeyInfoGeneratorManager(org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager keyInfoManager)	Set the manager for named KeyInfoGenerator instances encrypting data.
void	setKeyTransportAlgorithmPredicate(org.opensaml.xmlsec.KeyTransportAlgorithmPredicate predicate)	Set the instance of KeyTransportAlgorithmPredicate.
void	setKeyTransportEncryptionAlgorithms(List<String> algorithms)	Set the key transport encryption algorithms to use.
void	setKeyTransportEncryptionCredentials(List<org.opensaml.security.credential.Credential> credentials)	Set the key transport encryption credentials to use.
void	setKeyTransportKeyInfoGeneratorManager(org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager keyInfoManager)	Set the manager for named KeyInfoGenerator instances for encrypting keys.
void	setRSAOAEPParameters(org.opensaml.xmlsec.encryption.support.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 List<org.opensaml.security.credential.Credential> dataEncryptionCredentials

Data encryption credentials.

dataEncryptionAlgorithms

@Nonnull
@NonnullElements
private List<String> dataEncryptionAlgorithms

Data encryption algorithm URIs.

keyTransportEncryptionCredentials

@Nonnull
@NonnullElements
private List<org.opensaml.security.credential.Credential> keyTransportEncryptionCredentials

Key transport encryption credentials.

keyTransportEncryptionAlgorithms

@Nonnull
@NonnullElements
private List<String> keyTransportEncryptionAlgorithms

Key transport encryption algorithm URIs.

dataKeyInfoGeneratorManager

@Nullable
private org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager dataKeyInfoGeneratorManager

Manager for named KeyInfoGenerator instances for encrypting data.

keyTransportKeyInfoGeneratorManager

@Nullable
private org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager keyTransportKeyInfoGeneratorManager

Manager for named KeyInfoGenerator instances for encrypting keys.

rsaOAEPParameters

@Nullable
private org.opensaml.xmlsec.encryption.support.RSAOAEPParameters rsaOAEPParameters

RSA OAEP parameters.

rsaOAEPParametersMerge

private boolean rsaOAEPParametersMerge

Flag whether to merge RSA OAEP parameters.

keyTransportPredicate

@Nullable
private org.opensaml.xmlsec.KeyTransportAlgorithmPredicate keyTransportPredicate

Key transport algorithm predicate.

Constructor Detail

BasicEncryptionConfiguration

public BasicEncryptionConfiguration()

Constructor.

Method Detail

getDataEncryptionCredentials

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public List<org.opensaml.security.credential.Credential> getDataEncryptionCredentials()

Specified by:

getDataEncryptionCredentials in interface org.opensaml.xmlsec.EncryptionConfiguration

setDataEncryptionCredentials

public void setDataEncryptionCredentials(@Nullable @NonnullElements
                                         List<org.opensaml.security.credential.Credential> credentials)

Set the data encryption credentials to use.

Parameters:

credentials - the list of data encryption credentials

getDataEncryptionAlgorithms

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public List<String> getDataEncryptionAlgorithms()

Specified by:

getDataEncryptionAlgorithms in interface org.opensaml.xmlsec.EncryptionConfiguration

setDataEncryptionAlgorithms

public void setDataEncryptionAlgorithms(@Nullable @NonnullElements
                                        List<String> algorithms)

Set the data encryption algorithms to use.

Parameters:

algorithms - the list of algorithms

getKeyTransportEncryptionCredentials

@Nonnull
@NonnullElements
@Unmodifiable
@NotLive
public List<org.opensaml.security.credential.Credential> getKeyTransportEncryptionCredentials()

Specified by:

getKeyTransportEncryptionCredentials in interface org.opensaml.xmlsec.EncryptionConfiguration

setKeyTransportEncryptionCredentials

public void setKeyTransportEncryptionCredentials(@Nullable @NonnullElements
                                                 List<org.opensaml.security.credential.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 List<String> getKeyTransportEncryptionAlgorithms()

Specified by:

getKeyTransportEncryptionAlgorithms in interface org.opensaml.xmlsec.EncryptionConfiguration

setKeyTransportEncryptionAlgorithms

public void setKeyTransportEncryptionAlgorithms(@Nullable @NonnullElements
                                                List<String> algorithms)

Set the key transport encryption algorithms to use.

Parameters:

algorithms - the list of algorithms

getDataKeyInfoGeneratorManager

@Nullable
public org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager getDataKeyInfoGeneratorManager()

Specified by:

getDataKeyInfoGeneratorManager in interface org.opensaml.xmlsec.EncryptionConfiguration

setDataKeyInfoGeneratorManager

public void setDataKeyInfoGeneratorManager(@Nullable
                                           org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager keyInfoManager)

Set the manager for named KeyInfoGenerator instances encrypting data.

Parameters:

keyInfoManager - the KeyInfoGenerator manager to use

getKeyTransportKeyInfoGeneratorManager

@Nullable
public org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager getKeyTransportKeyInfoGeneratorManager()

Specified by:

getKeyTransportKeyInfoGeneratorManager in interface org.opensaml.xmlsec.EncryptionConfiguration

setKeyTransportKeyInfoGeneratorManager

public void setKeyTransportKeyInfoGeneratorManager(@Nullable
                                                   org.opensaml.xmlsec.keyinfo.NamedKeyInfoGeneratorManager keyInfoManager)

Set the manager for named KeyInfoGenerator instances for encrypting keys.

Parameters:

keyInfoManager - the KeyInfoGenerator manager to use

getRSAOAEPParameters

@Nullable
public org.opensaml.xmlsec.encryption.support.RSAOAEPParameters getRSAOAEPParameters()

Specified by:

getRSAOAEPParameters in interface org.opensaml.xmlsec.EncryptionConfiguration

setRSAOAEPParameters

public void setRSAOAEPParameters(@Nullable
                                 org.opensaml.xmlsec.encryption.support.RSAOAEPParameters params)

Set the instance of RSAOAEPParameters.

Parameters:

params - the new parameters instance

isRSAOAEPParametersMerge

public boolean isRSAOAEPParametersMerge()

.

Defaults to: true

Specified by:

isRSAOAEPParametersMerge in interface org.opensaml.xmlsec.EncryptionConfiguration

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 org.opensaml.xmlsec.KeyTransportAlgorithmPredicate getKeyTransportAlgorithmPredicate()

Specified by:

getKeyTransportAlgorithmPredicate in interface org.opensaml.xmlsec.EncryptionConfiguration

setKeyTransportAlgorithmPredicate

public void setKeyTransportAlgorithmPredicate(org.opensaml.xmlsec.KeyTransportAlgorithmPredicate predicate)

Set the instance of KeyTransportAlgorithmPredicate.

Parameters:

predicate - the new predicate instance