Package org.hippoecm.frontend.plugin.config.impl

Class AbstractClusterDecorator

java.lang.Object

java.util.AbstractMap<String,Object>

org.hippoecm.frontend.model.map.AbstractValueMap

org.hippoecm.frontend.plugin.config.impl.AbstractPluginDecorator

org.hippoecm.frontend.plugin.config.impl.AbstractClusterDecorator

All Implemented Interfaces:

Serializable, Map<String,Object>, org.apache.wicket.model.IDetachable, org.apache.wicket.util.io.IClusterable, org.apache.wicket.util.value.IValueMap, IObservable, IClusterConfig, IPluginConfig

Direct Known Subclasses:

ClusterConfigDecorator

public abstract class AbstractClusterDecorator
extends AbstractPluginDecorator
implements IClusterConfig

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields inherited from class org.hippoecm.frontend.plugin.config.impl.AbstractPluginDecorator

obContext, upstream

Constructor Summary

Constructors

Constructor	Description
AbstractClusterDecorator(IClusterConfig upstream)

Method Summary

Modifier and Type	Method	Description
protected IObservationContext<IClusterConfig>	getObservationContext()
List<IPluginConfig>	getPlugins()	The plugin configurations in the cluster.
List<String>	getProperties()	Properties that specify additional plugin behavior.
List<PropertyDescriptor>	getPropertyDescriptors()	Descriptors of additional plugin properties.
List<String>	getReferences()	The keys for services that are used by plugins in the cluster.
List<String>	getServices()	The list of keys for services.
protected IClusterConfig	getUpstream()
void	setPlugins(List<IPluginConfig> plugins)	Update the plugins in the cluster.
void	startObservation()	When the first IObserver of this observable is registered with the observer registry, observation is started.
void	stopObservation()	When the last IObserver unregisters, observation is stopped.

Methods inherited from class org.hippoecm.frontend.plugin.config.impl.AbstractPluginDecorator

containsKey, decorate, detach, entrySet, equals, get, getDouble, getDouble, getDuration, getInstant, getName, getPluginConfig, getPluginConfigSet, hashCode, isImmutable, makeImmutable, setObservationContext, toString, wrap, wrapConfig

Methods inherited from class org.hippoecm.frontend.model.map.AbstractValueMap

add, clear, getAsBoolean, getAsBoolean, getAsDouble, getAsDouble, getAsDuration, getAsDuration, getAsEnum, getAsEnum, getAsEnum, getAsInstant, getAsInteger, getAsInteger, getAsLong, getAsLong, getAsTime, getBoolean, getCharSequence, getInt, getInt, getKey, getLong, getLong, getString, getString, getStringArray, getStringValue, putAll, remove

Methods inherited from class java.util.AbstractMap

clone, containsValue, isEmpty, keySet, put, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hippoecm.frontend.model.event.IObservable

equals, hashCode, setObservationContext

Methods inherited from interface org.hippoecm.frontend.plugin.config.IPluginConfig

getName, getPluginConfig, getPluginConfigSet

Methods inherited from interface org.apache.wicket.util.value.IValueMap

getAsBoolean, getAsBoolean, getAsDouble, getAsDouble, getAsDuration, getAsDuration, getAsEnum, getAsEnum, getAsEnum, getAsInstant, getAsInteger, getAsInteger, getAsLong, getAsLong, getAsTime, getBoolean, getCharSequence, getDouble, getDouble, getDuration, getInstant, getInt, getInt, getKey, getLong, getLong, getString, getString, getStringArray, getStringValue, isImmutable, makeImmutable

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

AbstractClusterDecorator

public AbstractClusterDecorator(IClusterConfig upstream)

Method Detail

getUpstream

protected IClusterConfig getUpstream()

getPlugins

public List<IPluginConfig> getPlugins()

Description copied from interface: IClusterConfig

The plugin configurations in the cluster. Returns an immutable list of plugins.

Specified by:

getPlugins in interface IClusterConfig

setPlugins

public void setPlugins(List<IPluginConfig> plugins)

Description copied from interface: IClusterConfig

Update the plugins in the cluster. Only available when the the configuration is used as a template for the cluster configuration.

Specified by:

setPlugins in interface IClusterConfig

getProperties

public final List<String> getProperties()

Description copied from interface: IClusterConfig

Properties that specify additional plugin behavior.

The returned list is only mutable when the configuration is used as a template.

Specified by:

getProperties in interface IClusterConfig

getReferences

public final List<String> getReferences()

Description copied from interface: IClusterConfig

The keys for services that are used by plugins in the cluster.

The returned list is only mutable when the configuration is used as a template.

Specified by:

getReferences in interface IClusterConfig

getServices

public final List<String> getServices()

Description copied from interface: IClusterConfig

The list of keys for services. Since service types are not available, it is recommended to always use well-known keys when they exist. I.e. use "wicket.id" to identify an IRenderService.

The returned list is only mutable when the configuration is used as a template.

Specified by:

getServices in interface IClusterConfig

getPropertyDescriptors

public List<PropertyDescriptor> getPropertyDescriptors()

Description copied from interface: IClusterConfig

Descriptors of additional plugin properties.

Changes to the returned list have no effect on actual configuration.

Specified by:

getPropertyDescriptors in interface IClusterConfig

getObservationContext

protected IObservationContext<IClusterConfig> getObservationContext()

Overrides:

getObservationContext in class AbstractPluginDecorator

startObservation

public void startObservation()

Description copied from interface: IObservable

When the first IObserver of this observable is registered with the observer registry, observation is started. Implementations must notify observers until observation is stopped.

An implementation should register listeners with external data sources, when appropriate. It is possible for an observable to register as an observer for another observable.

Specified by:

startObservation in interface IObservable

Overrides:

startObservation in class AbstractPluginDecorator

stopObservation

public void stopObservation()

Description copied from interface: IObservable

When the last IObserver unregisters, observation is stopped. Any listeners or observers registered by the observable must be unregistered by the implementation.

Specified by:

stopObservation in interface IObservable

Overrides:

stopObservation in class AbstractPluginDecorator