org.nuxeo.ecm.core.event.pipe

Class EventPipeRegistry

java.lang.Object

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

org.nuxeo.ecm.core.event.pipe.EventPipeRegistry

public class EventPipeRegistry
extends ContributionFragmentRegistry<EventPipeDescriptor>

Contribution registry for EventPipeDescriptor

Since:

8.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,EventPipeDescriptor>	reg

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

contribs

Constructor Summary

Constructors

Constructor and Description
EventPipeRegistry()

Method Summary

Modifier and Type	Method and Description
EventPipeDescriptor	clone(EventPipeDescriptor desc) CLone the given contribution object
void	contributionRemoved(String name, EventPipeDescriptor desc) All the fragments in the contribution was removed.
void	contributionUpdated(String name, EventPipeDescriptor desc, EventPipeDescriptor origin) Adds or updates a contribution.
String	getContributionId(EventPipeDescriptor desc) Returns the contribution ID given the contribution object
EventPipeDescriptor	getPipeDescriptor(String name)
Set<String>	getPipeNames()
List<EventPipeDescriptor>	getPipes()
void	merge(EventPipeDescriptor src, EventPipeDescriptor dest) Merge 'src' into 'dst'.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

reg

protected Map<String,EventPipeDescriptor> reg

Constructor Detail

EventPipeRegistry

public EventPipeRegistry()

Method Detail

clone

public EventPipeDescriptor clone(EventPipeDescriptor desc)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Specified by:

clone in class ContributionFragmentRegistry<EventPipeDescriptor>

Returns:

contributionRemoved

public void contributionRemoved(String name,
                                EventPipeDescriptor desc)

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.

Specified by:

contributionRemoved in class ContributionFragmentRegistry<EventPipeDescriptor>

contributionUpdated

public void contributionUpdated(String name,
                                EventPipeDescriptor desc,
                                EventPipeDescriptor origin)

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.

Specified by:

contributionUpdated in class ContributionFragmentRegistry<EventPipeDescriptor>

Parameters:

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

desc - the updated contribution object that

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

getContributionId

public String getContributionId(EventPipeDescriptor desc)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<EventPipeDescriptor>

Returns:

merge

public void merge(EventPipeDescriptor src,
                  EventPipeDescriptor dest)

Description copied from class: ContributionFragmentRegistry

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

Specified by:

merge in class ContributionFragmentRegistry<EventPipeDescriptor>

Parameters:

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

dest - this object is modified

getPipeDescriptor

public EventPipeDescriptor getPipeDescriptor(String name)

getPipeNames

public Set<String> getPipeNames()

getPipes

public List<EventPipeDescriptor> getPipes()