com.sdl.delivery.configuration.xml

Class XMLConfigurationResource

java.lang.Object

com.sdl.delivery.configuration.xml.XMLConfigurationResource

All Implemented Interfaces:

com.sdl.delivery.configuration.ConfigurationResource, Serializable

public class XMLConfigurationResource
extends Object
implements com.sdl.delivery.configuration.ConfigurationResource

Implementation of ConfigurationResource which hold an structured configuration of a configuration area retrieved from XML legacy configuration files.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
XMLConfigurationResource(com.sdl.delivery.configuration.Configuration configuration) Create an instance of XMLConfigurationResource with the given last update time and main configuration.

Method Summary

Modifier and Type	Method and Description
com.sdl.delivery.configuration.Configuration	getConfiguration() Get the main or root 'Configuration' contained by the 'Configuration Resource'.
com.sdl.delivery.configuration.Configuration	getConfiguration(com.sdl.delivery.configuration.ConfigurationPath path) Get the Configuration that can be retrieved by applying the given 'Configuration Path' to the main 'Configuration'.
List<com.sdl.delivery.configuration.Configuration>	getConfigurations(com.sdl.delivery.configuration.ConfigurationPath path) Get the list of 'Configurations' that can be retrieved by applying the given 'Configuration Path' to the main 'Configuration'.
Date	getLastUpdate() Get the last moment the 'Configuration Resource' was updated.
String	getName() Get the name of the 'Configuration Resource'.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLConfigurationResource

public XMLConfigurationResource(com.sdl.delivery.configuration.Configuration configuration)

Create an instance of XMLConfigurationResource with the given last update time and main configuration.

Parameters:

configuration - The main configuration to be hold by the resource. It can not be null.

Method Detail

getName

public String getName()

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

Get the name of the 'Configuration Resource'.

Specified by:

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

Returns:

The name of the 'Configuration Resource'.

getLastUpdate

public Date getLastUpdate()

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

Get the last moment the 'Configuration Resource' was updated.

Specified by:

getLastUpdate in interface com.sdl.delivery.configuration.ConfigurationResource

Returns:

The last moment the 'Configuration Resource' was updated.

getConfiguration

public com.sdl.delivery.configuration.Configuration getConfiguration()

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

Get the main or root 'Configuration' contained by the 'Configuration Resource'.

Specified by:

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

Returns:

The main or root 'Configuration'.

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.ConfigurationResource

Get the Configuration that can be retrieved by applying the given 'Configuration Path' to the main 'Configuration'.

Specified by:

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

Parameters:

path - The given 'Configuration Path'.

Returns:

The retrieved 'Configuration'.

Throws:

com.sdl.delivery.configuration.ConfigurationException

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.ConfigurationResource

Get the list of 'Configurations' that can be retrieved by applying the given 'Configuration Path' to the main 'Configuration'.

Specified by:

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

Parameters:

path - The given 'Configuration Path'.

Returns:

The list of 'Configurations' retrieved.

Throws:

com.sdl.delivery.configuration.ConfigurationException