se.litsec.opensaml.saml2.metadata.build.spring

Class SpEntityDescriptorFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

se.litsec.opensaml.core.spring.AbstractSAMLObjectBuilderFactoryBean<EntityDescriptor>

se.litsec.opensaml.saml2.metadata.build.spring.AbstractEntityDescriptorFactoryBean<SpEntityDescriptorBuilder>

se.litsec.opensaml.saml2.metadata.build.spring.SpEntityDescriptorFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<EntityDescriptor>, org.springframework.beans.factory.InitializingBean

public class SpEntityDescriptorFactoryBean
extends AbstractEntityDescriptorFactoryBean<SpEntityDescriptorBuilder>

A Spring factory bean for creating EntityDescriptor objects for Service Provider metadata using setter methods, and optionally a template object.

When a template object is used, the factory is initialized using the AbstractEntityDescriptorBuilder.AbstractEntityDescriptorBuilder(java.io.InputStream) or AbstractEntityDescriptorBuilder.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)

See Also:

SpEntityDescriptorBuilder

Field Summary

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Constructor Summary

Constructors

Constructor and Description
SpEntityDescriptorFactoryBean() Constructor setting up the factory with no template.
SpEntityDescriptorFactoryBean(EntityDescriptor template) Constructor setting up the factory with a template EntityDescriptor.
SpEntityDescriptorFactoryBean(org.springframework.core.io.Resource resource) Constructor setting up the factory with a template EntityDescriptor that is read from a resource.

Method Summary

Modifier and Type	Method and Description
protected SpEntityDescriptorBuilder	_builder() Returns the internal builder of the correct type.
protected AbstractSAMLObjectBuilder<EntityDescriptor>	builder() Returns the builder.
void	setAssertionConsumerService(AssertionConsumerService assertionConsumerService) Adds one md:AssertionConsumerService element to the SPSSODescriptor.
void	setAssertionConsumerServices(List<AssertionConsumerService> assertionConsumerServices) Adds md:AssertionConsumerService elements to the SPSSODescriptor.
void	setAttributeConsumingService(AttributeConsumingService attributeConsumingService) Adds one md:AttributeConsumingService element to the SPSSODescriptor.
void	setAttributeConsumingServices(List<AttributeConsumingService> attributeConsumingServices) Adds md:AttributeConsumingService elements to the SPSSODescriptor.
void	setAuthnRequestsSigned(Boolean b) Assigns the AuthnRequestsSigned attribute of the md:SPSSODescriptor element.
void	setDiscoveryResponse(String location) Adds one discovery response location.
void	setDiscoveryResponses(List<String> locations) Adds discovery response locations in the given order (first string will be assigned index 1 and so on).
void	setWantAssertionsSigned(Boolean b) Assigns the WantAssertionsSigned attribute of the md:SPSSODescriptor element.

Methods inherited from class se.litsec.opensaml.saml2.metadata.build.spring.AbstractEntityDescriptorFactoryBean

getObjectType, setCacheDuration, setContactPersons, setEntityAttributesExtension, setEntityCategories, setEntityID, setID, setKeyDescriptors, setNameIDFormats, setOrganization, setSingleLogoutServices, setUiInfoExtension, setValidUntil, setValidUntil

Methods inherited from class se.litsec.opensaml.core.spring.AbstractSAMLObjectBuilderFactoryBean

createInstance, localizedStringListToVarArgs, stringListToVarArgs, toVarArgs

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Constructor Detail

SpEntityDescriptorFactoryBean

public SpEntityDescriptorFactoryBean()

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

See Also:

SpEntityDescriptorBuilder.SpEntityDescriptorBuilder()

SpEntityDescriptorFactoryBean

public SpEntityDescriptorFactoryBean(org.springframework.core.io.Resource resource)
                              throws XMLParserException,
                                     UnmarshallingException,
                                     IOException

Constructor setting up the factory with a template EntityDescriptor that is read from a resource. Users of the bean may now change, add or delete (by using null values), the elements and attributes of the template object using the setter methods.

Parameters:

resource - the template resource

Throws:

IOException - if the resource can not be read

UnmarshallingException - for unmarshalling errors

XMLParserException - for XML parsing errors

SpEntityDescriptorFactoryBean

public SpEntityDescriptorFactoryBean(EntityDescriptor template)
                              throws UnmarshallingException,
                                     MarshallingException

Constructor setting up the factory with a template EntityDescriptor. Users of the bean may now change, add or delete (by using null values), the elements and attributes of the template object using the setter methods.

Parameters:

template - the template

Throws:

UnmarshallingException - for unmarshalling errors

MarshallingException - for marshalling errors

Method Detail

setAuthnRequestsSigned

public void setAuthnRequestsSigned(Boolean b)

Assigns the AuthnRequestsSigned attribute of the md:SPSSODescriptor element.

Parameters:

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

See Also:

SpEntityDescriptorBuilder.authnRequestsSigned(Boolean)

setWantAssertionsSigned

public void setWantAssertionsSigned(Boolean b)

Assigns the WantAssertionsSigned attribute of the md:SPSSODescriptor element.

Parameters:

b - whether assertions should be signed

See Also:

SpEntityDescriptorBuilder.wantAssertionsSigned(Boolean)

setDiscoveryResponse

public void setDiscoveryResponse(String location)

Adds one discovery response location.

Parameters:

location - URL for discovery responses

See Also:

SpEntityDescriptorBuilder.discoveryResponses(String...)

setDiscoveryResponses

public void setDiscoveryResponses(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

See Also:

SpEntityDescriptorBuilder.discoveryResponses(List)

setAssertionConsumerServices

public void setAssertionConsumerServices(List<AssertionConsumerService> assertionConsumerServices)

Adds md:AssertionConsumerService elements to the SPSSODescriptor.

Parameters:

assertionConsumerServices - assertion consumer service objects (cloned before assignment)

See Also:

SpEntityDescriptorBuilder.assertionConsumerServices(List)

setAssertionConsumerService

public void setAssertionConsumerService(AssertionConsumerService assertionConsumerService)

Adds one md:AssertionConsumerService element to the SPSSODescriptor.

Parameters:

assertionConsumerService - assertion consumer service object (cloned before assignment)

See Also:

SpEntityDescriptorBuilder.assertionConsumerServices(AssertionConsumerService...)

setAttributeConsumingServices

public void setAttributeConsumingServices(List<AttributeConsumingService> attributeConsumingServices)

Adds md:AttributeConsumingService elements to the SPSSODescriptor.

Parameters:

attributeConsumingServices - attribute consumer service objects (cloned before assignment)

See Also:

SpEntityDescriptorBuilder.attributeConsumingServices(List)

setAttributeConsumingService

public void setAttributeConsumingService(AttributeConsumingService attributeConsumingService)

Adds one md:AttributeConsumingService element to the SPSSODescriptor.

Parameters:

attributeConsumingService - attribute consumer service object (cloned before assignment)

See Also:

SpEntityDescriptorBuilder.attributeConsumingServices(AttributeConsumingService...)

_builder

protected SpEntityDescriptorBuilder _builder()

Returns the internal builder of the correct type.

Specified by:

_builder in class AbstractEntityDescriptorFactoryBean<SpEntityDescriptorBuilder>

Returns:

the builder to use

builder

protected AbstractSAMLObjectBuilder<EntityDescriptor> builder()

Returns the builder.

Specified by:

builder in class AbstractSAMLObjectBuilderFactoryBean<EntityDescriptor>

Returns:

the builder