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

Class IdpEntityDescriptorBuilder

java.lang.Object

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

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

se.litsec.opensaml.saml2.metadata.build.IdpEntityDescriptorBuilder

All Implemented Interfaces:

SAMLObjectBuilder<EntityDescriptor>

public class IdpEntityDescriptorBuilder
extends AbstractEntityDescriptorBuilder<IdpEntityDescriptorBuilder>

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

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
static String	ASSURANCE_CERTIFICATION_ATTRIBUTE_NAME	The attribute name for the assurance certification attribute stored as an attribute in the entity attributes extension.
static AttributeTemplate	ASSURANCE_CERTIFICATION_ATTRIBUTE_TEMPLATE	The attribute template for the assurance certification attribute stored as an attribute in the entity attributes extension.

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

ENTITY_CATEGORY_ATTRIBUTE_NAME, ENTITY_CATEGORY_TEMPLATE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
IdpEntityDescriptorBuilder	assuranceCertificationUris(String... uris)
IdpEntityDescriptorBuilder	assuranceCertificationUris(List<String> uris)	Adds a set of URIs to the assurance certification attribute (urn:oasis:names:tc:SAML:attribute:assurance-certification) that is part of the mdattr:EntityAttributes element that is part of the metadata extension element.
static IdpEntityDescriptorBuilder	builder()	Utility method that creates an IdpEntityDescriptorBuilder instance.
static IdpEntityDescriptorBuilder	builder(InputStream resource)	Utility method that creates an IdpEntityDescriptorBuilder instance from a supplied input stream.
static IdpEntityDescriptorBuilder	builder(EntityDescriptor template)	Utility method that creates an IdpEntityDescriptorBuilder instance from a supplied template.
protected IdpEntityDescriptorBuilder	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.
IdpEntityDescriptorBuilder	singleSignOnServices(List<SingleSignOnService> singleSignOnServices)	Adds md:SingleSignOnService elements to the IDPSSODescriptor.
IdpEntityDescriptorBuilder	singleSignOnServices(SingleSignOnService... singleSignOnServices)
protected SSODescriptor	ssoDescriptor()	Returns the SSO role descriptor of the template entity descriptor.
IdpEntityDescriptorBuilder	wantAuthnRequestsSigned(Boolean b)	Assigns the WantAuthnRequestsSigned attribute of the md:IDPSSODescriptor 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

Field Detail

ASSURANCE_CERTIFICATION_ATTRIBUTE_NAME

public static final String ASSURANCE_CERTIFICATION_ATTRIBUTE_NAME

The attribute name for the assurance certification attribute stored as an attribute in the entity attributes extension.

See Also:

Constant Field Values

ASSURANCE_CERTIFICATION_ATTRIBUTE_TEMPLATE

public static final AttributeTemplate ASSURANCE_CERTIFICATION_ATTRIBUTE_TEMPLATE

The attribute template for the assurance certification attribute stored as an attribute in the entity attributes extension.

Constructor Detail

IdpEntityDescriptorBuilder

public IdpEntityDescriptorBuilder()

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

IdpEntityDescriptorBuilder

public IdpEntityDescriptorBuilder(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

IdpEntityDescriptorBuilder

public IdpEntityDescriptorBuilder(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 IdpEntityDescriptorBuilder builder()

Utility method that creates an IdpEntityDescriptorBuilder instance.

Returns:

an IdpEntityDescriptorBuilder instance

builder

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

Utility method that creates an IdpEntityDescriptorBuilder instance from a supplied input stream.

Parameters:

resource - the template resource

Returns:

an IdpEntityDescriptorBuilder instance

Throws:

IOException - if the resource can not be read

UnmarshallingException - for unmarshalling errors

XMLParserException - for XML parsing errors

builder

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

Utility method that creates an IdpEntityDescriptorBuilder instance from a supplied template.

Parameters:

template - the template

Returns:

an IdpEntityDescriptorBuilder instance

Throws:

UnmarshallingException - for unmarshalling errors

MarshallingException - for marshalling errors

getThis

protected IdpEntityDescriptorBuilder 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<IdpEntityDescriptorBuilder>

Returns:

the concrete type of the builder

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<IdpEntityDescriptorBuilder>

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<IdpEntityDescriptorBuilder>

Parameters:

descriptor - the descriptor to check

Returns:

true if the type is OK, and false otherwise

wantAuthnRequestsSigned

public IdpEntityDescriptorBuilder wantAuthnRequestsSigned(Boolean b)

Assigns the WantAuthnRequestsSigned attribute of the md:IDPSSODescriptor element.

Parameters:

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

Returns:

the builder

assuranceCertificationUris

public IdpEntityDescriptorBuilder assuranceCertificationUris(List<String> uris)

Adds a set of URIs to the assurance certification attribute (urn:oasis:names:tc:SAML:attribute:assurance-certification) that is part of the mdattr:EntityAttributes element that is part of the metadata extension element.

The method does not update any of the other attributes that may exist in the entity attributes extension.

Parameters:

uris - the assurance URI values that should be added

Returns:

the builder

See Also:

AbstractEntityDescriptorBuilder.entityAttributesExtension(List)

assuranceCertificationUris

public IdpEntityDescriptorBuilder assuranceCertificationUris(String... uris)

Parameters:

uris - the assurance URI values that should be added

Returns:

the builder

See Also:

assuranceCertificationUris(List), AbstractEntityDescriptorBuilder.entityAttributesExtension(List)

singleSignOnServices

public IdpEntityDescriptorBuilder singleSignOnServices(List<SingleSignOnService> singleSignOnServices)

Adds md:SingleSignOnService elements to the IDPSSODescriptor.

Parameters:

singleSignOnServices - single sign on service objects (cloned before assignment)

Returns:

the builder

singleSignOnServices

public IdpEntityDescriptorBuilder singleSignOnServices(SingleSignOnService... singleSignOnServices)

Parameters:

singleSignOnServices - single sign on service objects (cloned before assignment)

Returns:

the builder

See Also:

AbstractEntityDescriptorBuilder.singleLogoutServices(List)