org.nuxeo.ecm.platform.uidgen.service
Class UIDGeneratorService

java.lang.Object
  org.nuxeo.runtime.model.DefaultComponent
      org.nuxeo.ecm.platform.uidgen.service.UIDGeneratorService

All Implemented Interfaces:

Adaptable, Component, Extensible

public class UIDGeneratorService
extends DefaultComponent

Service that writes MetaData.

Author:

: Dragos Mihalache

Field Summary

static String	EXTENSION_POINT_SEQUENCER_FACTORY Extension point is deprecated should be removed - preserved for now only for startup warnings.
static String	ID
static String	UID_GENERATORS_EXTENSION_POINT

Constructor Summary

UIDGeneratorService()

Method Summary

void	activate(ComponentContext context) Activates the component.
String	createUID(DocumentModel doc)
void	deactivate(ComponentContext context) Deactivates the component.
<T> T	getAdapter(Class<T> adapter) Returns an object which is an instance of the given class associated with this object.
UIDSequencer	getSequencer()
UIDGenerator	getUIDGeneratorFor(DocumentModel doc) Returns the uid generator to use for this document.
void	registerExtension(Extension extension) Registers the given extension.
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	unregisterExtension(Extension extension) Unregisters the given extension.

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

applicationStarted, registerContribution, unregisterContribution

Methods inherited from class java.lang.Object

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

Field Detail

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

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

Constructor Detail

UIDGeneratorService

public UIDGeneratorService()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

registerExtension

public void registerExtension(Extension extension)
                       throws Exception

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

Throws:

Exception - if any error occurs

getSequencer

public UIDSequencer getSequencer()

unregisterExtension

public void unregisterExtension(Extension extension)
                         throws Exception

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

Throws:

Exception - if any error occurs

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.

setUID

public void setUID(DocumentModel doc)
            throws DocumentException

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

Throws:

DocumentException

createUID

public String createUID(DocumentModel doc)
                 throws DocumentException

Returns:

a new UID for the given document

Throws:

DocumentException

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