net.shibboleth.idp.saml.saml1.profile.config

Class BrowserSSOProfileConfiguration

java.lang.Object

net.shibboleth.idp.profile.config.AbstractProfileConfiguration

net.shibboleth.idp.saml.profile.config.AbstractSAMLProfileConfiguration

net.shibboleth.idp.saml.saml1.profile.config.BrowserSSOProfileConfiguration

All Implemented Interfaces:

AuthenticationProfileConfiguration, ProfileConfiguration, SAMLArtifactAwareProfileConfiguration, SAMLProfileConfiguration, SAML1ProfileConfiguration, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.IdentifiedComponent

public class BrowserSSOProfileConfiguration
extends AbstractSAMLProfileConfiguration
implements SAML1ProfileConfiguration, SAMLArtifactAwareProfileConfiguration, AuthenticationProfileConfiguration

Configuration for SAML 1 Browser SSO profile requests.

Field Summary

Fields

Modifier and Type	Field and Description
private SAMLArtifactConfiguration	artifactConfig SAML artifact configuration.
private Set<String>	authenticationFlows Filters the usable authentication flows.
private List<AuthenticationMethodPrincipal>	defaultAuthenticationMethods Selects, and limits, the authentication methods to use for requests.
private boolean	includeAttributeStatement Whether responses to the authentication request should include an attribute statement.
private List<String>	nameIDFormatPrecedence Precedence of name identifier formats to use for requests.
private List<String>	postAuthenticationFlows Enables post-authentication interceptor flows.
static String	PROFILE_ID ID for this profile configuration.
private boolean	resolveAttributes Whether attributes should be resolved in the course of the profile.

Constructor Summary

Constructors

Modifier	Constructor and Description
	BrowserSSOProfileConfiguration() Constructor.
protected	BrowserSSOProfileConfiguration(String profileId) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
SAMLArtifactConfiguration	getArtifactConfiguration() Get the associated SAMLArtifactConfiguration for the profile, if any.
Set<String>	getAuthenticationFlows()
List<Principal>	getDefaultAuthenticationMethods()
List<String>	getNameIDFormatPrecedence()
List<String>	getPostAuthenticationFlows()
boolean	includeAttributeStatement() Get whether responses to the authentication request should include an attribute statement.
boolean	resolveAttributes() Get whether attributes should be resolved during the profile.
void	setArtifactConfiguration(SAMLArtifactConfiguration config) Set the SAML artifact configuration, if any.
void	setAuthenticationFlows(Collection<String> flows) Set the authentication flows to use.
void	setDefaultAuthenticationMethods(List<AuthenticationMethodPrincipal> methods) Set the default authentication methods to use, expressed as custom principals.
void	setIncludeAttributeStatement(boolean include) Set whether responses to the authentication request should include an attribute statement.
void	setNameIDFormatPrecedence(List<String> formats) Set the name identifier formats to use.
void	setPostAuthenticationFlows(Collection<String> flows) Set the ordered collection of post-authentication interceptor flows to enable.
void	setResolveAttributes(boolean flag) Set whether attributes should be resolved during the profile.

Methods inherited from class net.shibboleth.idp.saml.profile.config.AbstractSAMLProfileConfiguration

getAdditionalAudiencesForAssertion, getAssertionLifetime, getSignAssertions, getSignRequests, getSignResponses, includeConditionsNotBefore, setAdditionalAudienceForAssertion, setAssertionLifetime, setIncludeConditionsNotBefore, setSignAssertions, setSignRequests, setSignResponses

Methods inherited from class net.shibboleth.idp.profile.config.AbstractProfileConfiguration

equals, getId, getInboundInterceptorFlows, getOutboundInterceptorFlows, getSecurityConfiguration, hashCode, setInboundInterceptorFlows, setOutboundInterceptorFlows, setSecurityConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.idp.saml.profile.config.SAMLProfileConfiguration

getAdditionalAudiencesForAssertion, getAssertionLifetime, getSignAssertions, getSignRequests, getSignResponses, includeConditionsNotBefore

Methods inherited from interface net.shibboleth.idp.profile.config.ProfileConfiguration

getInboundInterceptorFlows, getOutboundInterceptorFlows, getSecurityConfiguration

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

PROFILE_ID

public static final String PROFILE_ID

