public class WorkQueueDescriptorRegistry extends ContributionFragmentRegistry<WorkQueueDescriptor>
WorkQueueDescriptor
s.ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>
Modifier and Type | Field and Description |
---|---|
protected Map<String,String> |
categoryToQueueId |
protected boolean |
refresh |
protected Map<String,WorkQueueDescriptor> |
registry |
protected WorkManagerImpl |
works |
contribs
Constructor and Description |
---|
WorkQueueDescriptorRegistry(WorkManagerImpl works) |
Modifier and Type | Method and Description |
---|---|
WorkQueueDescriptor |
clone(WorkQueueDescriptor orig)
CLone the given contribution object
|
void |
contributionRemoved(String id,
WorkQueueDescriptor origContrib)
All the fragments in the contribution was removed.
|
void |
contributionUpdated(String id,
WorkQueueDescriptor contrib,
WorkQueueDescriptor newOrigContrib)
Adds or updates a contribution.
|
WorkQueueDescriptor |
get(String queueId)
Gets the descriptor for a given queue id.
|
String |
getContributionId(WorkQueueDescriptor contrib)
Returns the contribution ID given the contribution object
|
String |
getQueueId(String category) |
List<String> |
getQueueIds()
Gets the list of queue ids.
|
void |
merge(WorkQueueDescriptor src,
WorkQueueDescriptor dst)
Merge 'src' into 'dst'.
|
protected void |
refresh() |
addContribution, addFragment, getContribution, getFragments, isSupportingMerge, removeContribution, removeContribution, removeFragment
protected final WorkManagerImpl works
protected Map<String,WorkQueueDescriptor> registry
protected volatile boolean refresh
protected Map<String,String> categoryToQueueId
public WorkQueueDescriptorRegistry(WorkManagerImpl works)
public WorkQueueDescriptor get(String queueId)
queueId
- the queue idnull
public List<String> getQueueIds()
public String getContributionId(WorkQueueDescriptor contrib)
ContributionFragmentRegistry
getContributionId
in class ContributionFragmentRegistry<WorkQueueDescriptor>
public void contributionUpdated(String id, WorkQueueDescriptor contrib, WorkQueueDescriptor newOrigContrib)
ContributionFragmentRegistry
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.
contributionUpdated
in class ContributionFragmentRegistry<WorkQueueDescriptor>
id
- - the id of the contribution that needs to be updatedcontrib
- the updated contribution object thatnewOrigContrib
- - the new, unchanged (original) contribution fragment that triggered the update.public void contributionRemoved(String id, WorkQueueDescriptor origContrib)
ContributionFragmentRegistry
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.
contributionRemoved
in class ContributionFragmentRegistry<WorkQueueDescriptor>
protected void refresh()
public String getQueueId(String category)
public WorkQueueDescriptor clone(WorkQueueDescriptor orig)
ContributionFragmentRegistry
clone
in class ContributionFragmentRegistry<WorkQueueDescriptor>
public void merge(WorkQueueDescriptor src, WorkQueueDescriptor dst)
ContributionFragmentRegistry
merge
in class ContributionFragmentRegistry<WorkQueueDescriptor>
src
- the object to copy over the 'dst' objectdst
- this object is modifiedCopyright © 2015 Nuxeo SA. All rights reserved.