com.sdl.delivery.configuration.xml

Class XMLResourceDescriptor

java.lang.Object

com.sdl.delivery.configuration.xml.XMLResourceDescriptor

All Implemented Interfaces:

com.sdl.delivery.configuration.ResourceDescriptor

public class XMLResourceDescriptor
extends Object
implements com.sdl.delivery.configuration.ResourceDescriptor

Implementation of 'Resource Descriptor' based on the legacy XML configuration files.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCHEMA_FILE_NAME_PROPERTY_KEY Property key to access the XML schema configuration file name.
static String	STYLESHEET_FILE_NAME_PROPERTY_KEY Property key to access the XSLT stylesheet of a configuration file.
static String	XML_CONFIGURATION_TYPE It indicates that the 'Resource Descriptor' is of type 'XML Configuration'.
static String	XML_FILE_NAME_PROPERTY_KEY Property key to access the XML configuration file name.

Fields inherited from interface com.sdl.delivery.configuration.ResourceDescriptor

RESOURCE_NAME_PROPERTY_KEY

Constructor Summary

Constructors

Constructor and Description
XMLResourceDescriptor(String xmlFileName) Creates an instance of XMLResourceDescriptor with the given XML file name.
XMLResourceDescriptor(String xmlFileName, String schemaFileName) Creates an instance of XMLResourceDescriptor with the given XML and schema file name(s).
XMLResourceDescriptor(String xmlFileName, String schemaFileName, String stylesheetFileName) Creates an instance of XMLResourceDescriptor with the given XML, schema and stylesheet transformation file name(s).

Method Summary

Modifier and Type	Method and Description
String	getProperty(String propertyName) Get the value of a 'resource property'.
String	getType() Get the 'resource type', for example "propertyFile", "database", "webService", etc.

Methods inherited from class java.lang.Object

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

Field Detail

XML_CONFIGURATION_TYPE

public static final String XML_CONFIGURATION_TYPE

It indicates that the 'Resource Descriptor' is of type 'XML Configuration'.

See Also:

Constant Field Values

XML_FILE_NAME_PROPERTY_KEY

public static final String XML_FILE_NAME_PROPERTY_KEY

Property key to access the XML configuration file name.

See Also:

Constant Field Values

SCHEMA_FILE_NAME_PROPERTY_KEY

public static final String SCHEMA_FILE_NAME_PROPERTY_KEY

Property key to access the XML schema configuration file name.

See Also:

Constant Field Values

STYLESHEET_FILE_NAME_PROPERTY_KEY

public static final String STYLESHEET_FILE_NAME_PROPERTY_KEY

Property key to access the XSLT stylesheet of a configuration file.

See Also:

Constant Field Values

Constructor Detail

XMLResourceDescriptor

public XMLResourceDescriptor(String xmlFileName)

Creates an instance of XMLResourceDescriptor with the given XML file name.

Parameters:

xmlFileName - The given XML file name. It can not be null neither empty.

XMLResourceDescriptor

public XMLResourceDescriptor(String xmlFileName,
                             String schemaFileName)

Creates an instance of XMLResourceDescriptor with the given XML and schema file name(s).

Parameters:

xmlFileName - The given XML file name. It can not be null neither empty.

schemaFileName - The given schema file name.

XMLResourceDescriptor

public XMLResourceDescriptor(String xmlFileName,
                             String schemaFileName,
                             String stylesheetFileName)

Creates an instance of XMLResourceDescriptor with the given XML, schema and stylesheet transformation file name(s).

Parameters:

xmlFileName - The given XML file name. It can not be null neither empty.

schemaFileName - The given schema file name.

stylesheetFileName - The given stylesheet transformation file name.

Method Detail

getType

public String getType()

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

Get the 'resource type', for example "propertyFile", "database", "webService", etc.

Specified by:

getType in interface com.sdl.delivery.configuration.ResourceDescriptor

Returns:

The 'resource type'.

getProperty

public String getProperty(String propertyName)

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

Get the value of a 'resource property'. These could be anything, e.g. database name, property file location etc.

Specified by:

getProperty in interface com.sdl.delivery.configuration.ResourceDescriptor

Parameters:

propertyName - The name of a 'resource property'.

Returns:

The value of the 'resource property'.