org.opensaml.saml.config

Class SAMLConfiguration

java.lang.Object

org.opensaml.saml.config.SAMLConfiguration

public class SAMLConfiguration
extends Object

SAML-related configuration information.

The configuration instance to use would typically be retrieved from the ConfigurationService.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SAMLConfiguration.LowercaseFunction Function to lowercase a string input.

Field Summary

Fields

Modifier and Type	Field and Description
private List<String>	allowedBindingURLSchemes The list of schemes allowed to appear in binding URLs when encoding a message.
private DateTimeFormatter	dateFormatter Formatter used to write dates.
private static String	defaultDateFormat Date format in SAML object, default is yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.
private static Function<String,String>	lowercaseFunction Lowercase string function.
private SAML1ArtifactBuilderFactory	saml1ArtifactBuilderFactory SAML 1 Artifact factory.
private SAML2ArtifactBuilderFactory	saml2ArtifactBuilderFactory SAML 2 Artifact factory.

Constructor Summary

Constructors

Constructor and Description
SAMLConfiguration() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAllowedBindingURLSchemes() Gets the unmodifiable list of schemes allowed to appear in binding URLs when encoding a message.
SAML1ArtifactBuilderFactory	getSAML1ArtifactBuilderFactory() Gets the artifact factory for the library.
SAML2ArtifactBuilderFactory	getSAML2ArtifactBuilderFactory() Gets the artifact factory for the library.
DateTimeFormatter	getSAMLDateFormatter() Gets the date format used to string'ify SAML's DateTime objects.
void	setAllowedBindingURLSchemes(List<String> schemes) Sets the list of schemes allowed to appear in binding URLs when encoding a message.
void	setSAML1ArtifactBuilderFactory(SAML1ArtifactBuilderFactory factory) Sets the artifact factory for the library.
void	setSAML2ArtifactBuilderFactory(SAML2ArtifactBuilderFactory factory) Sets the artifact factory for the library.
void	setSAMLDateFormat(String format) Sets the date format used to string'ify SAML's date/time objects.

Methods inherited from class java.lang.Object

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

Field Detail

lowercaseFunction

private static Function<String,String> lowercaseFunction

Lowercase string function.

defaultDateFormat

private static String defaultDateFormat

Date format in SAML object, default is yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

dateFormatter

private DateTimeFormatter dateFormatter

Formatter used to write dates.

saml1ArtifactBuilderFactory

private SAML1ArtifactBuilderFactory saml1ArtifactBuilderFactory

SAML 1 Artifact factory.

saml2ArtifactBuilderFactory

private SAML2ArtifactBuilderFactory saml2ArtifactBuilderFactory

SAML 2 Artifact factory.

allowedBindingURLSchemes

private List<String> allowedBindingURLSchemes

The list of schemes allowed to appear in binding URLs when encoding a message. Defaults to 'http' and 'https'.

Constructor Detail

SAMLConfiguration

public SAMLConfiguration()

Constructor.

Method Detail

getSAMLDateFormatter

public DateTimeFormatter getSAMLDateFormatter()

Gets the date format used to string'ify SAML's DateTime objects.

Returns:

date format used to string'ify date objects

setSAMLDateFormat

public void setSAMLDateFormat(String format)

Sets the date format used to string'ify SAML's date/time objects. See the SimpleDateFormat documentation for format syntax.

Parameters:

format - date format used to string'ify date objects

getSAML1ArtifactBuilderFactory

public SAML1ArtifactBuilderFactory getSAML1ArtifactBuilderFactory()

Gets the artifact factory for the library.

Returns:

artifact factory for the library

setSAML1ArtifactBuilderFactory

public void setSAML1ArtifactBuilderFactory(SAML1ArtifactBuilderFactory factory)

Sets the artifact factory for the library.

Parameters:

factory - artifact factory for the library

getSAML2ArtifactBuilderFactory

public SAML2ArtifactBuilderFactory getSAML2ArtifactBuilderFactory()

Gets the artifact factory for the library.

Returns:

artifact factory for the library

setSAML2ArtifactBuilderFactory

public void setSAML2ArtifactBuilderFactory(SAML2ArtifactBuilderFactory factory)

Sets the artifact factory for the library.

Parameters:

factory - artifact factory for the library

getAllowedBindingURLSchemes

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

Gets the unmodifiable list of schemes allowed to appear in binding URLs when encoding a message.

All scheme values returned will be lowercased.

Defaults to 'http' and 'https'.

Returns:

list of URL schemes allowed to appear in a message

setAllowedBindingURLSchemes

public void setAllowedBindingURLSchemes(@Nullable
                               List<String> schemes)

Sets the list of schemes allowed to appear in binding URLs when encoding a message.

The supplied list will be copied. Values will be normalized: 1) strings will be trimmed, 2) nulls will be removed, and 3) all values will be lowercased.

Note, the appearance of schemes such as 'javascript' may open the system up to attacks (e.g. cross-site scripting attacks).

Parameters:

schemes - URL schemes allowed to appear in a message