Package oracle.as.scheduler

Class RequestDetail

java.lang.Object
oracle.as.scheduler.RequestDetail
All Implemented Interfaces:
Serializable
public class RequestDetail extends Object implements Serializable
Encapsulates the runtime data associated with a request.
See Also:

  • Method Details

    • getRequestId

      public long getRequestId()
      Gets the request identifier associated with these details.
      Returns:
      request identifier.

    • getDescription

      public String getDescription()
      Gets the description of this request.
      Returns:
      request description.

    • getJobDisplayName

      public String getJobDisplayName()
      Gets the display name for job definition/ job set of this request.
      Returns:
      job definition/job set display name.

    • getJobDescription

      public String getJobDescription()
      Gets the description of the job definition or job set specified for this request.
      Returns:
      job definition/job set description.

    • getApplication

      public String getApplication()
      Gets the application name associated with this request.
      Returns:
      the application name

    • getDeployedApplication

      public String getDeployedApplication()
      Gets the physical J2EE application deployment name associated with this request.
      Returns:
      the application name

    • getJobDefn

      public MetadataObjectId getJobDefn()
      The job or job set definition identifier associated with this request. A request submitted as an adhoc request might not have a job or job set metadata identifer.
      Returns:
      job or job set identifier. This will be null if no metatdata as used for this request.

    • getJobType

      public MetadataObjectId getJobType()
      The job type identifier associated with this request. A request submitted as an adhoc request might not have a job type metadata identifer.
      Returns:
      job type identifier. This will be null if no metatdata as used for this request.

    • getScheduleDefn

      public MetadataObjectId getScheduleDefn()
      The schedule definition identifier associated with this request.
      Returns:
      schedule identifier, or null if no schedule metadata was used for this request.

    • getProcessingDispatcher

      public String getProcessingDispatcher()
      The mid-tier instance name that dispatched the request.
      Returns:
      instance name, or null if request not dispatched.

    • getProcessingProcessor

      public String getProcessingProcessor()
      The mid-tier instance name that processed the request.
      Returns:
      instance name, or null if request not processed.

    • getProcessingWorkAssignment

      public MetadataObjectId getProcessingWorkAssignment()
      The work assignment that was active on the request processor when the request was processed.
      Returns:
      work assignment identifier, or null if not applicable.

    • getProcessingWorkshift

      public MetadataObjectId getProcessingWorkshift()
      The work shift that was active on the request processor when the request was processed.
      Returns:
      work shift identifier, or null if not applicable.

    • getExecutionAttempt

      public int getExecutionAttempt()
      The current execution attempt for this request. The first execution attempt is 1.
      Returns:
      current execution attempt

    • getRetriedCount

      public int getRetriedCount()
      The number of times this request has been retried.
      Returns:
      the number of times request has been retried.

    • isCancellable

      public boolean isCancellable()
      Indicates if the request is cancellable.

      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.

      Returns:
      true if cancellable, or false otherwise.

    • isGracefulCancellable

      public boolean isGracefulCancellable()
      Indicates if a graceful cancel is allowed for the request in its current condition.

      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.

      Returns:
      true if cancellable, or false otherwise.

    • isHoldable

      public boolean isHoldable()
      Indicates if the request is holdable.

      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.

      Returns:
      true if request can be held, false otherwise.

    • getSubmitter

      public String getSubmitter()
      Gets the user name who submitted the request.
      Returns:
      the user name.

    • getSubmitterGuid

      public String getSubmitterGuid()
      Gets the user GUID who submitted the request.
      Returns:
      the user guid.

    • getRunAsUser

      public String getRunAsUser()
      Gets the RunAs user for the request.
      Returns:
      the RunAs user for the request

    • getRequestedStartTime

      public Calendar getRequestedStartTime()
      Gets the requested start time of the request.
      Returns:
      time at which the request was to start.

    • getRequestedEndTime

      public Calendar getRequestedEndTime()
      Gets the requested end time of the request.
      Returns:
      time at which request was to end. This will be null if an end time was not specified.

    • getScheduledTime

      public Calendar getScheduledTime()
      Gets the scheduled start time of the request.
      Returns:
      time at which request is scheduled to run.

    • getCause

      public Cause getCause()
      The cause that lead to the request being placed in a terminal state.
      Returns:
      the cause associated with a request's terminal state.

    • getParent

      public long getParent()
      The request id of the immediate parent of this request. If the request has no immediate parent, the value returned by this method as not meaningful.
      Returns:
      the parent id for this request.

    • getAbsoluteParentId

      public long getAbsoluteParentId()
      The request id of the absolute parent of this request.

      The absolute parent id is the submitted request id. All child requests created on behalf of that request have the same absolute parent.

      Returns:
      absolute parent id for this request.

    • getInstanceParentId

      public long getInstanceParentId()
      The request id of the instance parent of this request. Any child requests of request tree of the instance parent request have he same instance parent id. For example, any sub-requests or JobSet step requests, and any of their children, will have the same instance parent id.

      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.

      Returns:
      instance parent id for this request.

    • getStepID

      public String getStepID()
      The JobSet stepID for this request.

      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.

      Returns:
      the step ID for this request.

    • getState

      public State getState()
      Gets the state for this request.
      Returns:
      the request state.

    • getErrorType

      public ErrorType getErrorType()
      Gets the error type for this request.
      Returns:
      error type

    • getRequestType

      public RequestType getRequestType()
      Gets the request type of request.
      Returns:
      the request type.

    • getPriority

      public int getPriority()
      Gets the request priority. The priorty range is [0..9] with 0 as the lowest priority and 9 as the highest priority.
      Returns:
      the request priority.

    • getType

      public String getType()
      The execution type of this request. This method returns one of the following string values to represent the execution type.
      • 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.
      Returns:
      the execution type represented as a string.

    • getRequestCategory

      public String getRequestCategory()
      The request category system property for this request.
      Returns:
      the request category.

    • getSchedule

      public Schedule getSchedule()
      The schedule instance associated with this request.
      Returns:
      the schedule instance, or null if no schedule is associated with the request.

    • getParameters

      public RequestParameters getParameters()
      Gets all the parameters, including system properties, associated with this request.
      Returns:
      the request parameters.

    • getSubmissionTime

      public Calendar getSubmissionTime()
      The time at which the request was submitted.
      Returns:
      the submission time.

    • getStartTime

      public Calendar getStartTime()
      The time that processing of this request commenced.

      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.

      Returns:
      the time request processing started, or null if request processing has not started.

    • getEndTime

      public Calendar getEndTime()
      The time that processing of this request ended.

      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.

      Returns:
      the time that processing ended, or null if request processing has not ended.

    • getCompletedTime

      public Calendar getCompletedTime()
      The time that ESS finished all tasks associated with this request. This represents the time that the request process phase was set to 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.

      Returns:
      the time ESS finished the request, or null if ESS has not yet finished all work for this requests.

    • getExpiration

      public Calendar getExpiration()
      The time that the request will expire. A request may not expire.
      Returns:
      the time the request expires, or null if the request never expires.

    • getElapsedMillis

      public long getElapsedMillis()
      The elapsed milliseconds spent processing request.
      Returns:
      elapsed run time for request. This will be zero (0L) if the request processing not started.

    • getErrorWarningMessage

      public String getErrorWarningMessage()
      The message associated with an error/warning occured while processing this request.
      Returns:
      the value of the error/warning message.

    • getErrorWarningTime

      public Calendar getErrorWarningTime()
      The time of error/warning occured while processing this request.
      Returns:
      the time of occurance of error/warning

    • getErrorWarningDetail

      public String getErrorWarningDetail()
      The stack trace of error/warning occured while processing this request, if any.
      Returns:
      the detailed content of error/warning

    • getECID

      public String getECID()
      The ECID of the DMS ExecutionContext associated with the processing of this request.
      Returns:
      the string representation of the ECID

    • getProduct

      public String getProduct()
      The product associated with the request. This corresponds to the value of SystemProperty.PRODUCT system property.
      Returns:
      the product set in the request, or null if none was speciifed.

    • getProcessPhase

      public ProcessPhase getProcessPhase()
      The process phase for this request.
      Returns:
      process phase

    • getLastScheduleInstanceId

      public long getLastScheduleInstanceId()
      The last Schedule instance request id associated with this request. This value is meaningful only for certain request types. For other request types it is meaningless and will be zero (0).

      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.

      Returns:
      the id of last schedule instance request

    • getEnterpriseId

      public long getEnterpriseId()
      The enterprise ID of the request. It is determined by the enterprise ID of the submitter of the request.
      Returns:
      the enterprise ID of the submitter of the request

    • getProcessGroup

      public String getProcessGroup()
      The process group of the request.

    • isAsynchronous

      public Boolean isAsynchronous()
      Indicates if the request is asynchronous.
      Returns:
      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.

    • isTimedOut

      public boolean isTimedOut()
      Indicates if the request has timed out.

      See SystemProperty.ASYNC_REQUEST_TIMEOUT.

      Returns:
      true if the request has timed out, false otherwise

    • getParentExecAttempt

      public int getParentExecAttempt()
      The value of execution attempt of the immediate parent request when this request was created. This value will be zero if this request does not have an immediate parent.
      Returns:
      the immediate parent's execution attempt

    • getInstanceParentExecAttempt

      public int getInstanceParentExecAttempt()
      The value of execution attempt of the instance parent request when this request was created. This value will be zero if this request does not have an instance parent.
      Returns:
      the instance parent's execution attempt

    • getPausedCount

      public int getPausedCount()
      The number of times this request has been paused during its current execution attempt. This value is incremented when a request has been paused to allow to allow sub-requests to run. This value will be zero if this request has never been paused.
      Returns:
      the paused count for this request

    • getLastSubrequestSet

      public int getLastSubrequestSet()
      The set number assigned to the last subrequest submitted by this request during its current execution attempt. This value will be zero if no subrequests have been submitted by this request.

      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.

      Returns:
      the set number assigned to the last submitted subrequest

    • getSubrequestSet

      public int getSubrequestSet()
      The set number assigned to a subrequest when it was submitted. If a parent submits multiple subrequests before it pauses all those subrequests will have the same set number.

      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.

      Returns:
      the set number assigned to a subrequest

    • getPreProcessStatus

      @Deprecated public String getPreProcessStatus()
      Deprecated.
      Replaced by getPreProcessHandlerStatus().
      The status returned by the pre-processor for this request.
      Returns:
      the pre-processor status

    • getPreProcessHandlerStatus

      public HandlerStatus getPreProcessHandlerStatus()
      The status of the pre-processing stage for this request.
      Returns:
      the pre-processor status or null if the pre-processor has not completed.

    • getPreProcessMessage

      public String getPreProcessMessage()
      The action message returned by the pre-processor for this request.
      Returns:
      the pre-processor action message

    • getPostProcessStatus

      @Deprecated public String getPostProcessStatus()
      Deprecated.
      Replaced by getPostProcessHandlerStatus().
      The status returned by the post-processor for this request.
      Returns:
      the post-processor status

    • getPostProcessHandlerStatus

      public HandlerStatus getPostProcessHandlerStatus()
      The status of the post-processing stage for this request.
      Returns:
      the post-processor status or null if the pre-processor has not completed.

    • getPostProcessMessage

      public String getPostProcessMessage()
      The action message returned by the post-processor for this request.
      Returns:
      the post-processor action message

    • getExecutableStatus

      @Deprecated public String getExecutableStatus()
      Deprecated.
      Replaced by getExecutableState().
      The status of the request when the executable stage completed.
      Returns:
      the executable stage state

    • getExecutableState

      public State getExecutableState()
      The state of the request when the executable stage completed.
      Returns:
      the executable stage state or null if the executable stage has not completed.

    • isAsyncRecoverable

      public boolean isAsyncRecoverable()
      Indicates if the request is eligible for recovery using 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

      Returns:
      true if the request is eligible for recovery, false otherwise.

    • isRecoverable

      public boolean isRecoverable()
      Indicates if the request is eligible for recovery using 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.

      Returns:
      true if the request is eligible for recovery, or false otherwise.

    • getRequestMode

      public RequestMode getRequestMode()
      Gets the request mode of request.
      Returns:
      the request mode.

    • getExecutionMode

      public JobSet.ExecutionMode getExecutionMode()
      Gets the execution mode of a JobSet request.
      Returns:
      JobSet execution mode.

    • getLogicalClusterName

      public String getLogicalClusterName()
      Gets the logical cluster name associated with the request if any.
      Returns:
      returns the logical cluster name of the request or null if there is none.

    • getAsyncExecutionStatus

      public String getAsyncExecutionStatus()
      Returns a string indicating whether the remote executable for an asynchronous job has completed.

      Possible values are "TerminalExecutionComplete": The job has notified the scheduler of its completion and the request is in a terminal state. This is the typical scenario for a completed asynchronous job request.

      "TerminalLateExecutionComplete": The job request has been forcibly placed in a terminal state, but the callback notification from the remote executable occurred later. This scenario may happen when the notification occurs after the request has been auto-force cancelled.

      "TerminalUnknown": The job request has been forcibly placed in a terminal state, but no notification has been received from the remote executable. It is possible that the remote service is still running.

      "NonTerminal": The job request is not yet in a terminal state.

      "NotAsynchronous": The job request is not asynchronous.

      Returns:
      A string indicating the completion status of the remote executable for an asynchronous job.

    • getSubmitterDmsECID

      public String getSubmitterDmsECID()
      Gets the ECID of the DMS context that was active at the time the request was submitted. This is meaningly only for an absolute parent request or a sub-request.

      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.

      Returns:
      the string representation of the DMS ECID, or null if none

    • getSubmitterDmsRID

      public String getSubmitterDmsRID()
      Gets the RID of the DMS context that was active at the time the request was submitted. This is meaningly only for an absolute parent request or a sub-request.

      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.

      Returns:
      the string representation of the DMS RID, or null if none

    • getSubmitterFlowId

      public String getSubmitterFlowId()
      Gets the FlowId of the DMS context that was active at the time the request was submitted. This is meaningly only for an absolute parent request or a sub-request.

      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.

      Returns:
      the string representation of the FlowId, or null if none

    • getDmsRID

      public String getDmsRID()
      Gets the base RID of the DMS ExecutionContext associated with the processing of this request. Usually the request processing is done using a context that is some descendant of this base RID.
      Returns:
      the string representation of the DMS RID, or null if none

    • getFlowId

      public String getFlowId()
      Gets the DMS FlowId associated with the processing of this request.
      Returns:
      the FlowId for this request

    • getPreviousState

      public State getPreviousState()
      Gets the previous State for this request. This might be null if the request has never changed state.
      Returns:
      the previouts request State.

    • getStateChangeTime

      public Calendar getStateChangeTime()
      Gets the time the request State was last changed.
      Returns:
      the time of last state change.

    • toDiagnosticString

      public String toDiagnosticString()
      Creates a String representation of this object to aid diagnosis. This is used in ESS DFW diagnostic dumps.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      public String toString(Locale locale)