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

Class IdpEntityDescriptorFactoryBean

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

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

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 IdpEntityDescriptorFactoryBean
extends AbstractEntityDescriptorFactoryBean<IdpEntityDescriptorBuilder>

A Spring factory bean for creating EntityDescriptor objects for Identity 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:

IdpEntityDescriptorBuilder

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
IdpEntityDescriptorFactoryBean() Constructor setting up the factory with no template.
IdpEntityDescriptorFactoryBean(EntityDescriptor template) Constructor setting up the factory with a template EntityDescriptor.
IdpEntityDescriptorFactoryBean(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 IdpEntityDescriptorBuilder	_builder() Returns the internal builder of the correct type.
protected AbstractSAMLObjectBuilder<EntityDescriptor>	builder() Returns the builder.
void	setAssuranceCertificationUris(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.
void	setSingleSignOnServices(List<SingleSignOnService> singleSignOnServices) Adds md:SingleSignOnService elements to the IDPSSODescriptor.
void	setWantAuthnRequestsSigned(Boolean b) Assigns the WantAuthnRequestsSigned attribute of the md:IDPSSODescriptor 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

IdpEntityDescriptorFactoryBean

public IdpEntityDescriptorFactoryBean()

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:

IdpEntityDescriptorBuilder.IdpEntityDescriptorBuilder()

IdpEntityDescriptorFactoryBean

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

IdpEntityDescriptorFactoryBean

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

setWantAuthnRequestsSigned

public void setWantAuthnRequestsSigned(Boolean b)

Assigns the WantAuthnRequestsSigned attribute of the md:IDPSSODescriptor element.

Parameters:

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

setAssuranceCertificationUris

public void setAssuranceCertificationUris(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.

Parameters:

uris - the assurance URI values that should be added

See Also:

AbstractEntityDescriptorFactoryBean.setEntityAttributesExtension(List)

setSingleSignOnServices

public void setSingleSignOnServices(List<SingleSignOnService> singleSignOnServices)

Adds md:SingleSignOnService elements to the IDPSSODescriptor.

Parameters:

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

_builder

protected IdpEntityDescriptorBuilder _builder()

Returns the internal builder of the correct type.

Specified by:

_builder in class AbstractEntityDescriptorFactoryBean<IdpEntityDescriptorBuilder>

Returns:

the builder to use

builder

protected AbstractSAMLObjectBuilder<EntityDescriptor> builder()

Returns the builder.

Specified by:

builder in class AbstractSAMLObjectBuilderFactoryBean<EntityDescriptor>

Returns:

the builder