Package se.litsec.opensaml.saml2.metadata.build

Class SpEntityDescriptorBuilder

java.lang.Object

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

se.litsec.opensaml.saml2.metadata.build.AbstractEntityDescriptorBuilder<SpEntityDescriptorBuilder>

se.litsec.opensaml.saml2.metadata.build.SpEntityDescriptorBuilder

All Implemented Interfaces:

SAMLObjectBuilder<EntityDescriptor>

public class SpEntityDescriptorBuilder
extends AbstractEntityDescriptorBuilder<SpEntityDescriptorBuilder>

A builder for building an md:EntityDescription (metadata) object for a Service Provider.

Author:

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

Field Summary

Fields inherited from class se.litsec.opensaml.saml2.metadata.build.AbstractEntityDescriptorBuilder

ENTITY_CATEGORY_ATTRIBUTE_NAME, ENTITY_CATEGORY_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
SpEntityDescriptorBuilder()	Constructor setting up the builder with no template.
SpEntityDescriptorBuilder(InputStream resource)	Constructor setting up the builder with a template EntityDescriptor that is read from a resource.
SpEntityDescriptorBuilder(EntityDescriptor template)	Constructor setting up the builder with a template EntityDescriptor.

Method Summary

Modifier and Type	Method	Description
SpEntityDescriptorBuilder	assertionConsumerServices(List<AssertionConsumerService> assertionConsumerServices)	Adds md:AssertionConsumerService elements to the SPSSODescriptor.
SpEntityDescriptorBuilder	assertionConsumerServices(AssertionConsumerService... assertionConsumerServices)
SpEntityDescriptorBuilder	attributeConsumingServices(List<AttributeConsumingService> attributeConsumingServices)	Adds md:AttributeConsumingService elements to the SPSSODescriptor.
SpEntityDescriptorBuilder	attributeConsumingServices(AttributeConsumingService... attributeConsumingServices)
SpEntityDescriptorBuilder	authnRequestsSigned(Boolean b)	Assigns the AuthnRequestsSigned attribute of the md:SPSSODescriptor element.
static SpEntityDescriptorBuilder	builder()	Utility method that creates a SpEntityDescriptorBuilder instance.
static SpEntityDescriptorBuilder	builder(InputStream resource)	Utility method that creates a SpEntityDescriptorBuilder instance from a supplied input stream.
static SpEntityDescriptorBuilder	builder(EntityDescriptor template)	Utility method that creates a SpEntityDescriptorBuilder instance from a supplied template.
SpEntityDescriptorBuilder	discoveryResponses(String... locations)
SpEntityDescriptorBuilder	discoveryResponses(List<String> locations)	Adds discovery response locations in the given order (first string will be assigned index 1 and so on).
protected SpEntityDescriptorBuilder	getThis()	In order for us to be able to make chaining calls we need to return the concrete type of the builder.
protected boolean	matchingSSODescriptorType(EntityDescriptor descriptor)	Checks that the SSO descriptor of the supplied EntityDescriptor is of the correct type given the factory bean type.
protected SSODescriptor	ssoDescriptor()	Returns the SSO role descriptor of the template entity descriptor.
SpEntityDescriptorBuilder	wantAssertionsSigned(Boolean b)	Assigns the WantAssertionsSigned attribute of the md:SPSSODescriptor element.

Methods inherited from class se.litsec.opensaml.saml2.metadata.build.AbstractEntityDescriptorBuilder

cacheDuration, contactPersons, contactPersons, digestMethods, digestMethods, entityAttributesExtension, entityAttributesExtension, entityCategories, entityCategories, entityID, getObjectType, id, keyDescriptors, keyDescriptors, nameIDFormats, nameIDFormats, organization, signingMethods, signingMethods, singleLogoutServices, singleLogoutServices, uiInfoExtension, updateExtensions, validUntil

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

build, getDefaultElementName, object

Methods inherited from class java.lang.Object

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

Constructor Detail

SpEntityDescriptorBuilder

public SpEntityDescriptorBuilder()

Constructor setting up the builder with no template. This means that the entire EntityDescriptor object is created from data assigned using the builder.

SpEntityDescriptorBuilder

public SpEntityDescriptorBuilder(InputStream resource)
                          throws XMLParserException,
                                 UnmarshallingException,
                                 IOException

Constructor setting up the builder with a template EntityDescriptor that is read from a resource. Users of the bean may now change, add or delete, the elements and attributes of the template object using the assignment methods of the builder.

Parameters:

resource - the template resource

Throws:

IOException - if the resource can not be read

UnmarshallingException - for unmarshalling errors

XMLParserException - for XML parsing errors

SpEntityDescriptorBuilder

