Package org.hippoecm.frontend.plugin.config

Interface IPluginConfig

All Superinterfaces:

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

All Known Subinterfaces:

IClusterConfig

All Known Implementing Classes:

AbstractClusterDecorator, AbstractPluginDecorator, ClusterConfigDecorator, InheritingPluginConfig, JavaClusterConfig, JavaPluginConfig, JcrClusterConfig, JcrPluginConfig, NodePickerPluginConfig

public interface IPluginConfig
extends org.apache.wicket.util.value.IValueMap, IObservable, Serializable

The plugin configuration. It is a map with some helper methods inherited from the Wicket IValueMap. Although the configuration is specific to the class that uses it, it is recommended to use standard keys for service names. (e.g. the service name under which an IRenderService should be registered is wicket.id)

It is observable, and will broadcast PluginConfigEvents for changes that occur at any depth in the reachable config hierarchy.

There are two implementations provided, JcrPluginConfig and JavaPluginConfig.

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
String	getName()	The name of the configuration.
IPluginConfig	getPluginConfig(Object key)	Retrieve a child config of a particular name.
Set<IPluginConfig>	getPluginConfigSet()	Retrieve a set of child plugin configurations.

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

equals, hashCode, setObservationContext, startObservation, stopObservation

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

Method Detail

getName

String getName()

The name of the configuration. When the configuration is passed to a plugin, this name is unique within the system. It can therefore be used to construct unique service names.

getPluginConfig

IPluginConfig getPluginConfig(Object key)

Retrieve a child config of a particular name. In the JCR implementation, this corresponds to a child node of type frontend:pluginconfig.

getPluginConfigSet

Set<IPluginConfig> getPluginConfigSet()

Retrieve a set of child plugin configurations.