com.sdl.delivery.configuration.xml

Class XMLConfiguration

java.lang.Object

com.sdl.delivery.configuration.xml.XMLConfiguration

All Implemented Interfaces:

com.sdl.delivery.configuration.Configuration, Serializable

public class XMLConfiguration
extends Object
implements com.sdl.delivery.configuration.Configuration

Specific implementation of Configuration which can hold configuration items and values built from the legacy XML-based configuration; such as, cd_dynamic_conf.xml, cd_storage_conf.xml, etc...

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XMLConfiguration(Node xmlConfiguration) Creates an instance of XMLConfiguration by extracting the configuration from the given XML node.

Method Summary

Modifier and Type	Method and Description
com.sdl.delivery.configuration.Configuration	getConfiguration(com.sdl.delivery.configuration.ConfigurationPath path) Get the configuration for the given path.
com.sdl.delivery.configuration.Configuration	getConfiguration(String childName) Gets the child configuration with the given name, if multiple children with same name are present it will return the first occurrence.
List<com.sdl.delivery.configuration.Configuration>	getConfigurations() Gets the list of all configurations that are direct descendants of this configuration item.
List<com.sdl.delivery.configuration.Configuration>	getConfigurations(com.sdl.delivery.configuration.ConfigurationPath path) Get the list of configurations for the given path.
String	getName() Get the name of the 'Configuration'.
String	getTextContent() Provide support to get the text content from an xml element.
com.sdl.delivery.configuration.Value	getValue(String name) Get the generic value from a 'Configuration Value' accessed by the given name.
Map<String,com.sdl.delivery.configuration.Value>	getValues() Get all the generic values from the list of 'Configuration Values' hold by the 'Configuration Item'.
boolean	hasValue(String name) Checks whether there is a value of this name present.
com.sdl.delivery.configuration.Configuration	merge(com.sdl.delivery.configuration.Configuration config, String schemaFile) Merge given Configuration with the current Configuration.
String	toString() Overrides the standard String representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sdl.delivery.configuration.Configuration

deepCopy

Constructor Detail

XMLConfiguration

public XMLConfiguration(Node xmlConfiguration)

Creates an instance of XMLConfiguration by extracting the configuration from the given XML node.

Parameters:

xmlConfiguration - The given XML node. It can not be null.

Method Detail

getName

public String getName()

Description copied from interface: com.sdl.delivery.configuration.Configuration

Get the name of the 'Configuration'. Please note the meaning of this name is broader than just a simple name, as it could refer to the type of a configuration. For instance: "URLMappings" could be valid name as well as "com.tridion.odata.datalayer.model.WebApplication".

Specified by:

getName in interface com.sdl.delivery.configuration.Configuration

Returns:

The name of the 'Configuration'

getTextContent

public String getTextContent()
                      throws com.sdl.delivery.configuration.ConfigurationException

Provide support to get the text content from an xml element. Specific only to XMLConfiguration.

Returns:

inner text content of an xml element.

Throws:

com.sdl.delivery.configuration.ConfigurationException

getConfiguration

public com.sdl.delivery.configuration.Configuration getConfiguration(com.sdl.delivery.configuration.ConfigurationPath path)
                                                              throws com.sdl.delivery.configuration.ConfigurationException

Description copied from interface: com.sdl.delivery.configuration.Configuration

Get the configuration for the given path. Take into account that sometimes a given path could lead to a list of configurations of the same type grouped inside a parent configuration. By using this method, in case of the path lead to a list of configurations of the same type, it would return either the configuration referred by the last configuration step inside the path, or the first configuration of the list if the configuration step does not specify which configuration to select. In the case the path lead to a single configuration, such configuration would be retrieved.

Examples:

Get Configurations for path : URLMappings | StaticMappings | Publications | Publication

 URLMappings
   StaticMappings
     Publications
       Publication id = 1
       Publication id = 2

 Result: Publication(id = 1) or any of the 2 publications in the case a particular Publication is specified in
 the last step of the path.
 

Get Configurations for path : URLMappings | StaticMappings | Publications

 URLMappings
   StaticMappings
     Publications

 Result: Publications
 

Specified by:

getConfiguration in interface com.sdl.delivery.configuration.Configuration

Parameters:

path - The given path.

Returns:

The 'configuration' for the given path or null if not found.

Throws:

com.sdl.delivery.configuration.ConfigurationException

getConfiguration

