se.litsec.opensaml.saml2.metadata.build

Class AbstractEntityDescriptorBuilder<T extends AbstractSAMLObjectBuilder<EntityDescriptor>>

java.lang.Object

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

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

Type Parameters:

T - the concrete builder type

All Implemented Interfaces:

SAMLObjectBuilder<EntityDescriptor>

Direct Known Subclasses:

IdpEntityDescriptorBuilder, SpEntityDescriptorBuilder

public abstract class AbstractEntityDescriptorBuilder<T extends AbstractSAMLObjectBuilder<EntityDescriptor>>
extends AbstractSAMLObjectBuilder<EntityDescriptor>

Abstract base builder for creating EntityDescriptor objects using the builder pattern, and optionally a template object.

When a template object is used, the builder is created using the AbstractEntityDescriptorBuilder(InputStream) or AbstractEntityDescriptorBuilder(EntityDescriptor) constructors. The user may later change, or add, any of the elements and attributes of the template object using the assignment methods.

Note that no Signature will be included.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_CATEGORY_ATTRIBUTE_NAME The attribute name for the entity category attribute stored as an attribute in the entity attributes extension.
static AttributeTemplate	ENTITY_CATEGORY_TEMPLATE The attribute template for the entity category attribute stored as an attribute in the entity attributes extension.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
T	cacheDuration(Long cacheDuration) Assigns the cacheDuration attribute for the EntityDescriptor.
T	contactPersons(ContactPerson... contactPersons)
T	contactPersons(List<ContactPerson> contactPersons) Assigns the ContactPerson elements to the entity descriptor.
T	entityAttributesExtension(Attribute... attributes)
T	entityAttributesExtension(List<Attribute> attributes) Adds attributes to the mdattr:EntityAttributes element that is part of the metadata extension element.
T	entityCategories(List<String> entityCategories) Adds a set of entity categories to the entity category attribute (http://macedir.org/entity-category) that is part of the mdattr:EntityAttributes element that is part of the metadata extension element.
T	entityCategories(String... entityCategories)
T	entityID(String entityID) Assigns the entityID for the EntityDescriptor.
protected Class<EntityDescriptor>	getObjectType() Returns the object type.
protected abstract T	getThis() In order for us to be able to make chaining calls we need to return the concrete type of the builder.
T	id(String id) Assigns the ID attribute for the EntityDescriptor.
T	keyDescriptors(KeyDescriptor... keyDescriptors)
T	keyDescriptors(List<KeyDescriptor> keyDescriptors) Adds the key descriptor elements.
protected abstract boolean	matchingSSODescriptorType(EntityDescriptor descriptor) Checks that the SSO descriptor of the supplied EntityDescriptor is of the correct type given the factory bean type.
T	nameIDFormats(List<String> nameIDFormats) Assigns the md:NameIDFormat elements.
T	nameIDFormats(String... nameIDFormats)
T	organization(Organization organization) Assigns the Organization element to the entity descriptor.
T	singleLogoutServices(List<SingleLogoutService> singleLogoutServices) Adds md:SingleLogoutService elements to the SSODescriptor.
T	singleLogoutServices(SingleLogoutService... singleLogoutServices)
protected abstract SSODescriptor	ssoDescriptor() Returns the SSO role descriptor of the template entity descriptor.
T	uiInfoExtension(UIInfo uiInfo) Assigns the mdui:UIInfo element as an extension to the role descriptor.
T	validUntil(org.joda.time.DateTime time) Assigns the valid until time.
T	validUntil(LocalDateTime time) Assigns the valid until time (using the local time zone).

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

build, object

Methods inherited from class java.lang.Object

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

Field Detail

ENTITY_CATEGORY_ATTRIBUTE_NAME

public static final String ENTITY_CATEGORY_ATTRIBUTE_NAME

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

See Also:

Constant Field Values

ENTITY_CATEGORY_TEMPLATE

public static final AttributeTemplate ENTITY_CATEGORY_TEMPLATE

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

Constructor Detail

AbstractEntityDescriptorBuilder

public AbstractEntityDescriptorBuilder()

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

AbstractEntityDescriptorBuilder

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

AbstractEntityDescriptorBuilder

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

getObjectType

protected Class<EntityDescriptor> getObjectType()

Returns the object type.

Specified by:

getObjectType in class AbstractSAMLObjectBuilder<EntityDescriptor>

Returns:

the object type

getThis

protected abstract T 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

ssoDescriptor

protected abstract SSODescriptor ssoDescriptor()

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

Returns:

the role descriptor

matchingSSODescriptorType

protected abstract 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.

Parameters:

descriptor - the descriptor to check

Returns:

true if the type is OK, and false otherwise

entityID

public T entityID(String entityID)

Assigns the entityID for the EntityDescriptor.

Parameters:

entityID - the entityID

Returns:

the builder

id

public T id(String id)

Assigns the ID attribute for the EntityDescriptor.

Parameters:

id - the ID

Returns:

the builder

cacheDuration

public T cacheDuration(Long cacheDuration)

Assigns the cacheDuration attribute for the EntityDescriptor.

Parameters:

cacheDuration - the cache duration (in milliseconds)

Returns:

the builder

validUntil

public T validUntil(org.joda.time.DateTime time)

Assigns the valid until time.

Parameters:

time - valid until

Returns:

the builder

validUntil

public T validUntil(LocalDateTime time)

Assigns the valid until time (using the local time zone).

Parameters:

time - valid until

Returns:

the builder

entityAttributesExtension

public T entityAttributesExtension(List<Attribute> attributes)

Adds attributes to the mdattr:EntityAttributes element that is part of the metadata extension element.

Parameters:

attributes - a list of attributes

Returns:

the builder

See Also:

entityCategories(String...)

entityAttributesExtension

public T entityAttributesExtension(Attribute... attributes)

Parameters:

attributes - attributes to add

Returns:

the builder

See Also:

entityAttributesExtension(List)

entityCategories

public T entityCategories(List<String> entityCategories)

Adds a set of entity categories to the entity category attribute (http://macedir.org/entity-category) 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:

entityCategories - the entity category values that should be added

Returns:

the builder

See Also:

entityAttributesExtension(List)

entityCategories

public T entityCategories(String... entityCategories)

Parameters:

entityCategories - the entity category values that should be added

Returns:

the builder

See Also:

entityCategories(List)

uiInfoExtension

public T uiInfoExtension(UIInfo uiInfo)

Assigns the mdui:UIInfo element as an extension to the role descriptor.

If null is supplied, the extension will be removed from the template entity descriptor (if present).

Parameters:

uiInfo - the UIInfo element (will be cloned before assignment)

Returns:

the builder

keyDescriptors

public T keyDescriptors(List<KeyDescriptor> keyDescriptors)

Adds the key descriptor elements.

Parameters:

keyDescriptors - the key descriptors

Returns:

the builder

keyDescriptors

public T keyDescriptors(KeyDescriptor... keyDescriptors)

Parameters:

keyDescriptors - the key descriptors

Returns:

the builder

See Also:

keyDescriptors(List)

nameIDFormats

public T nameIDFormats(List<String> nameIDFormats)

Assigns the md:NameIDFormat elements.

Parameters:

nameIDFormats - the nameID format strings

Returns:

the builder

nameIDFormats

public T nameIDFormats(String... nameIDFormats)

Parameters:

nameIDFormats - the nameID format strings

Returns:

the builder

See Also:

nameIDFormats(List)

singleLogoutServices

public T singleLogoutServices(List<SingleLogoutService> singleLogoutServices)

Adds md:SingleLogoutService elements to the SSODescriptor.

Parameters:

singleLogoutServices - single logout service objects (cloned before assignment)

Returns:

the builder

singleLogoutServices

public T singleLogoutServices(SingleLogoutService... singleLogoutServices)

Parameters:

singleLogoutServices - single logout service objects (cloned before assignment)

Returns:

the builder

See Also:

singleLogoutServices(List)

organization

public T organization(Organization organization)

Assigns the Organization element to the entity descriptor.

Parameters:

organization - the organization (will be cloned before assignment)

Returns:

the builder

contactPersons

public T contactPersons(List<ContactPerson> contactPersons)

Assigns the ContactPerson elements to the entity descriptor.

Parameters:

contactPersons - the contact person elements (will be cloned before assignment)

Returns:

the builder

contactPersons

public T contactPersons(ContactPerson... contactPersons)

Parameters:

contactPersons - the contact person elements (will be cloned before assignment)

Returns:

the builder

See Also:

contactPersons(List)