Package se.litsec.opensaml.xmlsec

Class SAMLObjectEncrypter

java.lang.Object

se.litsec.opensaml.xmlsec.SAMLObjectEncrypter

public class SAMLObjectEncrypter
extends Object

Utility class for encrypting an element for a SAML entity.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SAMLObjectEncrypter.Peer	Represents the peer when performing encryption.

Constructor Summary

Constructors

Constructor	Description
SAMLObjectEncrypter()	Sets up the object encrypter without a metadata provider.
SAMLObjectEncrypter(MetadataProvider metadataProvider)	Sets up the object encrypter with a metadata provider from where we find the peer credentials.

Method Summary

Modifier and Type	Method	Description
EncryptedData	encrypt(XMLObject xmlObject, SAMLObjectEncrypter.Peer peer)	Maps to encrypt(XMLObject, Peer, EncryptionConfiguration) where the default encryption configuration is supplied.
EncryptedData	encrypt(XMLObject xmlObject, SAMLObjectEncrypter.Peer peer, EncryptionConfiguration configuration)	Encrypts the supplied XML object by locating the peer encryption credentials and using the supplied configuration.
void	setAlgorithmRegistry(AlgorithmRegistry algorithmRegistry)	Sets the AlgorithmRegistry instance used when resolving algorithm URIs.
void	setDefaultEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	Sets the default encryption configuration to use.
void	setEncrypter(Encrypter encrypter)	The encrypter to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

SAMLObjectEncrypter

public SAMLObjectEncrypter()
                    throws ComponentInitializationException

Sets up the object encrypter without a metadata provider. This means that the peer metadata has to be supplied in calls to encrypt(XMLObject, Peer) and encrypt(XMLObject, Peer, EncryptionConfiguration).

Throws:

ComponentInitializationException - for init errors

SAMLObjectEncrypter

public SAMLObjectEncrypter(MetadataProvider metadataProvider)
                    throws ComponentInitializationException

Sets up the object encrypter with a metadata provider from where we find the peer credentials.

Parameters:

metadataProvider - the metadata provider

Throws:

ComponentInitializationException - for init errors

Method Detail

encrypt

public EncryptedData encrypt(XMLObject xmlObject,
                             SAMLObjectEncrypter.Peer peer)
                      throws EncryptionException

Maps to encrypt(XMLObject, Peer, EncryptionConfiguration) where the default encryption configuration is supplied.

Parameters:

xmlObject - the object to encrypt

peer - the peer to whom we encrypt for

Returns:

an EncryptedData object

Throws:

EncryptionException - for encryption errors

encrypt

public EncryptedData encrypt(XMLObject xmlObject,
                             SAMLObjectEncrypter.Peer peer,
                             EncryptionConfiguration configuration)
                      throws EncryptionException

Encrypts the supplied XML object by locating the peer encryption credentials and using the supplied configuration.

Parameters:

xmlObject - the object to encrypt

peer - the peer to whom we encrypt for

configuration - the encryption configuration

Returns:

an EncryptedData object

Throws:

EncryptionException - for encryption errors

setEncrypter

public void setEncrypter(Encrypter encrypter)

The encrypter to use.

If not assigned, an instance of Encrypter is used.

Parameters:

encrypter - the encrypter

setDefaultEncryptionConfiguration

public void setDefaultEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

Sets the default encryption configuration to use.

If not assigned, the system defaults will be used.

Parameters:

encryptionConfiguration - default encryption configuration

setAlgorithmRegistry

public void setAlgorithmRegistry(AlgorithmRegistry algorithmRegistry)

Sets the AlgorithmRegistry instance used when resolving algorithm URIs. Defaults to the registry resolved via AlgorithmSupport.getGlobalAlgorithmRegistry().

Parameters:

algorithmRegistry - the new algorithm registry instance