Package oracle.as.scheduler

Interface Event

public interface Event
Provides lifecycle information about a request. Events are passed to an event listener and provide contextual information about the request.

System events are published by Oracle Enterprise Scheduler during the processing lifecycle of a request. Client applications can specify an event listener to receive system events for a submitted request.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    REQUEST_CANCELLED
    Name of the system event published when request processing was canceled.
    static final String
    REQUEST_ERROR
    Name of the system event published when request processing completed as an error.
    static final String
    REQUEST_ERROR_MANUAL_RECOVERY
    Name of the system event published when manual recovery is needed for a request.
    static final String
    REQUEST_EXPIRED
    Name of the system event published when a request expired before it was executed.
    static final String
    REQUEST_FINISHED
    Name of system event published when processing of a Schedule based parent request has finished.
    static final String
    REQUEST_INVALID
    Name of the system event published when a request that was pending validation has failed validation.
    static final String
    REQUEST_PAUSED
    Name of the system event published when request execution has paused to allow sub-requests to execute.
    static final String
    REQUEST_RETRY
    Name of the system event published when processing of a request resulted in an error and will be retried.
    static final String
    REQUEST_SUCCEEDED
    Name of the system event published when request processing completed as success.
    static final String
    REQUEST_TIMED_OUT
    Name of the system event published when a request execution times out.
    static final String
    REQUEST_VALID
    Name of the system event published when a request that was pending validation has been successfully validated.
    static final String
    REQUEST_WARNING
    Name of the system event published when request processing completed as a warning.
    static final String
    SCHEDULE_END
    Name of the system event published when the Schedule associated with a submitted (absolute parent) request has ended or the request has expired.
    static final String
    SYSTEM_TYPE
    System event type.
    static final int
    UNLIMITED_TIME_TO_LIVE
    Constant for unlimited event time-to-live.
    static final String
    WS_ASYNC_CALLBACK
    The name of the system event published when an ESS WebService asynchronous call has been made.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Gets the name of the event.
    Map<String,Object>
    getProps()
    Gets the properties associated with the event.
    long
    getRequestId()
    Gets the request identifier associated with this event.
    int
    getTimeToLive()
    Gets the time-to-live (TTL), in seconds, that the event should be retained.
    String
    getType()
    Gets the type of the event.

  • Field Details

    • UNLIMITED_TIME_TO_LIVE

      static final int UNLIMITED_TIME_TO_LIVE
      Constant for unlimited event time-to-live. A time-to-live value of zero means unlimited.
      See Also:

    • SYSTEM_TYPE

      static final String SYSTEM_TYPE
      System event type. System events are published by the Enterprise Scheduler system.
      See Also:

    • REQUEST_SUCCEEDED

      static final String REQUEST_SUCCEEDED
      Name of the system event published when request processing completed as success.
      See Also:

    • REQUEST_WARNING

      static final String REQUEST_WARNING
      Name of the system event published when request processing completed as a warning.
      See Also:

    • REQUEST_ERROR

      static final String REQUEST_ERROR
      Name of the system event published when request processing completed as an error.
      See Also:

    • REQUEST_CANCELLED

      static final String REQUEST_CANCELLED
      Name of the system event published when request processing was canceled.
      See Also:

    • REQUEST_EXPIRED

      static final String REQUEST_EXPIRED
      Name of the system event published when a request expired before it was executed.
      See Also:

    • REQUEST_FINISHED

      static final String REQUEST_FINISHED
      Name of system event published when processing of a Schedule based parent request has finished. The Schedule has ended (or the request expired) and all child instance requests are in a terminal state. This represents a terminal state event for the submitted (absolute parent) request.
      See Also:

    • REQUEST_PAUSED

      static final String REQUEST_PAUSED
      Name of the system event published when request execution has paused to allow sub-requests to execute.
      See Also:

    • REQUEST_VALID

      static final String REQUEST_VALID
      Name of the system event published when a request that was pending validation has been successfully validated.

      This event applies only to requests submitted using the Enterprise Scheduler PLSQL runtime package. Validation is done asychronously and a request is initially placed in PENDING_VALIDATION state. This event is published when the request has been successfully validated. The validated request is initially set to WAIT state.

      This event is not published for validation done for submission done via other interfaces such as RuntimeService.submitRequest. The validation is done as part of the sychronous submit operation and the request is never placed in PENDING_VALIDATION state.

      See Also:

    • REQUEST_INVALID

      static final String REQUEST_INVALID
      Name of the system event published when a request that was pending validation has failed validation. The request is considered to be invald.

      This event applies only to requests submitted using the Enterprise Scheduler PLSQL runtime package. Validation is done asychronously and a request is initially placed in PENDING_VALIDATION state. This event is published when validation is attempted for the request and fails. The request is set to VALIDATION_FAILED state.

      This event is not published for validation done for submission done via other interfaces such as RuntimeService.submitRequest. The validation is done as part of the sychronous submit operation and the request is never placed in PENDING_VALIDATION state.

      See Also:

    • REQUEST_RETRY

      static final String REQUEST_RETRY
      Name of the system event published when processing of a request resulted in an error and will be retried. Entrprise Scheduler will attempt to process the request again rather than setting it to ERROR state. See SystemProperty.RETRIES.
      See Also:

    • SCHEDULE_END

      static final String SCHEDULE_END
      Name of the system event published when the Schedule associated with a submitted (absolute parent) request has ended or the request has expired. No more child instance requests will be created, although there may still be child instance requests that have not yet been processed.
      See Also:

    • WS_ASYNC_CALLBACK

      static final String WS_ASYNC_CALLBACK
      The name of the system event published when an ESS WebService asynchronous call has been made.
      See Also:

    • REQUEST_ERROR_MANUAL_RECOVERY

      static final String REQUEST_ERROR_MANUAL_RECOVERY
      Name of the system event published when manual recovery is needed for a request. The request is set to ERROR_MANUAL_RECOVERY state.
      See Also:

    • REQUEST_TIMED_OUT

      static final String REQUEST_TIMED_OUT
      Name of the system event published when a request execution times out. See SystemProperty.ASYNC_REQUEST_TIMEOUT.
      See Also:

  • Method Details

    • getRequestId

      long getRequestId()
      Gets the request identifier associated with this event.
      Returns:
      the request identifier associated with this event, or zero if no specific requestt is associated with the event

    • getName

      String getName()
      Gets the name of the event.
      Returns:
      the event name

    • getType

      String getType()
      Gets the type of the event.

      The Event.SYSTEM_TYPE value is returned for a system event.

      Returns:
      the event type

    • getProps

      Map<String,Object> getProps()
      Gets the properties associated with the event.
      Returns:
      the event properties

    • getTimeToLive

      int getTimeToLive()
      Gets the time-to-live (TTL), in seconds, that the event should be retained. A value of UNLIMITED_TIME_TO_LIVE (zero) means unlimited.
      Returns:
      the event time-to-live, in seconds