org.opensaml.core.xml.config

Class XMLConfigurator

java.lang.Object

org.opensaml.core.xml.config.XMLConfigurator

public class XMLConfigurator
extends java.lang.Object

Reads in an XML configuration and configures the XMLTooling library accordingly.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.xml.validation.Schema	configurationSchema Schema used to validate configruation files.
private org.slf4j.Logger	log Class logger.
private net.shibboleth.utilities.java.support.xml.BasicParserPool	parserPool Pool of parsers used to read and validate configurations.
private XMLObjectProviderRegistry	registry The provider registry instance to use.
static java.lang.String	XMLTOOLING_CONFIG_NS Configuration namespace.
static java.lang.String	XMLTOOLING_CONFIG_PREFIX Configuration namespace prefix.
static java.lang.String	XMLTOOLING_DEFAULT_OBJECT_PROVIDER Name of the object provider used for objects that don't have a registered object provider.
static java.lang.String	XMLTOOLING_SCHEMA_LOCATION Location, on the classpath, of the XMLTooling configuration schema.

Constructor Summary

Constructors

Constructor and Description
XMLConfigurator() Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	createClassInstance(org.w3c.dom.Element configuration) Constructs an instance of the given class.
protected XMLObjectProviderRegistry	getRegistry() Get the XMLObject provider registry instance to use.
protected void	initializeIDAttributes(org.w3c.dom.Element idAttributesElement) Registers the global ID attributes specified in the configuration file.
protected void	initializeObjectProviders(org.w3c.dom.Element objectProviders) Intializes the object providers defined in the configuration file.
void	load(org.w3c.dom.Document configuration) Loads the configuration document.
protected void	load(org.w3c.dom.Element configurationRoot) Loads a configuration after it's been schema validated.
void	load(java.io.File configurationFile) Loads the configuration file(s) from the given file.
void	load(java.io.InputStream configurationStream) Loads a configuration file from an input stream.
protected void	validateConfiguration(org.w3c.dom.Document configuration) Schema validates the given configuration.

Methods inherited from class java.lang.Object

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

Field Detail

XMLTOOLING_CONFIG_NS

@Nonnull
 @NotEmpty
public static final java.lang.String XMLTOOLING_CONFIG_NS

Configuration namespace.

See Also:

Constant Field Values

XMLTOOLING_CONFIG_PREFIX

@Nonnull
 @NotEmpty
public static final java.lang.String XMLTOOLING_CONFIG_PREFIX

Configuration namespace prefix.

See Also:

Constant Field Values

XMLTOOLING_DEFAULT_OBJECT_PROVIDER

@Nonnull
 @NotEmpty
public static final java.lang.String XMLTOOLING_DEFAULT_OBJECT_PROVIDER

Name of the object provider used for objects that don't have a registered object provider.

See Also:

Constant Field Values

XMLTOOLING_SCHEMA_LOCATION

@Nonnull
 @NotEmpty
public static final java.lang.String XMLTOOLING_SCHEMA_LOCATION

Location, on the classpath, of the XMLTooling configuration schema.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

parserPool

private net.shibboleth.utilities.java.support.xml.BasicParserPool parserPool

Pool of parsers used to read and validate configurations.

configurationSchema

private javax.xml.validation.Schema configurationSchema

Schema used to validate configruation files.

registry

@Nonnull
private final XMLObjectProviderRegistry registry

The provider registry instance to use.

Constructor Detail

XMLConfigurator

public XMLConfigurator()
                throws XMLConfigurationException

Constructor.

Throws:

XMLConfigurationException - thrown if the validation schema for configuration files cannot be created

Method Detail

load

public void load(@Nullable
                 java.io.File configurationFile)
          throws XMLConfigurationException

Loads the configuration file(s) from the given file. If the file is a directory each file within the directory is loaded.

Parameters:

configurationFile - the configuration file(s) to be loaded

Throws:

XMLConfigurationException - thrown if the configuration file(s) cannot be read or invalid

load

public void load(@Nonnull
                 java.io.InputStream configurationStream)
          throws XMLConfigurationException

Loads a configuration file from an input stream.

Parameters:

configurationStream - configuration stream

Throws:

XMLConfigurationException - thrown if the given configuration is invalid or cannot be read

load

public void load(@Nonnull
                 org.w3c.dom.Document configuration)
          throws XMLConfigurationException

Loads the configuration document.

Parameters:

configuration - the configurationd document

Throws:

XMLConfigurationException - thrown if the configuration file(s) cannot be read or invalid

load

protected void load(@Nonnull
                    org.w3c.dom.Element configurationRoot)
             throws XMLConfigurationException

Loads a configuration after it's been schema validated.

Parameters:

configurationRoot - root of the configuration

Throws:

XMLConfigurationException - thrown if there is a problem processing the configuration

initializeObjectProviders

protected void initializeObjectProviders(org.w3c.dom.Element objectProviders)
                                  throws XMLConfigurationException

Intializes the object providers defined in the configuration file.

Parameters:

objectProviders - the configuration for the various object providers

Throws:

XMLConfigurationException - thrown if the configuration elements are invalid

initializeIDAttributes

protected void initializeIDAttributes(org.w3c.dom.Element idAttributesElement)
                               throws XMLConfigurationException

Registers the global ID attributes specified in the configuration file.

Parameters:

idAttributesElement - the IDAttributes element from the configuration file

Throws:

XMLConfigurationException - thrown if there is a problem with a parsing or registering the the ID attribute

createClassInstance

protected java.lang.Object createClassInstance(org.w3c.dom.Element configuration)
                                        throws XMLConfigurationException

Constructs an instance of the given class.

Parameters:

configuration - the current configuration element

Returns:

an instance of the given class

Throws:

XMLConfigurationException - thrown if the class can not be instaniated

validateConfiguration

protected void validateConfiguration(org.w3c.dom.Document configuration)
                              throws XMLConfigurationException

Schema validates the given configuration.

Parameters:

configuration - the configuration to validate

Throws:

XMLConfigurationException - thrown if the configuration is not schema-valid

getRegistry

protected XMLObjectProviderRegistry getRegistry()

Get the XMLObject provider registry instance to use.

Returns:

the registry instance