org.apache.oozie.service

Class UUIDService

java.lang.Object

org.apache.oozie.service.UUIDService

All Implemented Interfaces:

Service

Direct Known Subclasses:

ZKUUIDService

public class UUIDService
extends java.lang.Object
implements Service

The UUID service generates unique IDs.

The configuration property CONF_GENERATOR specifies the ID generation type, 'random' or 'counter'.

For 'random' uses the JDK UUID.randomUUID() method.

For 'counter' uses a counter postfixed wit the system start up time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UUIDService.ApplicationType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONF_GENERATOR
static java.lang.String	CONF_PREFIX
static int	MAX_ACTION_ID_LEN
static int	MAX_OOZIE_JOB_ID_LEN
protected java.lang.String	startTime

Fields inherited from interface org.apache.oozie.service.Service

DEFAULT_LOCK_TIMEOUT, lockTimeout

Constructor Summary

Constructors

Constructor and Description
UUIDService()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	appendTimeToSequence(long id, java.lang.String localStartTime)
protected java.lang.String	createSequence()
void	destroy() Destroy the UUID service.
java.lang.String	generateChildId(java.lang.String id, java.lang.String childName) Create a child ID.
java.lang.String	generateId(UUIDService.ApplicationType type) Create a unique ID.
java.lang.String	getChildName(java.lang.String childId) Return the child name from a child ID.
protected long	getCounter()
java.lang.String	getId(java.lang.String childId) Return the ID from a child ID.
java.lang.Class<? extends Service>	getInterface() Return the public interface for UUID service.
void	init(Services services) Initialize the UUID service.
protected java.lang.String	longPadding(long number)
protected void	resetStartTime() reset start time

Methods inherited from class java.lang.Object

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

Field Detail

CONF_PREFIX

public static final java.lang.String CONF_PREFIX

See Also:

Constant Field Values

CONF_GENERATOR

public static final java.lang.String CONF_GENERATOR

See Also:

Constant Field Values

MAX_OOZIE_JOB_ID_LEN

public static final int MAX_OOZIE_JOB_ID_LEN

See Also:

Constant Field Values

MAX_ACTION_ID_LEN

public static final int MAX_ACTION_ID_LEN

See Also:

Constant Field Values

startTime

protected java.lang.String startTime

Constructor Detail

UUIDService

public UUIDService()

Method Detail

init

public void init(Services services)
          throws ServiceException

Initialize the UUID service.

Specified by:

init in interface Service

Parameters:

services - services instance.

Throws:

ServiceException - thrown if the UUID service could not be initialized.

destroy

public void destroy()

Destroy the UUID service.

Specified by:

destroy in interface Service

resetStartTime

protected void resetStartTime()

reset start time

getInterface

public java.lang.Class<? extends Service> getInterface()

Return the public interface for UUID service.

Specified by:

getInterface in interface Service

Returns:

UUIDService.

longPadding

protected java.lang.String longPadding(long number)

generateId

public java.lang.String generateId(UUIDService.ApplicationType type)

Create a unique ID.

Parameters:

type: - Type of Id. Generally 'C' for Coordinator, 'W' for Workflow and 'B' for Bundle.

Returns:

unique ID, id = "${sequence}-${systemId}-[C|W|B]" where, sequence is ${padded_counter}-${startTime} whose length is exactly 7 + 1 + 15 = 23 characters. systemId is the value defined in the #CONF_SYSTEM_ID configuration property. Unique ID Example: 0007728-150515180312570-oozie-oozi-W

createSequence

protected java.lang.String createSequence()

getCounter

protected long getCounter()

appendTimeToSequence

protected java.lang.String appendTimeToSequence(long id,
                                    java.lang.String localStartTime)

generateChildId

public java.lang.String generateChildId(java.lang.String id,
                               java.lang.String childName)

Create a child ID.

If the same child name is given the returned child ID is the same.

Parameters:

id - unique ID.

childName - child name.

Returns:

a child ID.

getId

public java.lang.String getId(java.lang.String childId)

Return the ID from a child ID.

Parameters:

childId - child ID.

Returns:

ID of the child ID.

getChildName

public java.lang.String getChildName(java.lang.String childId)

Return the child name from a child ID.

Parameters:

childId - child ID.

Returns:

child name.