Package org.nuxeo.ecm.core.uidgen

Class UIDGeneratorComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.core.uidgen.UIDGeneratorComponent

All Implemented Interfaces:

UIDGeneratorService, Adaptable, Component, Extensible, TimestampedService

public class UIDGeneratorComponent
extends DefaultComponent
implements UIDGeneratorService

Service that writes MetaData.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	defaultSequencer
static final String	EXTENSION_POINT_SEQUENCER_FACTORY	Extension point is deprecated should be removed - preserved for now only for startup warnings.
protected final Map<String,UIDGenerator>	generators
static final String	ID
protected final LinkedHashMap<String,UIDSequencerProviderDescriptor>	sequencerContribs
protected final Map<String,UIDSequencer>	sequencers
static final String	SEQUENCERS_EXTENSION_POINT
static final String	UID_GENERATORS_EXTENSION_POINT

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

lastModified, name

Constructor Summary

Constructors

Constructor	Description
UIDGeneratorComponent()

Method Summary

Modifier and Type	Method	Description
protected void	computeDefault()
String	createUID(DocumentModel doc)
<T> T	getAdapter(Class<T> adapter)	Returns an object which is an instance of the given class associated with this object.
UIDSequencer	getSequencer()	Retrieves the default UIDSequencer
UIDSequencer	getSequencer(String name)	Retrieves UIDSequencer by it's name
List<UIDSequencer>	getSequencers()	Retrieves all UIDSequencer.
UIDGenerator	getUIDGeneratorFor(DocumentModel doc)	Returns the uid generator to use for this document.
void	registerExtension(Extension extension)	Registers the given extension.
protected void	registerGenerators(Extension extension, Object[] contribs)
protected void	registerSequencers(Extension extension, Object[] contribs)
void	setUID(DocumentModel doc)	Creates a new UID for the given doc and sets the field configured in the generator component with this value.
void	start(ComponentContext context)	Start the component.
void	stop(ComponentContext context)	Stop the component.
void	unregisterExtension(Extension extension)	Unregisters the given extension.
protected void	unregisterSequencers(Extension extension, Object[] contribs)

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

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, setLastModified, setModifiedNow, setName, unregister, unregisterContribution

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

UID_GENERATORS_EXTENSION_POINT

public static final String UID_GENERATORS_EXTENSION_POINT

See Also:

• Constant Field Values

SEQUENCERS_EXTENSION_POINT

public static final String SEQUENCERS_EXTENSION_POINT

See Also:

• Constant Field Values

EXTENSION_POINT_SEQUENCER_FACTORY

public static final String EXTENSION_POINT_SEQUENCER_FACTORY

Extension point is deprecated should be removed - preserved for now only for startup warnings.

See Also:

• Constant Field Values

generators

protected final Map<String,UIDGenerator> generators

sequencers

protected final Map<String,UIDSequencer> sequencers

sequencerContribs

protected final LinkedHashMap<String,UIDSequencerProviderDescriptor> sequencerContribs

defaultSequencer

protected String defaultSequencer

Constructor Details

UIDGeneratorComponent

public UIDGeneratorComponent()

Method Details

start

public void start(ComponentContext context)

Description copied from interface: Component

Start the component. This method is called after all the components were resolved and activated

Specified by:

start in interface Component

Overrides:

start in class DefaultComponent

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

registerExtension

public void registerExtension(Extension extension)

Description copied from interface: Extensible

Registers the given extension.

Specified by:

registerExtension in interface Extensible

Overrides:

registerExtension in class DefaultComponent

Parameters:

extension - the extension to register

unregisterExtension

public void unregisterExtension(Extension extension)

Description copied from interface: Extensible

Unregisters the given extension.

Specified by:

unregisterExtension in interface Extensible

Overrides:

unregisterExtension in class DefaultComponent

Parameters:

extension - the extension to unregister

computeDefault

protected void computeDefault()

registerSequencers

protected void registerSequencers(Extension extension,
 Object[] contribs)

unregisterSequencers

protected void unregisterSequencers(Extension extension,
 Object[] contribs)

registerGenerators

protected void registerGenerators(Extension extension,
 Object[] contribs)

getUIDGeneratorFor

public UIDGenerator getUIDGeneratorFor(DocumentModel doc)

Returns the uid generator to use for this document.

Choice is made following the document type and the generator configuration.

Specified by:

getUIDGeneratorFor in interface UIDGeneratorService

setUID

public void setUID(DocumentModel doc)
            throws PropertyNotFoundException

Creates a new UID for the given doc and sets the field configured in the generator component with this value.

Specified by:

setUID in interface UIDGeneratorService

Throws:

PropertyNotFoundException

createUID

public String createUID(DocumentModel doc)

Specified by:

createUID in interface UIDGeneratorService

Returns:

a new UID for the given document

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class DefaultComponent

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

getSequencers

public List<UIDSequencer> getSequencers()

Description copied from interface: UIDGeneratorService

Retrieves all UIDSequencer.

Specified by:

getSequencers in interface UIDGeneratorService

Returns:

all UIDSequencer.

getSequencer

public UIDSequencer getSequencer()

Description copied from interface: UIDGeneratorService

Retrieves the default UIDSequencer

Specified by:

getSequencer in interface UIDGeneratorService

Returns:

the default UIDSequencer

getSequencer

public UIDSequencer getSequencer(String name)

Description copied from interface: UIDGeneratorService

Retrieves UIDSequencer by it's name

Specified by:

getSequencer in interface UIDGeneratorService

Parameters:

name - the name of the UIDSequencer

Returns:

the UIDSequencer matching the name