org.apache.oozie.command.coord

Class CoordCommandUtils

java.lang.Object

org.apache.oozie.command.coord.CoordCommandUtils

public class CoordCommandUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABSOLUTE
static int	CURRENT
static int	FUTURE
static int	LATEST
static int	OFFSET
static java.lang.String	RESOLVED_UNRESOLVED_SEPARATOR
static int	UNEXPECTED
static java.lang.String	UNRESOLVED_INST_TAG

Constructor Summary

Constructors

Constructor and Description
CoordCommandUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkIfBothSameType(java.lang.String startInst, java.lang.String endInst)
static java.util.Date	computeNextNominalTime(CoordinatorJobBean coordJob, CoordinatorActionBean coordAction) Computes the nominal time of the next action.
static java.lang.String	createEarlyURIs(org.jdom.Element event, java.lang.String instances, java.lang.StringBuilder unresolvedInstances, java.lang.StringBuilder urisWithDoneFlag) The function create a list of URIs separated by "," using the instances time stamp and URI-template
static int	getFuncType(java.lang.String function)
static int	getInstanceNumber(java.lang.String function, java.lang.StringBuilder restArg) parse a function like coord:latest(n)/future() and return the 'n'.
static java.util.Date	getNextValidActionTimeForCronFrequency(java.util.Date targetDate, CoordinatorJobBean coordJob) Get the next action time after a given time
static java.lang.String	getResolvedList(java.lang.String missDepList, java.lang.StringBuilder resolved, java.lang.StringBuilder unresolved) Get resolved string from missDepList
static java.util.Map<java.lang.String,java.lang.StringBuilder>	materializeDataEvents(java.util.List<org.jdom.Element> events, SyncCoordAction appInst, org.apache.hadoop.conf.Configuration conf) Materialize all / or / tags Create uris for resolved instances.
static java.lang.String	materializeInstance(org.jdom.Element event, java.lang.String expr, SyncCoordAction appInst, org.apache.hadoop.conf.Configuration conf, ELEvaluator evalInst) Materialize one instance like current(-2)
static java.lang.String	materializeOneInstance(java.lang.String jobId, boolean dryrun, org.jdom.Element eAction, java.util.Date nominalTime, java.util.Date actualTime, int instanceCount, org.apache.hadoop.conf.Configuration conf, CoordinatorActionBean actionBean) Materialize one instance for specific nominal time.
static boolean	materializeSLA(org.jdom.Element eAction, CoordinatorActionBean coordAction, org.apache.hadoop.conf.Configuration conf)
static int	parseOneArg(java.lang.String funcName)
static java.lang.String	parseOneStringArg(java.lang.String funcName)
static void	resolveInstanceRange(org.jdom.Element event, java.lang.StringBuilder instances, SyncCoordAction appInst, org.apache.hadoop.conf.Configuration conf, ELEvaluator eval) Resolve tag.
static void	resolveInstances(org.jdom.Element event, java.lang.StringBuilder instances, SyncCoordAction actionInst, org.apache.hadoop.conf.Configuration conf, ELEvaluator eval) Resolve list of tags.

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT

public static int CURRENT

LATEST

public static int LATEST

FUTURE

public static int FUTURE

OFFSET

public static int OFFSET

ABSOLUTE

public static int ABSOLUTE

UNEXPECTED

public static int UNEXPECTED

RESOLVED_UNRESOLVED_SEPARATOR

public static final java.lang.String RESOLVED_UNRESOLVED_SEPARATOR

See Also:

Constant Field Values

UNRESOLVED_INST_TAG

public static final java.lang.String UNRESOLVED_INST_TAG

See Also:

Constant Field Values

Constructor Detail

CoordCommandUtils

public CoordCommandUtils()

Method Detail

getInstanceNumber

public static int getInstanceNumber(java.lang.String function,
                    java.lang.StringBuilder restArg)
                             throws java.lang.Exception

parse a function like coord:latest(n)/future() and return the 'n'.

Parameters:

function -

restArg -

Returns:

int instanceNumber

Throws:

java.lang.Exception

parseOneArg

public static int parseOneArg(java.lang.String funcName)
                       throws java.lang.Exception

Throws:

java.lang.Exception

parseOneStringArg

public static java.lang.String parseOneStringArg(java.lang.String funcName)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getFuncType

public static int getFuncType(java.lang.String function)

Parameters:

EL - function name

Returns:

type of EL function

checkIfBothSameType

public static void checkIfBothSameType(java.lang.String startInst,
                       java.lang.String endInst)
                                throws CommandException

Parameters:

startInst: - EL function name

endInst: - EL function name

Throws:

CommandException - if both are not the same function

resolveInstances

public static void resolveInstances(org.jdom.Element event,
                    java.lang.StringBuilder instances,
                    SyncCoordAction actionInst,
                    org.apache.hadoop.conf.Configuration conf,
                    ELEvaluator eval)
                             throws java.lang.Exception

Resolve list of tags.

Parameters:

event -

instances -

actionInst -

conf -

eval: - ELEvalautor

Throws:

java.lang.Exception

resolveInstanceRange

public static void resolveInstanceRange(org.jdom.Element event,
                        java.lang.StringBuilder instances,
                        SyncCoordAction appInst,
                        org.apache.hadoop.conf.Configuration conf,
                        ELEvaluator eval)
                                 throws java.lang.Exception

Resolve tag. Don't resolve any latest()/future()

Parameters:

event -

instances -

appInst -

conf -

eval: - ELEvalautor

Throws:

java.lang.Exception

materializeInstance

public static java.lang.String materializeInstance(org.jdom.Element event,
                                   java.lang.String expr,
                                   SyncCoordAction appInst,
                                   org.apache.hadoop.conf.Configuration conf,
                                   ELEvaluator evalInst)
                                            throws java.lang.Exception

Materialize one instance like current(-2)

Parameters:

event - :

expr - : instance like current(-1)

appInst - : application specific info

conf -

evalInst - :ELEvaluator

Returns:

materialized date string

Throws:

java.lang.Exception

createEarlyURIs

public static java.lang.String createEarlyURIs(org.jdom.Element event,
                               java.lang.String instances,
                               java.lang.StringBuilder unresolvedInstances,
                               java.lang.StringBuilder urisWithDoneFlag)
                                        throws java.lang.Exception

The function create a list of URIs separated by "," using the instances time stamp and URI-template

Parameters:

event - : event

instances - : List of time stamp separated by ","

unresolvedInstances - : list of instance with latest function

urisWithDoneFlag - : list of URIs with the done flag appended

Returns:

: list of URIs separated by ";" as a string.

Throws:

java.lang.Exception

materializeSLA

public static boolean materializeSLA(org.jdom.Element eAction,
                     CoordinatorActionBean coordAction,
                     org.apache.hadoop.conf.Configuration conf)
                              throws CoordinatorJobException

Parameters:

eAction -

coordAction -

conf -

Returns:

boolean to determine whether the SLA element is present or not

Throws:

CoordinatorJobException

materializeOneInstance

public static java.lang.String materializeOneInstance(java.lang.String jobId,
                                      boolean dryrun,
                                      org.jdom.Element eAction,
                                      java.util.Date nominalTime,
                                      java.util.Date actualTime,
                                      int instanceCount,
                                      org.apache.hadoop.conf.Configuration conf,
                                      CoordinatorActionBean actionBean)
                                               throws java.lang.Exception

Materialize one instance for specific nominal time. It includes: 1. Materialize data events (i.e. and ) 2. Materialize data properties (i.e dataIn() and dataOut() 3. remove 'start' and 'end' tag 4. Add 'instance_number' and 'nominal-time' tag

Parameters:

jobId - coordinator job id

dryrun - true if it is dryrun

eAction - frequency unexploded-job

nominalTime - materialization time

actualTime - action actual time

instanceCount - instance numbers

conf - job configuration

actionBean - CoordinatorActionBean to materialize

Returns:

one materialized action for specific nominal time

Throws:

java.lang.Exception

materializeDataEvents

public static java.util.Map<java.lang.String,java.lang.StringBuilder> materializeDataEvents(java.util.List<org.jdom.Element> events,
                                                                            SyncCoordAction appInst,
                                                                            org.apache.hadoop.conf.Configuration conf)
                                                                                     throws java.lang.Exception

Materialize all / or / tags Create uris for resolved instances. Create unresolved instance for latest()/future().

Parameters:

events -

appInst -

conf -

Throws:

java.lang.Exception

getResolvedList

public static java.lang.String getResolvedList(java.lang.String missDepList,
                               java.lang.StringBuilder resolved,
                               java.lang.StringBuilder unresolved)

Get resolved string from missDepList

Parameters:

missDepList -

resolved -

unresolved -

Returns:

resolved string

getNextValidActionTimeForCronFrequency

public static java.util.Date getNextValidActionTimeForCronFrequency(java.util.Date targetDate,
                                                    CoordinatorJobBean coordJob)
                                                             throws java.text.ParseException

Get the next action time after a given time

Parameters:

targetDate -

coordJob -

Returns:

the next valid action time

Throws:

java.text.ParseException

computeNextNominalTime

public static java.util.Date computeNextNominalTime(CoordinatorJobBean coordJob,
                                    CoordinatorActionBean coordAction)
                                             throws java.text.ParseException,
                                                    org.jdom.JDOMException

Computes the nominal time of the next action. Based on CoordMaterializeTransitionXCommand#materializeActions The Coordinator Job needs to have the frequency, time unit, time zone, start time, end time, and job xml. The Coordinator Action needs to have the nominal time and action number.

Parameters:

coordJob - The Coordinator Job

coordAction - The Coordinator Action

Returns:

the nominal time of the next action

Throws:

java.text.ParseException

org.jdom.JDOMException