ID for this profile configuration.

See Also:

Constant Field Values

artifactConfig

@Nullable
private SAMLArtifactConfiguration artifactConfig

SAML artifact configuration.

resolveAttributes

private boolean resolveAttributes

Whether attributes should be resolved in the course of the profile.

Default value: true

includeAttributeStatement

private boolean includeAttributeStatement

Whether responses to the authentication request should include an attribute statement.

Default value: false

defaultAuthenticationMethods

@Nonnull
@NonnullElements
private List<AuthenticationMethodPrincipal> defaultAuthenticationMethods

Selects, and limits, the authentication methods to use for requests.

authenticationFlows

@Nonnull
@NonnullElements
private Set<String> authenticationFlows

Filters the usable authentication flows.

postAuthenticationFlows

@Nonnull
@NonnullElements
private List<String> postAuthenticationFlows

Enables post-authentication interceptor flows.

nameIDFormatPrecedence

@Nonnull
@NonnullElements
private List<String> nameIDFormatPrecedence

Precedence of name identifier formats to use for requests.

Constructor Detail

BrowserSSOProfileConfiguration

public BrowserSSOProfileConfiguration()

Constructor.

BrowserSSOProfileConfiguration

protected BrowserSSOProfileConfiguration(@Nonnull@NotEmpty
                              String profileId)

Constructor.

Parameters:

profileId - unique ID for this profile

Method Detail

getArtifactConfiguration

@Nullable
public SAMLArtifactConfiguration getArtifactConfiguration()

Get the associated SAMLArtifactConfiguration for the profile, if any.

Specified by:

getArtifactConfiguration in interface SAMLArtifactAwareProfileConfiguration

Returns:

an associated artifact configuration, or null

setArtifactConfiguration

public void setArtifactConfiguration(@Nullable
                            SAMLArtifactConfiguration config)

Set the SAML artifact configuration, if any.

Parameters:

config - configuration to set

resolveAttributes

public boolean resolveAttributes()

Get whether attributes should be resolved during the profile.

Returns:

true iff attributes should be resolved

setResolveAttributes

public void setResolveAttributes(boolean flag)

Set whether attributes should be resolved during the profile.

Parameters:

flag - flag to set

includeAttributeStatement

public boolean includeAttributeStatement()

Get whether responses to the authentication request should include an attribute statement.

Returns:

whether responses to the authentication request should include an attribute statement

setIncludeAttributeStatement

public void setIncludeAttributeStatement(boolean include)

Set whether responses to the authentication request should include an attribute statement.

Parameters:

include - flag to set

getDefaultAuthenticationMethods

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<Principal> getDefaultAuthenticationMethods()

Specified by:

getDefaultAuthenticationMethods in interface AuthenticationProfileConfiguration

setDefaultAuthenticationMethods

public void setDefaultAuthenticationMethods(@Nonnull@NonnullElements
                                   List<AuthenticationMethodPrincipal> methods)

Set the default authentication methods to use, expressed as custom principals.

Parameters:

methods - default authentication methods to use

getAuthenticationFlows

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public Set<String> getAuthenticationFlows()

Specified by:

getAuthenticationFlows in interface AuthenticationProfileConfiguration

setAuthenticationFlows

public void setAuthenticationFlows(@Nonnull@NonnullElements
                          Collection<String> flows)

Set the authentication flows to use.

Parameters:

flows - flow identifiers to use

getPostAuthenticationFlows

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<String> getPostAuthenticationFlows()

Specified by:

getPostAuthenticationFlows in interface AuthenticationProfileConfiguration

setPostAuthenticationFlows

public void setPostAuthenticationFlows(@Nonnull@NonnullElements
                              Collection<String> flows)

Set the ordered collection of post-authentication interceptor flows to enable.

Parameters:

flows - flow identifiers to enable

getNameIDFormatPrecedence

@Nonnull
@NonnullElements
@NotLive
@Unmodifiable
public List<String> getNameIDFormatPrecedence()

Specified by:

getNameIDFormatPrecedence in interface AuthenticationProfileConfiguration

setNameIDFormatPrecedence

public void setNameIDFormatPrecedence(@Nonnull@NonnullElements
                             List<String> formats)

Set the name identifier formats to use.

Parameters:

formats - name identifier formats to use