org.opensaml
Class DefaultBootstrap

java.lang.Object
  org.opensaml.DefaultBootstrap

public class DefaultBootstrap
extends Object

This class can be used to bootstrap the OpenSAML library with the default configurations that ship with the library.

Field Summary

private static String[]

xmlToolingConfigs List of default XMLTooling configuration files.

Constructor Summary

protected

DefaultBootstrap() Constructor.

Method Summary

static void	bootstrap() Initializes the OpenSAML library, loading default configurations.
protected static org.slf4j.Logger	getLogger() Get an SLF4J Logger.
protected static void	initializeArtifactBuilderFactories() Initializes the artifact factories for SAML 1 and SAML 2 artifacts.
protected static void	initializeESAPI() Initializes the OWASPI ESAPI library.
protected static void	initializeGlobalSecurityConfiguration() Initializes the default global security configuration.
protected static void	initializeParserPool() Initializes the default global parser pool instance.
protected static void	initializeXMLSecurity() Initializes the Apache XMLSecurity libary.
protected static void	initializeXMLTooling() Initializes the XMLTooling library with a default set of object providers.
protected static void	initializeXMLTooling(String[] providerConfigs) Initializes the XMLTooling library with an explicitly supplied set of object providers.

Methods inherited from class java.lang.Object

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

Field Detail

xmlToolingConfigs

private static String[] xmlToolingConfigs

List of default XMLTooling configuration files.

Constructor Detail

DefaultBootstrap

protected DefaultBootstrap()

Constructor.

Method Detail

bootstrap

public static void bootstrap()
                      throws ConfigurationException

Initializes the OpenSAML library, loading default configurations.

Throws:

ConfigurationException - thrown if there is a problem initializing the OpenSAML library

initializeESAPI

protected static void initializeESAPI()

Initializes the OWASPI ESAPI library.

initializeParserPool

protected static void initializeParserPool()
                                    throws ConfigurationException

Initializes the default global parser pool instance.

The ParserPool configured by default here is an instance of StaticBasicParserPool, with a maxPoolSize property of 50 and all other properties with default values.

If a deployment wishes to use a different parser pool implementation, or one configured with different characteristics, they may either override this method, or simply configure a different ParserPool after bootstrapping via Configuration.setParserPool(org.opensaml.xml.parse.ParserPool).

Throws:

ConfigurationException - thrown if there is a problem initializing the parser pool

initializeGlobalSecurityConfiguration

protected static void initializeGlobalSecurityConfiguration()

Initializes the default global security configuration.

initializeXMLSecurity

protected static void initializeXMLSecurity()
                                     throws ConfigurationException

Initializes the Apache XMLSecurity libary.

Throws:

ConfigurationException - thrown is there is a problem initializing the library

initializeXMLTooling

protected static void initializeXMLTooling()
                                    throws ConfigurationException

Initializes the XMLTooling library with a default set of object providers.

Throws:

ConfigurationException - thrown if there is a problem loading the configuration files

initializeXMLTooling

protected static void initializeXMLTooling(String[] providerConfigs)
                                    throws ConfigurationException

Initializes the XMLTooling library with an explicitly supplied set of object providers.

Parameters:

providerConfigs - list of provider configuration files located on the classpath

Throws:

ConfigurationException - thrown if there is a problem loading the configuration files

initializeArtifactBuilderFactories

protected static void initializeArtifactBuilderFactories()
                                                  throws ConfigurationException

Initializes the artifact factories for SAML 1 and SAML 2 artifacts.

Throws:

ConfigurationException - thrown if there is a problem initializing the artifact factory

getLogger

protected static org.slf4j.Logger getLogger()

Get an SLF4J Logger.

Returns:

a Logger instance