public SpEntityDescriptorBuilder(EntityDescriptor template)
                          throws UnmarshallingException,
                                 MarshallingException

Constructor setting up the builder with a template EntityDescriptor. Users of the bean may now change, add or delete, the elements and attributes of the template object using the assignment methods of the builder.

Parameters:

template - the template

Throws:

UnmarshallingException - for unmarshalling errors

MarshallingException - for marshalling errors

Method Detail

builder

public static SpEntityDescriptorBuilder builder()

Utility method that creates a SpEntityDescriptorBuilder instance.

Returns:

a SpEntityDescriptorBuilder instance

builder

public static SpEntityDescriptorBuilder builder(InputStream resource)
                                         throws XMLParserException,
                                                UnmarshallingException,
                                                IOException

Utility method that creates a SpEntityDescriptorBuilder instance from a supplied input stream.

Parameters:

resource - the template resource

Returns:

a SpEntityDescriptorBuilder instance

Throws:

IOException - if the resource can not be read

UnmarshallingException - for unmarshalling errors

XMLParserException - for XML parsing errors

builder

public static SpEntityDescriptorBuilder builder(EntityDescriptor template)
                                         throws UnmarshallingException,
                                                MarshallingException

Utility method that creates a SpEntityDescriptorBuilder instance from a supplied template.

Parameters:

template - the template

Returns:

a SpEntityDescriptorBuilder instance

Throws:

UnmarshallingException - for unmarshalling errors

MarshallingException - for marshalling errors

getThis

protected SpEntityDescriptorBuilder getThis()

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

Specified by:

getThis in class AbstractEntityDescriptorBuilder<SpEntityDescriptorBuilder>

Returns:

the concrete type of the builder

authnRequestsSigned

public SpEntityDescriptorBuilder authnRequestsSigned(Boolean b)

Assigns the AuthnRequestsSigned attribute of the md:SPSSODescriptor element.

Parameters:

b - boolean (if null, the attribute is not set)

Returns:

the builder

wantAssertionsSigned

public SpEntityDescriptorBuilder wantAssertionsSigned(Boolean b)

Assigns the WantAssertionsSigned attribute of the md:SPSSODescriptor element.

Parameters:

b - whether assertions should be signed

Returns:

the builder

discoveryResponses

public SpEntityDescriptorBuilder discoveryResponses(List<String> locations)

Adds discovery response locations in the given order (first string will be assigned index 1 and so on).

Parameters:

locations - URLs for discovery responses

Returns:

the builder

discoveryResponses

public SpEntityDescriptorBuilder discoveryResponses(String... locations)

Parameters:

locations - URLs for discovery responses

Returns:

the builder

See Also:

discoveryResponses(List)

assertionConsumerServices

public SpEntityDescriptorBuilder assertionConsumerServices(List<AssertionConsumerService> assertionConsumerServices)

Adds md:AssertionConsumerService elements to the SPSSODescriptor.

Parameters:

assertionConsumerServices - assertion consumer service objects (cloned before assignment)

Returns:

the builder

assertionConsumerServices

public SpEntityDescriptorBuilder assertionConsumerServices(AssertionConsumerService... assertionConsumerServices)

Parameters:

assertionConsumerServices - assertion consumer service objects (cloned before assignment)

Returns:

the builder

See Also:

assertionConsumerServices(List)

attributeConsumingServices

public SpEntityDescriptorBuilder attributeConsumingServices(List<AttributeConsumingService> attributeConsumingServices)

Adds md:AttributeConsumingService elements to the SPSSODescriptor.

Parameters:

attributeConsumingServices - attribute consumer service objects (cloned before assignment)

Returns:

the builder

attributeConsumingServices

public SpEntityDescriptorBuilder attributeConsumingServices(AttributeConsumingService... attributeConsumingServices)

Parameters:

attributeConsumingServices - attribute consumer service objects (cloned before assignment)

Returns:

the builder

See Also:

assertionConsumerServices(List)

ssoDescriptor

protected SSODescriptor ssoDescriptor()

Returns the SSO role descriptor of the template entity descriptor. If no role descriptor is present, the method creates such an object.

Specified by:

ssoDescriptor in class AbstractEntityDescriptorBuilder<SpEntityDescriptorBuilder>

Returns:

the role descriptor

matchingSSODescriptorType

protected boolean matchingSSODescriptorType(EntityDescriptor descriptor)

Checks that the SSO descriptor of the supplied EntityDescriptor is of the correct type given the factory bean type.

An entity descriptor that does not yet have an SSODescriptor element will also be regarded as a matching type.

Specified by:

matchingSSODescriptorType in class AbstractEntityDescriptorBuilder<SpEntityDescriptorBuilder>

Parameters:

descriptor - the descriptor to check

Returns:

true if the type is OK, and false otherwise