se.litsec.opensaml.saml2.core.build

Class AbstractRequestBuilder<T extends RequestAbstractType,BUILDER extends AbstractSAMLObjectBuilder<T>>

java.lang.Object

se.litsec.opensaml.core.AbstractSAMLObjectBuilder<T>

se.litsec.opensaml.saml2.core.build.AbstractRequestBuilder<T,BUILDER>

Type Parameters:

T - the type of request message

BUILDER - the builder type

All Implemented Interfaces:

SAMLObjectBuilder<T>

Direct Known Subclasses:

AbstractAuthnRequestBuilder

public abstract class AbstractRequestBuilder<T extends RequestAbstractType,BUILDER extends AbstractSAMLObjectBuilder<T>>
extends AbstractSAMLObjectBuilder<T>

Abstract builder class for building request messages.

Author:

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

Constructor Summary

Constructors

Constructor and Description
AbstractRequestBuilder()

Method Summary

Modifier and Type	Method and Description
T	build() The default implementation of this method assumes that the object has been built during assignment of its attributes and elements so it simply returns the object.
BUILDER	consent(String consent) Assigns the Consent attribute of the request.
BUILDER	destination(String destination) Assigns the Destination attribute of the request.
BUILDER	extensions(Extensions extensions) Assigns an Extensions element to the request.
protected abstract BUILDER	getThis() In order for us to be able to make chaining calls we need to return the concrete type of the builder.
BUILDER	id(String id) Assigns the ID attribute of the request.
BUILDER	issueInstant(org.joda.time.DateTime instant) Assigns the issue instant.
BUILDER	issueInstant(LocalDateTime instant) Assigns the issue instant (using the local time zone).
BUILDER	issuer(Issuer issuer) Assigns the Issuer element of the request.
BUILDER	issuer(String issuer) Assigns the Issuer element of the request by adding an Issuer element having the nameID format urn:oasis:names:tc:SAML:2.0:nameid-format:entity.
BUILDER	version(int major, int minor) Assigns the version attribute for the request.
BUILDER	version(String version) Assigns the version attribute for the request.

Methods inherited from class se.litsec.opensaml.core.AbstractSAMLObjectBuilder

getObjectType, object

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRequestBuilder

public AbstractRequestBuilder()

Method Detail

build

public T build()

The default implementation of this method assumes that the object has been built during assignment of its attributes and elements so it simply returns the object.

Implementations that need to perform additional processing during the build step should override this method.

Specified by:

build in interface SAMLObjectBuilder<T extends RequestAbstractType>

Overrides:

build in class AbstractSAMLObjectBuilder<T extends RequestAbstractType>

Returns:

the built object

version

public BUILDER version(int major,
                       int minor)

Assigns the version attribute for the request.

If not assigned, the SAMLVersion.VERSION_20 will be assigned as a default.

Parameters:

major - major version

minor - minor version

Returns:

the builder

version

public BUILDER version(String version)

Assigns the version attribute for the request.

If not assigned, the SAMLVersion.VERSION_20 will be assigned as a default.

Parameters:

version - the versions

Returns:

the builder

id

public BUILDER id(String id)

Assigns the ID attribute of the request.

Parameters:

id - the ID

Returns:

the builder

issueInstant

public BUILDER issueInstant(org.joda.time.DateTime instant)

Assigns the issue instant.

Parameters:

instant - the issue instant

Returns:

the builder

issueInstant

public BUILDER issueInstant(LocalDateTime instant)

Assigns the issue instant (using the local time zone).

Parameters:

instant - the issue instant

Returns:

the builder

destination

public BUILDER destination(String destination)

Assigns the Destination attribute of the request.

Parameters:

destination - the destination URI

Returns:

the builder

consent

public BUILDER consent(String consent)

Assigns the Consent attribute of the request.

Parameters:

consent - the consent string

Returns:

the builder

issuer

public BUILDER issuer(String issuer)

Assigns the Issuer element of the request by adding an Issuer element having the nameID format urn:oasis:names:tc:SAML:2.0:nameid-format:entity.

Parameters:

issuer - the entityID of the issuer

Returns:

the builder

See Also:

issuer(Issuer)

issuer

public BUILDER issuer(Issuer issuer)

Assigns the Issuer element of the request.

Parameters:

issuer - the issuer (will be cloned before assignment)

Returns:

the builder

extensions

public BUILDER extensions(Extensions extensions)

Assigns an Extensions element to the request.

Parameters:

extensions - the extensions element to add

Returns:

the builder

getThis

protected abstract BUILDER getThis()

In order for us to be able to make chaining calls we need to return the concrete type of the builder.

Returns:

the concrete type of the builder