Package | Description |
---|---|
oracle.as.scheduler |
Enterprise Scheduler API interfaces and classes, including
RuntimeService and MetadataService.
|
oracle.as.scheduler.async |
Classes for use by asynchronous jobs.
|
oracle.as.scheduler.request |
Request Log and Output Content API.
|
oracle.as.scheduler.substitution |
Support for substitution on environment, configuration, execution context, and parameters.
|
Modifier and Type | Class and Description |
---|---|
class |
RollbackException
Thrown when the a transactional operation is invoked and the
transaction has been marked as rollback only.
|
class |
RuntimeIllegalOperationException
Exception that indicates an operation on a request is illegal.
|
class |
RuntimeServiceAccessControlException
Exception used by the
RuntimeService to indicate permission
or security related errors. |
class |
RuntimeStoreAccessException
Exception used to indicate an error accessing or performing an operation
on the Enterprise Scheduler runtime store.
|
class |
RuntimeStoreLockException
Exception used to indicate that an Enterprise Scheduler runtime store
lock could not be obtained.
|
Modifier and Type | Method and Description |
---|---|
void |
RuntimeService.cancelRequest(RuntimeServiceHandle handle,
long requestId)
Cancels the processing of a request that is not in a terminal state.
|
Map |
RuntimeService.checkDetailedPermissions(RuntimeServiceHandle handle,
long[] requestIds,
RuntimeDataPermission.Action[] privileges)
Check whether the current user has privilegs on the input requests
identified by a list of request ids.
|
Map |
RuntimeService.checkRequestPrivilege(RuntimeServiceHandle handle,
long[] requestIds,
RuntimeDataPermission.Action[] privileges)
Check whether the current user has privilegs on the input requests
identified by a list of request ids.
|
void |
RuntimeService.close(RuntimeServiceHandle handle)
Closes the runtime handle.
|
void |
RuntimeService.close(RuntimeServiceHandle handle,
boolean abort)
Closes the runtime handle.
|
void |
RuntimeService.closeContent(RuntimeServiceHandle handle,
ContentHandle contentHandle)
Closes the previously opened log or output content and releases
the handle.
|
void |
RuntimeService.deleteOutputContent(RequestExecutionContext context,
List contentNames)
Deletes the list of request output content from the content store,
if it exists.
|
void |
RuntimeService.deleteRequest(RuntimeServiceHandle handle,
long requestId)
Marks a submitted request as deleted.
|
ApplicationConfig |
RuntimeService.getApplicationConfig(RuntimeServiceHandle handle)
Gets the configuration for this application as specified in
ess-config.xml and customizations thereof, including default values.
|
byte[] |
RuntimeService.getBinaryContent(RuntimeServiceHandle handle,
ContentHandle contentHandle,
int maxBytes)
Gets at most
maxBytes bytes from the binary content. |
RequestExecutionContext |
AsyncRequestBeanInterface.getContextFromString(String string)
Converts the string representation of a RequestExecutionContext
into RequestExecutionContext object.
|
ExternalJobStatus |
RuntimeService.getExternalJobStatus(RuntimeServiceHandle handle,
long requestId)
Determines the general status of the external job for a request.
|
FailedExecutionResult |
RuntimeService.getFailedExecutionResult(RuntimeServiceHandle handle,
long requestId)
Retrieves the result of the last failed execution attempt for the
specified request which has been retried at least once.
|
ContentDetail |
RuntimeService.getLogContentDetail(RuntimeServiceHandle handle,
long requestId)
Gets the log content detail for the request.
|
Set |
RuntimeService.getLogicalApplicationNames(RuntimeServiceHandle handle)
Get a list of all logical application names for ESS hosted
applications currently deployed.
|
String[] |
RuntimeService.getLogLines(RuntimeServiceHandle handle,
ContentHandle contentHandle,
int maxLines)
Gets at most
maxLines lines from the request log,
continuing from the last call to this method. |
List |
RuntimeService.getOutputContentDetail(RuntimeServiceHandle handle,
long requestId)
Gets details for all output content for the request.
|
ContentDetail |
RuntimeService.getOutputContentDetail(RuntimeServiceHandle handle,
long requestId,
String contentName)
Gets details for the specified output content for the request.
|
RequestDetail |
RuntimeService.getRequestDetail(RuntimeServiceHandle handle,
long requestId)
Retrieves runtime details of the specified request.
|
RequestDetail |
RuntimeService.getRequestDetail(RuntimeServiceHandle handle,
long requestId,
boolean includeTranslation)
Retrieves runtime details of the specified request.
|
RequestDetail |
RuntimeService.getRequestDetailBasic(RuntimeServiceHandle handle,
long requestId)
Retrieves basic runtime details of the specified request.
|
RequestDetail[] |
RuntimeService.getRequestDetails(RuntimeServiceHandle handle,
long[] requestIds)
Retrieves basic runtime details of the specified requests.
|
RequestDetail[] |
RuntimeService.getRequestDetails(RuntimeServiceHandle handle,
long[] requestIds,
boolean includeTranslation)
Retrieves basic runtime details of the specified requests.
|
Object |
RuntimeService.getRequestParameter(RuntimeServiceHandle handle,
long requestId,
String name)
Retrieves the value of a request parameter.
|
Enumeration |
RuntimeService.getRequests(RuntimeServiceHandle handle,
long requestId)
Gets an enumeration of the request identifiers for those requests
that have the specified request as their immediate parent and are
associated with the current execution attempt of that parent request.
|
State |
RuntimeService.getRequestState(RuntimeServiceHandle handle,
long requestId)
Retrieves the current state of the specified request.
|
char[] |
RuntimeService.getTextContent(RuntimeServiceHandle handle,
ContentHandle contentHandle,
int maxChars)
Gets at most
maxChars lines from the log or output text content. |
void |
RuntimeService.holdRequest(RuntimeServiceHandle handle,
long requestId)
Withholds further processing of a request that is in
WAIT
or READY state. |
boolean |
RuntimeService.isStandaloneEnv(RuntimeServiceHandle handle)
Indicates whether the environment is standalone or fusion.
|
void |
RuntimeService.lockRequest(RuntimeServiceHandle handle,
long requestId)
Acquires a lock for the given request.
|
void |
RuntimeService.logContent(RequestExecutionContext context,
Level level,
String message)
Logs a message to the request log in the content store
during job execution.
|
RuntimeServiceHandle |
RuntimeService.open()
Allocates system resources for performing subsequent runtime
operations.
|
RuntimeServiceHandle |
RuntimeService.open(Locale locale)
Allocates system resources for performing subsequent runtime
operations.
|
ContentHandle |
RuntimeService.openLogContent(RuntimeServiceHandle handle,
long requestId)
Opens the request log to retrieve the log data.
|
ContentHandle |
RuntimeService.openOutputContent(RuntimeServiceHandle handle,
long requestId,
String contentName)
Opens the specified request output to retrieve the output data.
|
ContentHandle |
RuntimeService.openOutputContent(RuntimeServiceHandle handle,
RequestExecutionContext context,
String contentName,
ContentType contentType,
EnumSet options)
Opens the named request output during job execution.
|
boolean |
RuntimeService.outputContentExists(RequestExecutionContext context,
String contentName)
Determines if the output content exists for the request.
|
Enumeration |
RuntimeService.queryRequests(RuntimeServiceHandle handle,
Filter filter,
RuntimeService.QueryField orderBy,
boolean ascending)
Retrieves an enumeration of the request identifers for all requests
whose attribute and system properties match those specified by the
query parameters
|
void |
RuntimeService.releaseRequest(RuntimeServiceHandle handle,
long requestId)
Releases a request from the
HOLD state. |
void |
RuntimeService.replaceSchedule(RuntimeServiceHandle handle,
long requestId,
MetadataObjectId scheduleId)
Replace the current schedule for a request that has already been
submitted.
|
void |
RuntimeService.replaceSchedule(RuntimeServiceHandle handle,
long requestId,
MetadataObjectId scheduleId,
Schedule schedule,
Calendar start,
Calendar end)
Replace the current schedule for a request that has already been
submitted with a schedule.
|
void |
RuntimeService.replaceSchedule(RuntimeServiceHandle handle,
long requestId,
Schedule schedule)
Replace the current schedule for a request that has already been
submitted.
|
void |
RuntimeService.setRequestParameter(RuntimeServiceHandle handle,
long requestId,
String name,
Object value)
Sets the value of a request parameter for a specified request.
|
void |
AsyncRequestBeanInterface.setRequestStatus(RequestExecutionContext context,
AsyncStatus status,
String statusMessage)
Set the status of an ESS asynchronous java job.
|
void |
AsyncRequestBeanRemote.setRequestStatus(String context,
String status,
String statusMessage)
Set the status of an ESS asynchronous java job.
|
long |
RuntimeService.submitRequest(RuntimeServiceHandle handle,
RequestExecutionContext context,
String description,
MetadataObjectId definition,
RequestParameters parameters)
Submits a sub-request.
|
long |
RuntimeService.submitRequest(RuntimeServiceHandle handle,
String description,
JobType.ExecutionType type,
Schedule schedule,
oracle.as.scheduler.Trigger trigger,
Calendar start,
Calendar end,
RequestParameters parameters)
Adhoc job request submission using specified Schedule.
|
long |
RuntimeService.submitRequest(RuntimeServiceHandle handle,
String description,
MetadataObjectId definition,
Calendar start,
RequestParameters parameters)
Creates a new job request using metadata definition of the job
to run once on a specific time.
|
long |
RuntimeService.submitRequest(RuntimeServiceHandle handle,
String description,
MetadataObjectId definition,
MetadataObjectId schedule,
MetadataObjectId trigger,
Calendar start,
Calendar end,
RequestParameters parameters)
Creates a new job request using metadata definitions of the job,
and schedule.
|
long |
RuntimeService.submitRequest(RuntimeServiceHandle handle,
String description,
MetadataObjectId definition,
Schedule schedule,
oracle.as.scheduler.Trigger trigger,
Calendar start,
Calendar end,
RequestParameters parameters)
Adhoc job request submission using job definition from metadata.
|
void |
RuntimeService.updateRequestParameter(RuntimeServiceHandle handle,
long requestId,
String name,
Object value)
Updates the value of a request parameter for a specified request.
|
void |
RuntimeService.updateRequestStartEnd(RuntimeServiceHandle handle,
long requestId,
Calendar start,
Calendar end)
Replace the start and end time for a request that has already
been submitted.
|
void |
RuntimeService.writeContent(ContentHandle contentHandle,
byte[] bytes)
Appends the bytes to the output content during job execution.
|
void |
RuntimeService.writeContent(ContentHandle contentHandle,
char[] chars)
Appends the characters to the output content during job execution.
|
void |
RuntimeService.writeContent(ContentHandle contentHandle,
String message)
Appends the string to the output content during job execution.
|
void |
RuntimeService.writelnContent(ContentHandle contentHandle,
String message)
Appends the string followed by a line feed character to the
output content during job execution.
|
Modifier and Type | Method and Description |
---|---|
void |
AsyncHelper.onBizError(String errorMsg) |
void |
RemoteAsyncHelper.onBizError(String errorMsg) |
void |
AsyncHelper.onCancel() |
void |
RemoteAsyncHelper.onCancel() |
void |
AsyncHelper.onError(String errorMsg) |
void |
RemoteAsyncHelper.onError(String errorMsg) |
void |
AsyncHelper.onPause(String pausedState) |
void |
RemoteAsyncHelper.onPause(String pausedState) |
void |
AsyncHelper.onSuccess() |
void |
RemoteAsyncHelper.onSuccess() |
void |
AsyncHelper.onWarning(String warningMsg) |
void |
RemoteAsyncHelper.onWarning(String warningMsg) |
void |
AsyncHelper.setRequestStatus(AsyncStatus status,
String statusMessage) |
void |
RemoteAsyncHelper.setRequestStatus(AsyncStatus status,
String statusMessage) |
Modifier and Type | Method and Description |
---|---|
void |
RemoteContentHelper.closeOutputContent(ContentHandle contentHandle)
Closes the content associated with the given content handle.
|
void |
RemoteContentHelper.deleteOutputContent(List contentNames)
Deletes the list of request output content from the content store,
if it exists.
|
void |
OutputContentHelper.deleteOutputContent(List contentNames)
Deletes the output content from the content store for the request.
|
void |
RemoteContentHelper.deleteOutputContent(String contentName)
Deletes the request output content from the content store,
if it exists.
|
byte[] |
RemoteContentHelper.getBinaryContent(ContentHandle contentHandle,
int maxBytes)
Gets at most
maxBytes bytes from the binary content. |
List |
RemoteContentHelper.getOutputContentDetail()
Gets details for all output content for the request.
|
ContentDetail |
RemoteContentHelper.getOutputContentDetail(String contentName)
Gets details for the specified output content for the request.
|
static OutputContentHelper |
ContentFactory.getOutputContentHelper(long requestId)
Gets the helper for creating output content for requests with
Standard or Extended request mode.
|
static OutputContentHelper |
ContentFactory.getOutputContentHelper(long requestId,
RuntimeServiceHandle rsh)
Gets the helper for creating output content for requests with
Standard or Extended request mode.
|
static RequestLogger |
ContentFactory.getRequestLogger(long requestId)
Gets the request logger for the specified request, which logs
to the ESS content store.
|
static RequestOutput |
ContentFactory.getRequestOutput(RuntimeServiceHandle rsh,
long requestId,
ContentType contentType,
String contentName)
Retrieves the request output and creates the output content in the
ESS content store for the request.
|
char[] |
RemoteContentHelper.getTextContent(ContentHandle contentHandle,
int maxChars)
Gets at most
maxChars characters from the text output content. |
void |
RemoteContentHelper.log(Level level,
String message)
Logs the message at the given level.
|
ContentHandle |
RemoteContentHelper.openOutputContent(RuntimeServiceHandle runtimeHandle,
String contentName,
ContentType contentType,
EnumSet options)
Opens output content for read or write.
|
boolean |
RemoteContentHelper.outputContentExists(String contentName)
Determines if the output content exists for the request.
|
boolean |
OutputContentHelper.outputContentExists(String contentName)
Checks whether the specified output content exists in the content store
for the request.
|
List |
OutputContentHelper.queryOutputContent()
Gets the detailed information for all existing output content in the
content store.
|
ContentDetail |
OutputContentHelper.queryOutputContent(String contentName)
Gets the detailed information for the output content in the
content store, if it exists.
|
void |
RequestOutput.write(byte[] bytes)
Appends the bytes to the binary output content.
|
void |
RequestOutput.write(byte[] bytes,
int offset,
int length)
Appends the bytes to the binary output content.
|
void |
RequestOutput.write(char[] chars)
Appends the characters to the text output content.
|
void |
RequestOutput.write(char[] chars,
int offset,
int length)
Appends the charactes to the text output content.
|
void |
RemoteContentHelper.write(ContentHandle contentHandle,
byte[] data)
Appends the bytes to the output content during job execution.
|
void |
RemoteContentHelper.write(ContentHandle contentHandle,
char[] data)
Appends the characters to the output content during job execution.
|
void |
RemoteContentHelper.write(ContentHandle contentHandle,
String data)
Appends the string to the output content during job execution.
|
void |
RequestOutput.write(String str)
Appends the String to the text output content.
|
void |
RequestOutput.write(String str,
int offset,
int length)
Appends the String to the text output content.
|
void |
RemoteContentHelper.writeln(ContentHandle contentHandle,
String data)
Appends the string followed by a line feed character to the
output content during job execution.
|
void |
RequestOutput.writeln(String str)
Appends the String to the text output content, followed by a
line feed character.
|
Modifier and Type | Method and Description |
---|---|
String |
CcwSubstitutionManager.getSubstitutedValue(long requestId,
String paramName,
String unsubVal) |
static Substitutor |
SubstitutorFactory.getSubstitutor(RequestExecutionContext ctxt,
RequestParameters params)
Create the standard
Substitutor . |
static Substitutor |
SubstitutorFactory.getSubstitutorWithAltEnv(RequestExecutionContext ctxt,
RequestParameters params,
Map altAppEnv)
Create the standard
Substitutor . |