org.apache.oozie.client.rest
Class JsonWorkflowJob

java.lang.Object
  org.apache.oozie.client.rest.JsonWorkflowJob

All Implemented Interfaces:

JsonBean, WorkflowJob

Direct Known Subclasses:

WorkflowJobBean

public class JsonWorkflowJob
extends java.lang.Object
implements WorkflowJob, JsonBean

Json Bean that represents an Oozie workflow job.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.oozie.client.WorkflowJob

WorkflowJob.Status

Constructor Summary

JsonWorkflowJob()

JsonWorkflowJob(org.json.simple.JSONObject json)

Method Summary

static java.util.List<WorkflowJob>	fromJSONArray(org.json.simple.JSONArray array) Convert a JSONArray into a workflows list.
java.util.List<WorkflowAction>	getActions() Return the workflow nodes that already executed and are executing.
java.lang.String	getAppName() Return the name of the workflow application (from the workflow definition).
java.lang.String	getAppPath() Return the path to the workflow application for the workflow job.
java.lang.String	getConf() Return the job configuration.
java.lang.String	getConsoleUrl() Return the workflow job console URL.
java.util.Date	getCreatedTime() Return the workflow job creation time.
java.util.Date	getEndTime() Return the workflow job end time.
java.lang.String	getExternalId()
java.lang.String	getGroup() Return the workflow job group.
java.lang.String	getId() Return the workflow job ID.
java.util.Date	getLastModifiedTime() Return the workflow job last modified time.
int	getRun() Return the workflow job run number.
java.util.Date	getStartTime() Return the workflow job start time.
WorkflowJob.Status	getStatus() Return the workflow job status.
java.lang.String	getUser() Return the workflow job user owner.
void	setActions(java.util.List<? extends JsonWorkflowAction> nodes)
void	setAppName(java.lang.String appName)
void	setAppPath(java.lang.String appPath)
void	setConf(java.lang.String conf)
void	setConsoleUrl(java.lang.String consoleUrl) Set the workflow job console URL.
void	setCreatedTime(java.util.Date createdTime)
void	setEndTime(java.util.Date endTime)
void	setExternalId(java.lang.String externalId)
void	setGroup(java.lang.String group)
void	setId(java.lang.String id)
void	setLastModifiedTime(java.util.Date lastModTime)
void	setRun(int run)
void	setStartTime(java.util.Date startTime)
void	setStatus(WorkflowJob.Status status)
void	setUser(java.lang.String user)
static org.json.simple.JSONArray	toJSONArray(java.util.List<? extends JsonWorkflowJob> workflows) Convert a workflows list into a JSONArray.
org.json.simple.JSONObject	toJSONObject() Return the JSONObject for the bean.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonWorkflowJob

public JsonWorkflowJob()

JsonWorkflowJob

public JsonWorkflowJob(org.json.simple.JSONObject json)

Method Detail

toJSONObject

public org.json.simple.JSONObject toJSONObject()

Description copied from interface: JsonBean

Return the JSONObject for the bean.

Specified by:

toJSONObject in interface JsonBean

Returns:

the JSONObject for the bean.

getAppPath

public java.lang.String getAppPath()

Description copied from interface: WorkflowJob

Return the path to the workflow application for the workflow job.

Specified by:

getAppPath in interface WorkflowJob

Returns:

the path to the workflow application for the workflow job.

setAppPath

public void setAppPath(java.lang.String appPath)

getAppName

public java.lang.String getAppName()

Description copied from interface: WorkflowJob

Return the name of the workflow application (from the workflow definition).

Specified by:

getAppName in interface WorkflowJob

Returns:

the name of the workflow application.

setAppName

public void setAppName(java.lang.String appName)

getId

public java.lang.String getId()

Description copied from interface: WorkflowJob

Return the workflow job ID.

Specified by:

getId in interface WorkflowJob

Returns:

the workflow job ID.

setId

public void setId(java.lang.String id)

setExternalId

public void setExternalId(java.lang.String externalId)

getExternalId

public java.lang.String getExternalId()

getConf

public java.lang.String getConf()

Description copied from interface: WorkflowJob

Return the job configuration.

Specified by:

getConf in interface WorkflowJob

Returns:

the job configuration.

setConf

public void setConf(java.lang.String conf)

getStatus

public WorkflowJob.Status getStatus()

Description copied from interface: WorkflowJob

Return the workflow job status.

Specified by:

getStatus in interface WorkflowJob

Returns:

the workflow job status.

setStatus

public void setStatus(WorkflowJob.Status status)

getLastModifiedTime

public java.util.Date getLastModifiedTime()

Description copied from interface: WorkflowJob

Return the workflow job last modified time.

Specified by:

getLastModifiedTime in interface WorkflowJob

Returns:

the workflow job last modified time.

setLastModifiedTime

public void setLastModifiedTime(java.util.Date lastModTime)

getCreatedTime

public java.util.Date getCreatedTime()

Description copied from interface: WorkflowJob

Return the workflow job creation time.

Specified by:

getCreatedTime in interface WorkflowJob

Returns:

the workflow job creation time.

setCreatedTime

public void setCreatedTime(java.util.Date createdTime)

getStartTime

public java.util.Date getStartTime()

Description copied from interface: WorkflowJob

Return the workflow job start time.

Specified by:

getStartTime in interface WorkflowJob

Returns:

the workflow job start time.

setStartTime

public void setStartTime(java.util.Date startTime)

getEndTime

public java.util.Date getEndTime()

Description copied from interface: WorkflowJob

Return the workflow job end time.

Specified by:

getEndTime in interface WorkflowJob

Returns:

the workflow job end time.

setEndTime

public void setEndTime(java.util.Date endTime)

getUser

public java.lang.String getUser()

Description copied from interface: WorkflowJob

Return the workflow job user owner.

Specified by:

getUser in interface WorkflowJob

Returns:

the workflow job user owner.

setUser

public void setUser(java.lang.String user)

getGroup

public java.lang.String getGroup()

Description copied from interface: WorkflowJob

Return the workflow job group.

Specified by:

getGroup in interface WorkflowJob

Returns:

the workflow job group.

setGroup

public void setGroup(java.lang.String group)

getRun

public int getRun()

Description copied from interface: WorkflowJob

Return the workflow job run number.

Except for reruns, this property is always 1.

Specified by:

getRun in interface WorkflowJob

Returns:

the workflow job run number.

setRun

public void setRun(int run)

getConsoleUrl

public java.lang.String getConsoleUrl()

Return the workflow job console URL.

Specified by:

getConsoleUrl in interface WorkflowJob

Returns:

the workflow job console URL.

setConsoleUrl

public void setConsoleUrl(java.lang.String consoleUrl)

Set the workflow job console URL.

Parameters:

consoleUrl - the workflow job console URL.

getActions

public java.util.List<WorkflowAction> getActions()

Description copied from interface: WorkflowJob

Return the workflow nodes that already executed and are executing.

Specified by:

getActions in interface WorkflowJob

Returns:

the workflow nodes that already executed and are executing.

setActions

public void setActions(java.util.List<? extends JsonWorkflowAction> nodes)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJSONArray

public static org.json.simple.JSONArray toJSONArray(java.util.List<? extends JsonWorkflowJob> workflows)

Convert a workflows list into a JSONArray.

Parameters:

workflows - workflows list.

Returns:

the corresponding JSON array.

fromJSONArray

public static java.util.List<WorkflowJob> fromJSONArray(org.json.simple.JSONArray array)

Convert a JSONArray into a workflows list.

Parameters:

array - JSON array.

Returns:

the corresponding workflows list.