Package se.swedenconnect.opensaml.saml2.metadata.build

Class IDPSSODescriptorBuilder

java.lang.Object

se.swedenconnect.opensaml.common.builder.AbstractSAMLObjectBuilder<IDPSSODescriptor>

se.swedenconnect.opensaml.saml2.metadata.build.AbstractSSODescriptorBuilder<IDPSSODescriptor,IDPSSODescriptorBuilder>

se.swedenconnect.opensaml.saml2.metadata.build.IDPSSODescriptorBuilder

All Implemented Interfaces:

SAMLObjectBuilder<IDPSSODescriptor>

public class IDPSSODescriptorBuilder
extends AbstractSSODescriptorBuilder<IDPSSODescriptor,IDPSSODescriptorBuilder>

Builder for IDPSSODescriptor objects.

Author:

Martin Lindström (martin@idsec.se)

Constructor Summary

Constructors

Constructor	Description
IDPSSODescriptorBuilder()	Default constructor.
IDPSSODescriptorBuilder(IDPSSODescriptor template, boolean clone)	Constructor setting up the builder with a template object.

Method Summary

Modifier and Type	Method	Description
IDPSSODescriptorBuilder	attributes(List<Attribute> attributes)	Adds Attribute elements to the IDPSSODescriptor.
IDPSSODescriptorBuilder	attributes(Attribute... attributes)	See attributes(List).
static IDPSSODescriptorBuilder	builder()	Utility method that creates a IDPSSODescriptorBuilder instance.
protected Class<IDPSSODescriptor>	getObjectType()	Returns the object type.
protected IDPSSODescriptorBuilder	getThis()	In order for us to be able to make chaining calls we need to return the concrete type of the builder.
IDPSSODescriptorBuilder	singleSignOnServices(List<SingleSignOnService> singleSignOnServices)	Adds md:SingleSignOnService elements to the IDPSSODescriptor.
IDPSSODescriptorBuilder	singleSignOnServices(SingleSignOnService... singleSignOnServices)	See singleSignOnServices(List).
IDPSSODescriptorBuilder	wantAuthnRequestsSigned(Boolean b)	Assigns the WantAuthnRequestsSigned attribute of the md:IDPSSODescriptor element.

Methods inherited from class se.swedenconnect.opensaml.saml2.metadata.build.AbstractSSODescriptorBuilder

extensions, getExtensionsBuilder, keyDescriptors, keyDescriptors, nameIDFormats, nameIDFormats, singleLogoutServices, singleLogoutServices

Methods inherited from class se.swedenconnect.opensaml.common.builder.AbstractSAMLObjectBuilder

build, getDefaultElementName, object

Methods inherited from class java.lang.Object

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

Constructor Details

IDPSSODescriptorBuilder

public IDPSSODescriptorBuilder()

Default constructor.

IDPSSODescriptorBuilder

public IDPSSODescriptorBuilder(IDPSSODescriptor template,
 boolean clone)

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

The clone parameter tells whether the object should be cloned or not. If set to true, any modifications will have no effect on the passed object.

Parameters:

template - the template object

clone - whether the template object should be cloned

Method Details

builder

public static IDPSSODescriptorBuilder builder()

Utility method that creates a IDPSSODescriptorBuilder instance.

Returns:

a IDPSSODescriptorBuilder instance

wantAuthnRequestsSigned

public IDPSSODescriptorBuilder wantAuthnRequestsSigned(Boolean b)

Assigns the WantAuthnRequestsSigned attribute of the md:IDPSSODescriptor element.

Parameters:

b - boolean

Returns:

the builder

singleSignOnServices

public IDPSSODescriptorBuilder 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 IDPSSODescriptorBuilder singleSignOnServices(SingleSignOnService... singleSignOnServices)

See singleSignOnServices(List).

Parameters:

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

Returns:

the builder

attributes

public IDPSSODescriptorBuilder attributes(List<Attribute> attributes)

Adds Attribute elements to the IDPSSODescriptor.

Parameters:

attributes - the attributes to add

Returns:

the builder

attributes

public IDPSSODescriptorBuilder attributes(Attribute... attributes)

See attributes(List).

Parameters:

attributes - the attributes to add

Returns:

the builder

getThis

protected IDPSSODescriptorBuilder 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 AbstractSSODescriptorBuilder<IDPSSODescriptor,IDPSSODescriptorBuilder>

Returns:

the concrete type of the builder

getObjectType

protected Class<IDPSSODescriptor> getObjectType()

Returns the object type.

Specified by:

getObjectType in class AbstractSAMLObjectBuilder<IDPSSODescriptor>

Returns:

the object type