Package se.litsec.opensaml.saml2.common.request

Class AbstractRequestGenerator<T extends RequestAbstractType,I extends RequestGeneratorInput>

java.lang.Object

se.litsec.opensaml.saml2.common.request.AbstractRequestGenerator<T,I>

Type Parameters:

T - the request type

I - the type of the input required by this generator

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, RequestGenerator<T,I>

Direct Known Subclasses:

AbstractAuthnRequestGenerator

public abstract class AbstractRequestGenerator<T extends RequestAbstractType,I extends RequestGeneratorInput>
extends Object
implements RequestGenerator<T,I>, org.springframework.beans.factory.InitializingBean

Abstract base class for request generators.

Author:

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

Constructor Summary

Constructors

Constructor	Description
AbstractRequestGenerator(String entityID)	Constructor assigning the Service Provider entityID.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected RequestHttpObject<T>	buildRequestHttpObject(T request, I input, String binding, String destination)	Deprecated. Use buildRequestHttpObject(RequestAbstractType, RequestGeneratorInput, String, String, EntityDescriptor) instead
protected RequestHttpObject<T>	buildRequestHttpObject(T request, I input, String binding, String destination, EntityDescriptor recipientMetadata)	Builds a request HTTP object (including signing).
protected RequestHttpObject<T>	buildRequestHttpObject(T request, I input, String binding, String destination, EntityDescriptor recipientMetadata, SignatureSigningConfiguration defaultSignatureSigningConfiguration)	Builds a request HTTP object (including signing).
protected String	generateID()	Generates a request ID.
protected abstract String	getDefaultBinding()	Returns the binding URI for the binding the generator should use if there are more than one possible choice.
String	getEntityID()	Returns the entityID for the Service Provider this request generator is serving.
String	getName()	Returns the display name (for logging etc).
protected EntityDescriptor	getPeerMetadata(RequestGeneratorInput input, PeerMetadataResolver metadataResolver)	Returns the peer metadata.
protected Random	getRandomizer()	Returns the randomizer for generation of ID:s etc.
protected X509Credential	getSigningCredentials()	Returns the signature credentials.
void	setName(String name)	The human readable name for the SP instance
void	setSigningCredentials(X509Credential signingCredentials)	Assigns the signature credentials for the SP.

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.litsec.opensaml.saml2.common.request.RequestGenerator

generateRequest

Constructor Detail

AbstractRequestGenerator

public AbstractRequestGenerator(String entityID)

Constructor assigning the Service Provider entityID.

Parameters:

entityID - the entityID

Method Detail

getPeerMetadata

protected EntityDescriptor getPeerMetadata(RequestGeneratorInput input,
                                           PeerMetadataResolver metadataResolver)
                                    throws RequestGenerationException

Returns the peer metadata.

Parameters:

input - the request generation input

metadataResolver - the metadata resolver

Returns:

peer metadata

Throws:

RequestGenerationException - if no metadata is found

buildRequestHttpObject

@Deprecated
protected RequestHttpObject<T> buildRequestHttpObject(T request,
                                                      I input,
                                                      String binding,
                                                      String destination)
                                               throws RequestGenerationException

Deprecated.

Use buildRequestHttpObject(RequestAbstractType, RequestGeneratorInput, String, String, EntityDescriptor) instead

Builds a request HTTP object (including signing).

Parameters:

request - the actual request

input - the request generation input

binding - the binding to use

destination - the destination URL

Returns:

a request HTTP object

Throws:

RequestGenerationException - for errors during signing or encoding

buildRequestHttpObject

protected RequestHttpObject<T> buildRequestHttpObject(T request,
                                                      I input,
                                                      String binding,
                                                      String destination,
                                                      EntityDescriptor recipientMetadata)
                                               throws RequestGenerationException

Builds a request HTTP object (including signing).

Parameters:

request - the actual request

input - the request generation input

binding - the binding to use

destination - the destination URL

recipientMetadata - the recipient metadata (may be null)

Returns:

a request HTTP object

Throws:

RequestGenerationException - for errors during signing or encoding

buildRequestHttpObject

protected RequestHttpObject<T> buildRequestHttpObject(T request,
                                                      I input,
                                                      String binding,
                                                      String destination,
                                                      EntityDescriptor recipientMetadata,
                                                      SignatureSigningConfiguration defaultSignatureSigningConfiguration)
                                               throws RequestGenerationException

Builds a request HTTP object (including signing).

Parameters:

request - the actual request

input - the request generation input

binding - the binding to use

destination - the destination URL

recipientMetadata - the recipient metadata (may be null)

defaultSignatureSigningConfiguration - the default signature configuration for the application. If null, the value returned from SecurityConfigurationSupport.getGlobalSignatureSigningConfiguration() will be used

Returns:

a request HTTP object

Throws:

RequestGenerationException - for errors during signing or encoding

generateID

protected String generateID()

Generates a request ID.

Returns:

request ID

getSigningCredentials

protected X509Credential getSigningCredentials()

Returns the signature credentials.

Returns:

the signature credentials

getRandomizer

protected Random getRandomizer()

Returns the randomizer for generation of ID:s etc.

Returns:

randomizer instance

getDefaultBinding

protected abstract String getDefaultBinding()

Returns the binding URI for the binding the generator should use if there are more than one possible choice. May be overridden by RequestGeneratorInput.getPreferredBinding().

Returns:

binding URI

getEntityID

public String getEntityID()

Returns the entityID for the Service Provider this request generator is serving.

Specified by:

getEntityID in interface RequestGenerator<T extends RequestAbstractType,I extends RequestGeneratorInput>

Returns:

the entityID

getName

public String getName()

Returns the display name (for logging etc).

Specified by:

getName in interface RequestGenerator<T extends RequestAbstractType,I extends RequestGeneratorInput>

Returns:

the name

setName

public void setName(String name)

The human readable name for the SP instance

Parameters:

name - the name

setSigningCredentials

public void setSigningCredentials(X509Credential signingCredentials)

Assigns the signature credentials for the SP. If not assigned, signing will not be possible.

Parameters:

signingCredentials - signature credentials

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception