public class RequestDetail extends Object implements Serializable
Modifier and Type | Method and Description |
---|---|
long |
getAbsoluteParentId()
The request id of the absolute parent of this request.
|
String |
getApplication()
Gets the application name associated with this request.
|
Cause |
getCause()
The cause that lead to the request being placed in a terminal state.
|
Calendar |
getCompletedTime()
The time that ESS finished all tasks associated with this request.
|
String |
getDeployedApplication()
Gets the physical J2EE application deployment name
associated with this request.
|
String |
getDescription()
Gets the description of this request.
|
String |
getDmsRID()
Gets the base RID of the DMS ExecutionContext associated with the
processing of this request.
|
String |
getECID()
The ECID of the DMS ExecutionContext associated with the processing
of this request.
|
long |
getElapsedMillis()
The elapsed milliseconds spent processing request.
|
Calendar |
getEndTime()
The time that processing of this request ended.
|
long |
getEnterpriseId()
The enterprise ID of the request.
|
ErrorType |
getErrorType()
Gets the error type for this request.
|
String |
getErrorWarningDetail()
The stack trace of error/warning occured while processing
this request, if any.
|
String |
getErrorWarningMessage()
The message associated with an error/warning occured while
processing this request.
|
Calendar |
getErrorWarningTime()
The time of error/warning occured while processing this request.
|
State |
getExecutableState()
The state of the request when the executable stage completed.
|
String |
getExecutableStatus()
Deprecated.
Replaced by
RequestDetail.getExecutableState() . |
int |
getExecutionAttempt()
The current execution attempt for this request.
|
JobSet.ExecutionMode |
getExecutionMode()
Gets the execution mode of a JobSet request.
|
Calendar |
getExpiration()
The time that the request will expire.
|
String |
getFlowId()
Gets the DMS FlowId associated with the processing of this request.
|
int |
getInstanceParentExecAttempt()
The value of execution attempt of the instance parent request when
this request was created.
|
long |
getInstanceParentId()
The request id of the instance parent of this request.
|
MetadataObjectId |
getJobDefn()
The job or job set definition identifier associated with this request.
|
String |
getJobDescription()
Gets the description of the job definition or job set specified for
this request.
|
String |
getJobDisplayName()
Gets the display name for job definition/ job set of this request.
|
MetadataObjectId |
getJobType()
The job type identifier associated with this request.
|
long |
getLastScheduleInstanceId()
The last Schedule instance request id associated with this request.
|
int |
getLastSubrequestSet()
The set number assigned to the last subrequest submitted by this
request during its current execution attempt.
|
String |
getLogicalClusterName()
Gets the logical cluster name associated with the request if any.
|
RequestParameters |
getParameters()
Gets all the parameters, including system properties,
associated with this request.
|
long |
getParent()
The request id of the immediate parent of this request.
|
int |
getParentExecAttempt()
The value of execution attempt of the immediate parent request when
this request was created.
|
int |
getPausedCount()
The number of times this request has been paused during its current
execution attempt.
|
HandlerStatus |
getPostProcessHandlerStatus()
The status of the post-processing stage for this request.
|
String |
getPostProcessMessage()
The action message returned by the post-processor for this request.
|
String |
getPostProcessStatus()
Deprecated.
Replaced by
RequestDetail.getPostProcessHandlerStatus() . |
HandlerStatus |
getPreProcessHandlerStatus()
The status of the pre-processing stage for this request.
|
String |
getPreProcessMessage()
The action message returned by the pre-processor for this request.
|
String |
getPreProcessStatus()
Deprecated.
Replaced by
RequestDetail.getPreProcessHandlerStatus() . |
State |
getPreviousState()
Gets the previous State for this request.
|
int |
getPriority()
Gets the request priority.
|
String |
getProcessGroup()
The process group of the request.
|
String |
getProcessingDispatcher()
The mid-tier instance name that dispatched the request.
|
String |
getProcessingProcessor()
The mid-tier instance name that processed the request.
|
MetadataObjectId |
getProcessingWorkAssignment()
The work assignment that was active on the request processor
when the request was processed.
|
MetadataObjectId |
getProcessingWorkshift()
The work shift that was active on the request processor
when the request was processed.
|
ProcessPhase |
getProcessPhase()
The process phase for this request.
|
String |
getProduct()
The product associated with the request.
|
String |
getRequestCategory()
The request category system property for this request.
|
Calendar |
getRequestedEndTime()
Gets the requested end time of the request.
|
Calendar |
getRequestedStartTime()
Gets the requested start time of the request.
|
long |
getRequestId()
Gets the request identifier associated with these details.
|
RequestMode |
getRequestMode()
Gets the request mode of request.
|
RequestType |
getRequestType()
Gets the request type of request.
|
int |
getRetriedCount()
The number of times this request has been retried.
|
String |
getRunAsUser()
Gets the RunAs user for the request.
|
Schedule |
getSchedule()
The schedule instance associated with this request.
|
MetadataObjectId |
getScheduleDefn()
The schedule definition identifier associated with this request.
|
Calendar |
getScheduledTime()
Gets the scheduled start time of the request.
|
Calendar |
getStartTime()
The time that processing of this request commenced.
|
State |
getState()
Gets the state for this request.
|
Calendar |
getStateChangeTime()
Gets the time the request State was last changed.
|
String |
getStepID()
The JobSet stepID for this request.
|
Calendar |
getSubmissionTime()
The time at which the request was submitted.
|
String |
getSubmitter()
Gets the user name who submitted the request.
|
String |
getSubmitterDmsECID()
Gets the ECID of the DMS context that was active at the time the
request was submitted.
|
String |
getSubmitterDmsRID()
Gets the RID of the DMS context that was active at the time the
request was submitted.
|
String |
getSubmitterFlowId()
Gets the FlowId of the DMS context that was active at the time the
request was submitted.
|
String |
getSubmitterGuid()
Gets the user GUID who submitted the request.
|
int |
getSubrequestSet()
The set number assigned to a subrequest when it was submitted.
|
String |
getType()
The execution type of this request.
|
Boolean |
isAsynchronous()
Indicates if the request is asynchronous.
|
boolean |
isAsyncRecoverable()
Indicates if the request is eligible for recovery using
RuntimeServiceMXBeanProxy.completeAsyncRequest . |
boolean |
isCancellable()
Indicates if the request is cancellable.
|
boolean |
isHoldable()
Indicates if the request is holdable.
|
boolean |
isRecoverable()
Indicates if the request is eligible for recovery using
RuntimeServiceMXBeanProxy.recoverRequest . |
boolean |
isTimedOut()
Indicates if the request has timed out.
|
String |
toDiagnosticString()
Creates a String representation of this object to aid diagnosis.
|
String |
toString() |
public long getRequestId()
public String getDescription()
public String getJobDisplayName()
public String getJobDescription()
public String getApplication()
public String getDeployedApplication()
public MetadataObjectId getJobDefn()
null
if
no metatdata as used for this request.public MetadataObjectId getJobType()
null
if
no metatdata as used for this request.public MetadataObjectId getScheduleDefn()
null
if no schedule
metadata was used for this request.public String getProcessingDispatcher()
null
if request not dispatched.public String getProcessingProcessor()
null
if request not processed.public MetadataObjectId getProcessingWorkAssignment()
null
if not applicable.public MetadataObjectId getProcessingWorkshift()
null
if not applicable.public int getExecutionAttempt()
public int getRetriedCount()
public boolean isCancellable()
This is based on the request type and current state of this request. This is only a hint, not a guarantee, as to whether or not this request can be cancelled.
true
if cancellable, or false
otherwise.public boolean isHoldable()
This is based on the request type and current state of this request. This is only a hint, not a guarantee, as to whether or not this request can be held.
true
if request can be held, false
otherwise.public String getSubmitter()
public String getSubmitterGuid()
public String getRunAsUser()
public Calendar getRequestedStartTime()
public Calendar getRequestedEndTime()
null
if an end time was not specified.public Calendar getScheduledTime()
public Cause getCause()
public long getParent()
public long getAbsoluteParentId()
The absolute parent id is the submitted request id. All child requests created on behalf of that request have the same absolute parent.
public long getInstanceParentId()
If a request is submitted without a Schedule the submitted request is considered the instance parent. The instance parent id value is the same as the absolute parent id value.
If a request is submitted with a Schedule, a new child request is created for each occurance of the Schedule and each child request represents an instance parent request.
public String getStepID()
This is primarily used for internal purposes. The request may or may not be a step within a JobSet, which can be indicated by the stepID value.
public State getState()
public ErrorType getErrorType()
public RequestType getRequestType()
public int getPriority()
public String getType()
JAVA_TYPE
for a Java job request
SQL_TYPE
for a SQL job request.
PROCESS_TYPE
for a process job request.
JOB_SET
for a JobSet request.
public String getRequestCategory()
public Schedule getSchedule()
null
if no schedule is
associated with the request.public RequestParameters getParameters()
public Calendar getSubmissionTime()
public Calendar getStartTime()
This value may never be set for some requests. For example, if a request was cancelled prior to it being executed, if the request expired prior to it being executed, if the submit validation failed for the request, and so on.
null
if request
processing has not started.public Calendar getEndTime()
This value may never be set for some requests. For example, if a request was cancelled prior to it being executed, if the request expired prior to it being executed, if the submit validation failed for the request, and so on.
null
if request
processing has not ended.public Calendar getCompletedTime()
ProcessPhase.Complete
.
This value will always be set once all tasks for the request has finished, even if the request was never executed for some reason.
null
if ESS has
not yet finished all work for this requests.public Calendar getExpiration()
null
if the
request never expires.public long getElapsedMillis()
public String getErrorWarningMessage()
public Calendar getErrorWarningTime()
public String getErrorWarningDetail()
public String getECID()
public String getProduct()
SystemProperty.PRODUCT
system property.public ProcessPhase getProcessPhase()
public long getLastScheduleInstanceId()
For a RequestType.RECUR_PARENT
or
RequestType.JOBSET_RECUR_PARENT
request, this value represents
the id of the instance parent request that was most recently created.
If the Schedule has ended, or been cancelled, this is the id of the
last instance request created for the Schedule.
For a RequestType.RECUR_CHILD
or
RequestType.JOBSET_RECUR_CHILD
request, this value represents
the id of the request for the previous instance of the Schedule.
The value is zero (0) for the first instance request of the Schedule.
public long getEnterpriseId()
public String getProcessGroup()
public Boolean isAsynchronous()
true
if the request is known to be asynchronous,
false
if the request is known to be synchronous,
null
if it has not yet been determined.public boolean isTimedOut()
true
if the request has timed out, false
otherwisepublic int getParentExecAttempt()
public int getInstanceParentExecAttempt()
public int getPausedCount()
public int getLastSubrequestSet()
If getPausedCount()
equals getLastSubrequestSet
, then
this request has paused since the last subrequests were submitted.
This value represents the set number assigned to those subrequests.
If getPausedCount
is not equal to getLastSubrequestSet
,
then one or more subrequests have been submitted since this request
last paused. This value represents the set number assigned to those
subrequests that are waiting for this request to pause.
public int getSubrequestSet()
This is meaningful only for a subrequest, in which case this value will be greater than zero. The value is zero for a request that is not a subrequest.
@Deprecated public String getPreProcessStatus()
RequestDetail.getPreProcessHandlerStatus()
.public HandlerStatus getPreProcessHandlerStatus()
null
if the pre-processor
has not completed.public String getPreProcessMessage()
@Deprecated public String getPostProcessStatus()
RequestDetail.getPostProcessHandlerStatus()
.public HandlerStatus getPostProcessHandlerStatus()
null
if the pre-processor
has not completed.public String getPostProcessMessage()
@Deprecated public String getExecutableStatus()
RequestDetail.getExecutableState()
.public State getExecutableState()
null
if the executable
stage has not completed.public boolean isAsyncRecoverable()
RuntimeServiceMXBeanProxy.completeAsyncRequest
.
This is based on the type and current status of this request. This is only a hint, not a guarantee, whether this request can be recovered in this fashion. Note that the status may have changed by the time the recovery operation is invoked
true
if the request is eligible for recovery,
false
otherwise.public boolean isRecoverable()
RuntimeServiceMXBeanProxy.recoverRequest
.
This is based on the type and current status of this request. This is only a hint, not a guarantee, whether this request can be recovered in this fashion. Note that the status may have changed by the time the recovery operation is invoked.
true
if the request is eligible for recovery,
or false
otherwise.public RequestMode getRequestMode()
public JobSet.ExecutionMode getExecutionMode()
public String getLogicalClusterName()
null
if there is none.public String getSubmitterDmsECID()
This value will be null if it is not meaningful for this request type. It will also be null if no DMS context was available at submission.
public String getSubmitterDmsRID()
This value will be null if it is not meaningful for this request type. It will also be null if no DMS context was available at submission.
public String getSubmitterFlowId()
This value will be null if it is not meaningful for this request type. It will also be null if no DMS context was available at submission, or no FlowId was present on that DMS context.
public String getDmsRID()
public String getFlowId()
public State getPreviousState()
public Calendar getStateChangeTime()
public String toDiagnosticString()