public interface Event
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.
EventListener
Modifier and Type | Field and Description |
---|---|
static String |
REQUEST_CANCELLED
Name of the system event published when request processing was
canceled.
|
static String |
REQUEST_ERROR
Name of the system event published when request processing completed
as an error.
|
static String |
REQUEST_ERROR_MANUAL_RECOVERY
Name of the system event published when manual recovery is needed
for a request.
|
static String |
REQUEST_EXPIRED
Name of the system event published when a request expired before
it was executed.
|
static String |
REQUEST_FINISHED
Name of system event published when processing of a Schedule
based parent request has finished.
|
static String |
REQUEST_INVALID
Name of the system event published when a request that was
pending validation has failed validation.
|
static String |
REQUEST_PAUSED
Name of the system event published when request execution has paused
to allow sub-requests to execute.
|
static String |
REQUEST_RETRY
Name of the system event published when processing of a request
resulted in an error and will be retried.
|
static String |
REQUEST_SUCCEEDED
Name of the system event published when request processing completed
as success.
|
static String |
REQUEST_TIMED_OUT
Name of the system event published when a request execution times out.
|
static String |
REQUEST_VALID
Name of the system event published when a request that was
pending validation has been successfully validated.
|
static String |
REQUEST_WARNING
Name of the system event published when request processing completed
as a warning.
|
static 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 String |
SYSTEM_TYPE
System event type.
|
static int |
UNLIMITED_TIME_TO_LIVE
Constant for unlimited event time-to-live.
|
static String |
WS_ASYNC_CALLBACK
The name of the system event published when an ESS WebService
asynchronous call has been made.
|
Modifier and Type | Method and Description |
---|---|
String |
getName()
Gets the name of the event.
|
Map |
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.
|
static final int UNLIMITED_TIME_TO_LIVE
static final String SYSTEM_TYPE
static final String REQUEST_SUCCEEDED
static final String REQUEST_WARNING
static final String REQUEST_ERROR
static final String REQUEST_CANCELLED
static final String REQUEST_EXPIRED
static final String REQUEST_FINISHED
static final String REQUEST_PAUSED
static final String REQUEST_VALID
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.
State
,
Constant Field Valuesstatic final String REQUEST_INVALID
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.
State
,
Constant Field Valuesstatic final String REQUEST_RETRY
ERROR
state.
See SystemProperty.RETRIES
.static final String SCHEDULE_END
static final String WS_ASYNC_CALLBACK
static final String REQUEST_ERROR_MANUAL_RECOVERY
ERROR_MANUAL_RECOVERY
state.State
,
Constant Field Valuesstatic final String REQUEST_TIMED_OUT
SystemProperty.ASYNC_REQUEST_TIMEOUT
.long getRequestId()
String getName()
String getType()
The Event.SYSTEM_TYPE
value is returned for a system event.
Map getProps()
int getTimeToLive()
UNLIMITED_TIME_TO_LIVE
(zero) means
unlimited.