org.alfresco.repo.web.scripts.config

Class OpenSearchConfigElement

java.lang.Object

org.springframework.extensions.config.element.ConfigElementAdapter

org.alfresco.repo.web.scripts.config.OpenSearchConfigElement

All Implemented Interfaces:

Serializable, org.springframework.extensions.config.ConfigElement

public class OpenSearchConfigElement
extends org.springframework.extensions.config.element.ConfigElementAdapter

Custom config element that represents the config data for open search

Author:

davidc

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenSearchConfigElement.EngineConfig Inner class representing the configuration of an OpenSearch engine
static class	OpenSearchConfigElement.ProxyConfig Inner class representing the configuration of the OpenSearch proxy

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_ELEMENT_ID

Fields inherited from class org.springframework.extensions.config.element.ConfigElementAdapter

attributes, children, name, value

Constructor Summary

Constructors

Constructor and Description
OpenSearchConfigElement() Default constructor
OpenSearchConfigElement(String name) Constructor

Method Summary

Modifier and Type	Method and Description
org.springframework.extensions.config.ConfigElement	combine(org.springframework.extensions.config.ConfigElement configElement)
List<org.springframework.extensions.config.ConfigElement>	getChildren()
OpenSearchConfigElement.EngineConfig	getEngine(String proxy)
Set<OpenSearchConfigElement.EngineConfig>	getEngines()
OpenSearchConfigElement.ProxyConfig	getProxy() Gets the proxy configuration

Methods inherited from class org.springframework.extensions.config.element.ConfigElementAdapter

getAttribute, getAttributeCount, getAttributes, getChild, getChildCount, getChildren, getChildrenMap, getChildValue, getName, getValue, hasAttribute, hasChildren, setValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_ELEMENT_ID

public static final String CONFIG_ELEMENT_ID

See Also:

Constant Field Values

Constructor Detail

OpenSearchConfigElement

public OpenSearchConfigElement()

Default constructor

OpenSearchConfigElement

public OpenSearchConfigElement(String name)

Constructor

Parameters:

name - Name of the element this config element represents

Method Detail

getChildren

public List<org.springframework.extensions.config.ConfigElement> getChildren()

Specified by:

getChildren in interface org.springframework.extensions.config.ConfigElement

Overrides:

getChildren in class org.springframework.extensions.config.element.ConfigElementAdapter

See Also:

ConfigElement.getChildren()

combine

public org.springframework.extensions.config.ConfigElement combine(org.springframework.extensions.config.ConfigElement configElement)

Specified by:

combine in interface org.springframework.extensions.config.ConfigElement

Specified by:

combine in class org.springframework.extensions.config.element.ConfigElementAdapter

See Also:

ConfigElement.combine(ConfigElement)

getProxy

public OpenSearchConfigElement.ProxyConfig getProxy()

Gets the proxy configuration

Returns:

The proxy configuration

getEngines

public Set<OpenSearchConfigElement.EngineConfig> getEngines()

Returns:

Returns a set of the engines

getEngine

public OpenSearchConfigElement.EngineConfig getEngine(String proxy)

Parameters:

proxy - name of engine proxy

Returns:

associated engine config (or null, if none registered against proxy)