org.nuxeo.runtime.services.config

Class ConfigurationPropertyRegistry

java.lang.Object

org.nuxeo.runtime.model.ContributionFragmentRegistry<T>

org.nuxeo.runtime.model.SimpleContributionRegistry<ConfigurationPropertyDescriptor>

org.nuxeo.runtime.services.config.ConfigurationPropertyRegistry

public class ConfigurationPropertyRegistry
extends SimpleContributionRegistry<ConfigurationPropertyDescriptor>

Registry for JSF configuration contributions.

Since:

7.4

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	properties

Fields inherited from class org.nuxeo.runtime.model.SimpleContributionRegistry

currentContribs

Fields inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

contribs

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertyRegistry()

Method Summary

Modifier and Type	Method and Description
ConfigurationPropertyDescriptor	clone(ConfigurationPropertyDescriptor orig) CLone the given contribution object
void	contributionRemoved(String id, ConfigurationPropertyDescriptor origContrib) All the fragments in the contribution was removed.
void	contributionUpdated(String key, ConfigurationPropertyDescriptor contrib, ConfigurationPropertyDescriptor newOrigContrib) Adds or updates a contribution.
String	getContributionId(ConfigurationPropertyDescriptor contrib) Returns the contribution ID given the contribution object
String	getProperty(String key)
boolean	hasProperty(String key)
boolean	isSupportingMerge() Returns true if merge is supported.
void	merge(ConfigurationPropertyDescriptor src, ConfigurationPropertyDescriptor dst) Merge 'src' into 'dst'.

Methods inherited from class org.nuxeo.runtime.model.SimpleContributionRegistry

getCurrentContribution

Methods inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

addContribution, addFragment, getContribution, getFragments, removeContribution, removeContribution, removeFragment

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected Map<String,String> properties

Constructor Detail

ConfigurationPropertyRegistry

public ConfigurationPropertyRegistry()

Method Detail

getContributionId

public String getContributionId(ConfigurationPropertyDescriptor contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<ConfigurationPropertyDescriptor>

Returns:

contributionUpdated

public void contributionUpdated(String key,
                                ConfigurationPropertyDescriptor contrib,
                                ConfigurationPropertyDescriptor newOrigContrib)

Description copied from class: ContributionFragmentRegistry

Adds or updates a contribution.

If the contribution doesn't yet exists then it will be added, otherwise the value will be updated. If the given value is null the existing contribution must be removed.

The second parameter is the contribution that should be updated when merging, as well as stored and used. This usually represents a clone of the original contribution or a merge of multiple contribution fragments. Modifications on this object at application level will be lost on next ContributionFragmentRegistry.contributionUpdated(String, Object, Object) call on the same object id: modifications should be done in the ContributionFragmentRegistry.merge(Object, Object) method.

The last parameter is the new contribution object, unchanged (original) which was neither cloned nor merged. This object should never be modified at application level, because it will be used each time a subsequent merge is done. Also, it never should be stored.

Overrides:

contributionUpdated in class SimpleContributionRegistry<ConfigurationPropertyDescriptor>

Parameters:

key - - the id of the contribution that needs to be updated

contrib - the updated contribution object that

newOrigContrib - - the new, unchanged (original) contribution fragment that triggered the update.

contributionRemoved

public void contributionRemoved(String id,
                                ConfigurationPropertyDescriptor origContrib)

Description copied from class: ContributionFragmentRegistry

All the fragments in the contribution was removed. Contribution must be unregistered.

The first parameter is the contribution ID that should be remove and the second parameter the original contribution fragment that as unregistered causing the contribution to be removed.

Overrides:

contributionRemoved in class SimpleContributionRegistry<ConfigurationPropertyDescriptor>

clone

public ConfigurationPropertyDescriptor clone(ConfigurationPropertyDescriptor orig)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Overrides:

clone in class SimpleContributionRegistry<ConfigurationPropertyDescriptor>

Returns:

merge

public void merge(ConfigurationPropertyDescriptor src,
                  ConfigurationPropertyDescriptor dst)

Description copied from class: ContributionFragmentRegistry

Merge 'src' into 'dst'. When merging only the 'dst' object is modified.

Overrides:

merge in class SimpleContributionRegistry<ConfigurationPropertyDescriptor>

Parameters:

src - the object to copy over the 'dst' object

dst - this object is modified

isSupportingMerge

public boolean isSupportingMerge()

Description copied from class: ContributionFragmentRegistry

Returns true if merge is supported.

Hook method to be overridden if merge logics behind Object.clone() and ContributionFragmentRegistry.merge(Object, Object) cannot be implemented.

Overrides:

isSupportingMerge in class SimpleContributionRegistry<ConfigurationPropertyDescriptor>

hasProperty

public boolean hasProperty(String key)

getProperty

public String getProperty(String key)