public com.sdl.delivery.configuration.Configuration getConfiguration(String childName)
                                                              throws com.sdl.delivery.configuration.ConfigurationException

Description copied from interface: com.sdl.delivery.configuration.Configuration

Gets the child configuration with the given name, if multiple children with same name are present it will return the first occurrence.

Specified by:

getConfiguration in interface com.sdl.delivery.configuration.Configuration

Parameters:

childName - The name of the child

Returns:

The first occurrence of the configuration found, null if none found

Throws:

com.sdl.delivery.configuration.ConfigurationException - If unable to get the child configuration

getConfigurations

public List<com.sdl.delivery.configuration.Configuration> getConfigurations(com.sdl.delivery.configuration.ConfigurationPath path)
                                                                     throws com.sdl.delivery.configuration.ConfigurationException

Description copied from interface: com.sdl.delivery.configuration.Configuration

Get the list of configurations for the given path. Take into account that sometimes a given path could lead to a list of configurations of the same type grouped inside a parent configuration. By using this method it is possible to retrieve such list of configurations of the same type. In the other hand, applying this method over a single configuration would return a list with just one single configuration.

Examples:

Get Configuration for path : URLMappings | StaticMappings | Publications | Publication

 URLMappings
   StaticMappings
     Publications
       Publication id = 1
       Publication id = 2

 Result: {Publication(id = 1), Publication(id = 2)}
 

Get Configurations for path : URLMappings | StaticMappings | Publications

 URLMappings
   StaticMappings
     Publications

 Result: {Publications}
 

Specified by:

getConfigurations in interface com.sdl.delivery.configuration.Configuration

Parameters:

path - The given path.

Returns:

The list of configurations for the given path or null if not found.

Throws:

com.sdl.delivery.configuration.ConfigurationException

getConfigurations

public List<com.sdl.delivery.configuration.Configuration> getConfigurations()

Description copied from interface: com.sdl.delivery.configuration.Configuration

Gets the list of all configurations that are direct descendants of this configuration item.

Specified by:

getConfigurations in interface com.sdl.delivery.configuration.Configuration

Returns:

The list of configurations that are direct descendants or null if not found

hasValue

public boolean hasValue(String name)

Description copied from interface: com.sdl.delivery.configuration.Configuration

Checks whether there is a value of this name present.

Specified by:

hasValue in interface com.sdl.delivery.configuration.Configuration

Parameters:

name - The name of the value to check

Returns:

True if present, False if not

getValue

public com.sdl.delivery.configuration.Value getValue(String name)
                                              throws com.sdl.delivery.configuration.ConfigurationException

Description copied from interface: com.sdl.delivery.configuration.Configuration

Get the generic value from a 'Configuration Value' accessed by the given name.

Specified by:

getValue in interface com.sdl.delivery.configuration.Configuration

Parameters:

name - The given name to access the 'Configuration Value'.

Returns:

The generic value hold by the accessed 'Configuration Value' or null if not present

Throws:

com.sdl.delivery.configuration.ConfigurationException

getValues

public Map<String,com.sdl.delivery.configuration.Value> getValues()
                                                           throws com.sdl.delivery.configuration.ConfigurationException

Description copied from interface: com.sdl.delivery.configuration.Configuration

Get all the generic values from the list of 'Configuration Values' hold by the 'Configuration Item'.

Specified by:

getValues in interface com.sdl.delivery.configuration.Configuration

Returns:

All the generic values from the list of 'Configuration Values' hold by the 'Configuration Item'.

Throws:

com.sdl.delivery.configuration.ConfigurationException

merge

public com.sdl.delivery.configuration.Configuration merge(com.sdl.delivery.configuration.Configuration config,
                                                          String schemaFile)
                                                   throws com.sdl.delivery.configuration.ConfigurationException

Description copied from interface: com.sdl.delivery.configuration.Configuration

Merge given Configuration with the current Configuration. Values given but existing will be overridden. Currently only support for XML Configuration like XMLConfiguration. As Configurations should be immutable, the new instance will be returned instead of updating the current one.

Specified by:

merge in interface com.sdl.delivery.configuration.Configuration

Parameters:

config - to merge with the current one.

schemaFile - the possible schema this config

Returns:

a new (immutable) Configuration Object

Throws:

com.sdl.delivery.configuration.ConfigurationException - if unable to merge.

toString

public String toString()

Overrides the standard String representation of this object.

Overrides:

toString in class Object

Returns:

A string representation of the object