Package org.opencastproject.index.service.catalog.adapter

Class CatalogUIAdapterConfiguration

java.lang.Object

org.opencastproject.index.service.catalog.adapter.CatalogUIAdapterConfiguration

public final class CatalogUIAdapterConfiguration
extends Object

This class parses a catalog UI adapter configuration and provides convenience access methods.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_XML_ROOT_ELEMENT_NAME
static final String	KEY_XML_ROOT_ELEMENT_NS_URI
static final String	XML_BINDING_KEY_PREFIX
static final String	XML_BINDING_PREFIX_SUFFIX
static final String	XML_BINDING_URI_SUFFIX

Method Summary

Modifier and Type	Method	Description
String	getCatalogXmlRootElementName()	Return the value of the configuration property KEY_XML_ROOT_ELEMENT_NAME
String	getCatalogXmlRootNamespace()	Return the value of the configuration property KEY_XML_ROOT_ELEMENT_NS_URI
XmlNamespaceContext	getXmlNamespaceContext()	Returns the XML namespace context that could be built out of the configuration.
static CatalogUIAdapterConfiguration	loadFromDictionary(Dictionary<String,?> properties)	Load configuration from a dictionary.

Methods inherited from class java.lang.Object

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

Field Details

KEY_XML_ROOT_ELEMENT_NAME

public static final String KEY_XML_ROOT_ELEMENT_NAME

See Also:

• Constant Field Values

KEY_XML_ROOT_ELEMENT_NS_URI

public static final String KEY_XML_ROOT_ELEMENT_NS_URI

See Also:

• Constant Field Values

XML_BINDING_KEY_PREFIX

public static final String XML_BINDING_KEY_PREFIX

See Also:

• Constant Field Values

XML_BINDING_URI_SUFFIX

public static final String XML_BINDING_URI_SUFFIX

See Also:

• Constant Field Values

XML_BINDING_PREFIX_SUFFIX

public static final String XML_BINDING_PREFIX_SUFFIX

See Also:

• Constant Field Values

Method Details

loadFromDictionary

public static CatalogUIAdapterConfiguration loadFromDictionary(Dictionary<String,?> properties)
                                                        throws ConfigurationException

Load configuration from a dictionary.

Parameters:

properties - The configuration properties

Returns:

The parsed configuration as CatalogUIAdapterConfiguration instance

Throws:

ConfigurationException - If the configuration has any errors

getCatalogXmlRootElementName

public String getCatalogXmlRootElementName()

Return the value of the configuration property KEY_XML_ROOT_ELEMENT_NAME

getCatalogXmlRootNamespace

public String getCatalogXmlRootNamespace()

Return the value of the configuration property KEY_XML_ROOT_ELEMENT_NS_URI

getXmlNamespaceContext

public XmlNamespaceContext getXmlNamespaceContext()

Returns the XML namespace context that could be built out of the configuration.