Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service
11g Release 1 (11.1.1.6.3)
E26229-05
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.as.scheduler.management
Interface RuntimeServiceMXBeanProxy

public interface RuntimeServiceMXBeanProxy

Remote management interface for the runtime service.

This interface is identical to RuntimeServiceMXBean except that these methods additionally throw java.io.IOEXception.

Field Summary
static java.lang.String s_mbeanObjectNameString
           
static oracle.as.scheduler.management.ProtocolVersion s_protocolVersion
          The local version information for this interface
static java.lang.String s_shortName
           

 

Method Summary
 void addBinding(oracle.as.scheduler.management.Binding binding)
          Adds a new binding, which binds a work assignment to a processor.
 void addBindings(java.util.List<oracle.as.scheduler.management.Binding> bindings)
          Adds a list of new bindings.
 void cancelRequest(long requestId)
          Cancels the processing of a request that is not in a terminal state.
 void changeBindingMode(MetadataObjectId bindingName, boolean isExclusive)
          Changes the mode of an existing binding.
 void changeRequestPriority(long requestId, int priority)
          Changes the priority for a submitted request that has not yet started to run.
 java.util.Map<java.lang.Long,java.lang.Boolean> checkRequestPrivilege(long[] requestIds, java.lang.String[] privileges)
          Check whether the current user has privilegs on the input requests identified by a list of request ids.
 void cleanExecutionGroup(java.lang.String domainName, java.lang.String clusterName)
          Cleans up artifacts from an ESS execution group.
 void close(oracle.as.scheduler.management.QueryResultHandle handle)
          Closes the handle returned by executeQueryRequests.
 void closeContent(ContentHandle ch)
          Close the content handle from previous open call
 void completeAsyncRequest(long requestId, oracle.as.scheduler.async.AsyncStatus status, java.lang.String statusMessage)
          Complete an asynchronous request with the given status.
 void deleteRequest(long requestId)
          Marks a request for deletion.
 oracle.as.scheduler.management.QueryResultHandle executeQueryRequests(Filter filter, RuntimeService.QueryField orderBy, boolean ascending)
          Query requests whose attributes and properties match those specified by the fields in the filter.
 oracle.as.scheduler.management.QueryResultHandle executeQueryRequests(Filter filter, RuntimeService.QueryField orderBy, boolean ascending, boolean includeProcessGroup)
          Query requests whose attributes and properties match those specified by the fields in the filter.
 RequestDetail[] fetchQueryResults(oracle.as.scheduler.management.QueryResultHandle handle)
          Retrieves request details for the requests that satisified the query performed by executeQueryRequests.
 RequestDetail[] fetchQueryResults(oracle.as.scheduler.management.QueryResultHandle handle, int maxRows)
          Retrieves request details for the requests that satisified the query performed by executeQueryRequests.
 java.util.List<oracle.as.scheduler.management.AppRegistrationInfo> getApplicationsInfo()
          Retrieve application registration information for all applications in all servers for all process groups in this isolation group.
 java.util.List<oracle.as.scheduler.management.AppRegistrationInfo> getApplicationsInfo(boolean includeEssApp)
          Retrieve application registration information for all applications in all servers for all process groups in this isolation group.
 java.util.List<oracle.as.scheduler.management.AsyncThrottle> getAsyncLimits(WorkAssignment workAssignment)
          Gets the async limits for all workshifts of the given work assignment.
 java.util.List<oracle.as.scheduler.management.AsyncThrottle> getAsyncThrottle(MetadataObjectId waId)
          Deprecated. Async limits are now associated with the workshift only.
 oracle.as.scheduler.management.AsyncThrottle getAsyncThrottle(MetadataObjectId waId, MetadataObjectId wshiftId)
          Deprecated. 
 oracle.as.scheduler.management.AsyncThrottle getAsyncThrottleForWorkshift(MetadataObjectId wshiftId)
          Deprecated. 
 byte[] getBinaryContent(ContentHandle handle, int maxBytes)
          Gets at most maxBytes bytes from the binary content.
 java.util.List<oracle.as.scheduler.management.Binding> getBindings()
          Gets the processor bindings.
 long[] getBlockedRequests(long requestId)
          Returns a list of request identifiers that are blocked by the given request.
 long[] getBlockingRequests(long requestId)
          Returns a list of request identifiers that are blocking the given request.
 long[] getExecutingRequests()
          Retrieve the requests currently executing on this instance.
 java.util.List<FailedExecutionResult> getFailedExecutionHistory(long requestId)
          Retrieves all failed execution attempts for a request.
 java.util.List<oracle.as.scheduler.management.InactiveBinding> getInactiveBindings()
          Gets the inactive bindings for the ESS instance.
 FailedExecutionResult getLastFailedExecution(long requestId)
          Gets information on the last failed execution attempt for a request.
 ContentDetail getLogContentDetail(long requestId)
          Gets details for log content for the request.
 java.lang.String[] getLogLines(ContentHandle ch, int maxLines)
          Gets the lines from the log for a specific request.
 java.util.List<ContentDetail> getOutputContentDetail(long requestId)
          Gets details for output content for the request.
 ContentDetail getOutputContentDetail(long requestId, java.lang.String fileName)
          Gets the output content detail of a file for a request .
 oracle.as.scheduler.management.ProtocolVersion getProtocolVersion()
          Returns remote version information for this interface
 long getQueryRequestsCount(oracle.as.scheduler.management.QueryResultHandle handle)
          Returns return the number of requests that satisifed the query performed by executeQueryRequests.
 RequestDetail getRequestDetail(long requestId)
          Gets the runtime details of the specified request.
 Diagnosis getRequestDiagnosis(long requestId)
          Gets the diagnosis for the given request.
 long[] getRequests(long id)
          Returns the requests identifiers for those requests that have the specified request as its immediate parent.
 java.lang.String getRequestState(long requestId)
          Retrieves the current state of the specified request.
 oracle.as.scheduler.management.SpawnedJobDetail getSpawnedJobDetail(long requestId)
          Retrieves job details for a process type (spawned) job request.
 SQLJobDetail getSQLJobDetail(long requestId)
          Retrieves current database job details for a SQL job request.
 char[] getTextContent(ContentHandle ch, int maxChars)
          Gets the characters of the log for a specific request.
 void holdRequest(long requestId)
          Withholds further processing of a request that is in WAIT or READY state.
 void importLogData(ContentHandle ch, java.lang.String data)
          Imports data to the request log.
 void importOutputData(ContentHandle ch, byte[] bytes)
          Imports data to the request output content.
 boolean isStandaloneEnv()
          Returns whether the environment is standalone or fusion.
 ContentHandle openLogContent(long requestId)
          Gets the handle for log content for the request.
 ContentHandle openLogContentForImport(long requestId)
          Opens the request log for import, or write, of log data.
 ContentHandle openOutputContent(long requestId, java.lang.String contentName)
          Opens the output content for fetch.
 ContentHandle openOutputContentForImport(long requestId, java.lang.String contentName)
          Opens the output content for import.
 RequestSummary[] queryApplicationRequests(State[] state, java.lang.String processor)
          Gets a summary of requests by application.
 javax.management.openmbean.TabularData queryCompletedRequestsDetail(java.lang.String application, java.lang.String processor, int deltaStart, int deltaEnd, long elapsed, int maxCount, java.util.Map<java.lang.String,java.lang.String> filterParamNameValues, java.util.List<java.lang.String> returnParamNames)
          Gets a map of requests that got completed within the specified start and end times.
 RequestSummary[] queryJobCompletedRequests(java.lang.String application, java.lang.String processor, CalendarWrapper start, CalendarWrapper end, long elapsed, int count)
          Gets a summary of requests by job or job set.
 RequestDetail[] queryLongRunningRequests(java.lang.String processor, int count)
          Gets the longest running requests reverse ordered by elapsed time, longest to shortest.
 javax.management.openmbean.TabularData queryLongRunningRequestsDetail(java.lang.String application, java.lang.String processor, int maxCount, java.util.Map<java.lang.String,java.lang.String> filterParamNameValues, java.util.List<java.lang.String> returnParamNames)
          Gets a map of requests that are running for long by filtering as per the application and processor.
 javax.management.openmbean.TabularData queryReadyRequestsDetail(java.lang.String application, java.util.Map<java.lang.String,java.lang.String> filterParamNameValues, java.util.List<java.lang.String> returnParamNames)
          Gets a list of requests details that are in ready state
 java.util.Map<java.lang.String,java.lang.Integer> queryRequestCountsForEMAlert(java.lang.String processor, int deltaStart, int deltaEnd)
          Returns the map of requests counts for the following scenarios identified by a list of request ids.
 RequestSummary queryRequestSummary(long id)
          Gets a summary for the request specified.
 RequestSummary[] queryRunningRequestsByProcessor(java.lang.String application)
          Gets a summary of requests for each user reverse ordered according to number of requests, highest to lowest, by processor.
 RequestSummary[] querySnapshotDailyRequests(int month, int year, int day)
          Gets a summary of requests for the day specified.
 RequestSummary[] querySnapshotMonthlyRequests(int month, int year)
          Gets a summary of requests for the month specified.
 RequestSummary[] querySnapshotWeeklyRequests(int month, int year, int week)
          Gets a summary of requests for the week specified.
 RequestSummary[] queryUserCompletedRequests(java.lang.String application, java.lang.String processor, CalendarWrapper start, CalendarWrapper end, long minTotalElapsed, int count)
          Gets a summary of requests for each user reverse ordered according to number of requests, highest to lowest, for requests that have completed.
 RequestSummary[] queryUserRequests(java.lang.String application, State[] state, java.lang.String processor)
          Gets a summary of requests for each user reverse ordered according to number of requests, highest to lowest.
 java.util.List<RequestDetail> queryWorkAssignmentReadyRequests(MetadataObjectId waMid)
          Returns list of sparse request detail for the requests, in order of priority, that are in READY state and could be processed by the given work assignment.
 RequestSummary[] queryWorkAssignmentRequests(java.lang.String application, java.lang.String processor, CalendarWrapper start, int count)
          Gets a summary of requests by work assignment.
 void recoverRequest(long requestId)
          Attempts to force a request to complete under certain conditions.
 void releaseRequest(long requestId)
          Releases a request from the HOLD state.
 void removeBinding(MetadataObjectId bindingName)
          Removes a processor binding.
 void removeBindings(java.util.List<MetadataObjectId> bindingNames)
          Removes a list of processor bindings.
 void replaceSchedule(long requestId, MetadataObjectId schedule)
          Replace the current schedule for a request that has already been submitted.
 void replaceScheduleAdhoc(long requestId, Schedule schedule)
          Replace the current schedule for a request that has already been submitted.
 void replaceScheduleStartEnd(long requestId, MetadataObjectId schedule, Schedule adhocSchedule, CalendarWrapper start, CalendarWrapper end)
          Replace the current schedule for a request that has already been submitted with a schedule.
 void setRequestParameter(long requestId, java.lang.String name, PropertyValue value)
          Sets the value of a request parameter for a specified request.
 long submitAdHocRequest(java.lang.String desc, JobType.ExecutionType type, Schedule schedule, Trigger trigger, CalendarWrapper start, CalendarWrapper end, RequestParameters parameters)
          Adhoc job request submission using specified Schedule and Trigger instances.
 long submitBatchDeleteRequest(java.lang.String desc, CalendarWrapper start, RequestParameters parameters)
          Submits a request for a batch delete job.
 long submitBatchDeleteRequest(java.lang.String desc, MetadataObjectId scheduleMetaId, Schedule adhocSchedule, CalendarWrapper start, CalendarWrapper end, RequestParameters parameters)
          Submits a request for a batch delete job.
 long submitPartAdHocRequest(java.lang.String desc, MetadataObjectId definition, Schedule schedule, Trigger trigger, CalendarWrapper start, CalendarWrapper end, RequestParameters parameters)
          Job request submission using Job Definition predefined in Metadata, and adhoc Schedule and Trigger instances.
 long submitRequest(java.lang.String desc, MetadataObjectId definition, CalendarWrapper start, RequestParameters parameters)
          Submits a new job request using metadata definition of the job to run once at the specified time.
 long submitRequest(java.lang.String desc, MetadataObjectId definition, MetadataObjectId schedule, MetadataObjectId trigger, CalendarWrapper start, CalendarWrapper end, RequestParameters parameters)
          Submits a new job request using metadata definitions of the job, schedule and associated trigger.
 void updateAsyncThrottle(oracle.as.scheduler.management.AsyncThrottle throttle)
          Deprecated. Async limits are now defined on the workshift.
 void updateAsyncThrottle(java.util.List<oracle.as.scheduler.management.AsyncThrottle> throttles)
          Deprecated. Async limits are now defined on the workshift.
 void updateRequestProperty(long requestId, java.lang.String name, PropertyValue value)
          Updates the value of a request parameter for a request.
 void updateRequestStartEnd(long requestId, CalendarWrapper start, CalendarWrapper end)
          Replace the start and end time for a request that has already been submitted.

 

Field Detail

s_protocolVersion

static final oracle.as.scheduler.management.ProtocolVersion s_protocolVersion
The local version information for this interface

s_shortName

static final java.lang.String s_shortName
See Also:
Constant Field Values

s_mbeanObjectNameString

static final java.lang.String s_mbeanObjectNameString

Method Detail

getProtocolVersion

oracle.as.scheduler.management.ProtocolVersion getProtocolVersion()
                                                                  throws java.io.IOException
Returns remote version information for this interface
Returns:
remote version information for this interface
Throws:
java.io.IOException - if a protocol error occurs

submitRequest

long submitRequest(java.lang.String desc,
                   MetadataObjectId definition,
                   CalendarWrapper start,
                   RequestParameters parameters)
                   throws java.io.IOException,
                          javax.management.InstanceNotFoundException,
                          javax.management.InvalidAttributeValueException,
                          javax.management.RuntimeOperationsException
Submits a new job request using metadata definition of the job to run once at the specified time.
Parameters:
desc - description for the request.
definition - the name of a job definition or job set to use from metadata.
start - the time at which the request must be started.
parameters - request parameters.
Returns:
the request identifier for the submitted request.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if any metadata specified for this operation was not found in the metadata repository.
javax.management.InvalidAttributeValueException - if the request validation failed.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

submitRequest

long submitRequest(java.lang.String desc,
                   MetadataObjectId definition,
                   MetadataObjectId schedule,
                   MetadataObjectId trigger,
                   CalendarWrapper start,
                   CalendarWrapper end,
                   RequestParameters parameters)
                   throws java.io.IOException,
                          javax.management.InstanceNotFoundException,
                          javax.management.InvalidAttributeValueException,
                          javax.management.RuntimeOperationsException
Submits a new job request using metadata definitions of the job, schedule and associated trigger.
Parameters:
desc - description for the request.
definition - the name of a job definition or job set to use from metadata.
schedule - the name of the job schedule to use from metadata.
trigger - the name of job trigger to use from metadata
start - the start time from which the requests must be started. The start time applies to both Schedule and Trigger if present.
end - the end time until which the request should run. The end time applies to both the Schedule and Trigger definitions is specified.
parameters - request parameters.
Returns:
the request identifier of the submitted request.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if any metadata specified for this operation was not found in the metadata repository.
javax.management.InvalidAttributeValueException - if the request validation failed.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

submitAdHocRequest

long submitAdHocRequest(java.lang.String desc,
                        JobType.ExecutionType type,
                        Schedule schedule,
                        Trigger trigger,
                        CalendarWrapper start,
                        CalendarWrapper end,
                        RequestParameters parameters)
                        throws java.io.IOException,
                               javax.management.InvalidAttributeValueException,
                               javax.management.RuntimeOperationsException
Adhoc job request submission using specified Schedule and Trigger instances.
Parameters:
desc - description for the request.
type - must be one of the base types values viz. JAVA_TYPE, SQL_TYPE and PROCESS_TYPE specified by JobType enum.
schedule - instance of schedule object
trigger - the instance of Trigger object
start - the start time from which the requests must be started. The start time applies to both Schedule and Trigger if present.
end - the end time until which the request should run. The end time applies to both the Schedule and Trigger definitions is specified.
parameters - additional request parameters specified a part of the request.
Returns:
the request identifier of the submitted request.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InvalidAttributeValueException - if the request validation failed.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

submitPartAdHocRequest

long submitPartAdHocRequest(java.lang.String desc,
                            MetadataObjectId definition,
                            Schedule schedule,
                            Trigger trigger,
                            CalendarWrapper start,
                            CalendarWrapper end,
                            RequestParameters parameters)
                            throws java.io.IOException,
                                   javax.management.InstanceNotFoundException,
                                   javax.management.InvalidAttributeValueException,
                                   javax.management.RuntimeOperationsException
Job request submission using Job Definition predefined in Metadata, and adhoc Schedule and Trigger instances.
Parameters:
desc - description for the request.
definition - the name of a job definition or job set to use from metadata.
schedule - instance of schedule object
trigger - the instance of Trigger object
start - the start time from which the requests must be started. The start time applies to both Schedule and Trigger if present.
end - the end time until which the request should run. The end time applies to both the Schedule and Trigger definitions is specified.
parameters - additional request parameters specified a part of the request.
Returns:
the request identifier of the submitted request.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if any metadata specified for this operation was not found in the metadata repository.
javax.management.InvalidAttributeValueException - if the request validation failed.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

updateRequestProperty

void updateRequestProperty(long requestId,
                           java.lang.String name,
                           PropertyValue value)
                           throws java.io.IOException,
                                  javax.management.InstanceNotFoundException,
                                  javax.management.InvalidAttributeValueException,
                                  javax.management.RuntimeOperationsException
Updates the value of a request parameter for a request. The parameter can be a system property or an application property.

This operation fails if the request parameter does not already exist.

This operation is subject to any read-only constraint on the parameter being updated and an error occurs if the parameter is read-only.

This operation applies to only the target request. It does not cascade to any other requests that may be associated with the request.

Parameters:
requestId - the request identifier of the request being updated
name - the name of the parameter to modify.
value - the new value of the parameter
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request was not found
javax.management.InvalidAttributeValueException - if parameter validation fails.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

setRequestParameter

void setRequestParameter(long requestId,
                         java.lang.String name,
                         PropertyValue value)
                         throws java.io.IOException,
                                javax.management.InstanceNotFoundException,
                                javax.management.InvalidAttributeValueException,
                                javax.management.RuntimeOperationsException
Sets the value of a request parameter for a specified request. The parameter can be a system property or an application property.

The parameter will be added if it does not already exist, otherwise the value of the parameter will be updated.

This operation is subject to any read-only constraint on the parameter being set and an error occurs if the parameter already exists and is read-only.

This operation applies to only the target request. It does not cascade to any other requests that may be associated with the request.

Parameters:
requestId - the request identifier of the request being updated
name - the name of the parameter to set.
value - the new value of the parameter
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request was not found
javax.management.InvalidAttributeValueException - if parameter validation fails.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getRequestState

java.lang.String getRequestState(long requestId)
                                 throws java.io.IOException,
                                        javax.management.InstanceNotFoundException,
                                        javax.management.RuntimeOperationsException
Retrieves the current state of the specified request.
Parameters:
requestId - the request identifier of the request
Returns:
the current state of the request
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request was not found
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getRequests

long[] getRequests(long id)
                   throws java.io.IOException,
                          javax.management.InstanceNotFoundException,
                          javax.management.RuntimeOperationsException
Returns the requests identifiers for those requests that have the specified request as its immediate parent.
Parameters:
id - the request identifier of the target request.
Returns:
an array of request identifiers which have requestId as the immediate parent.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request was not found.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getRequestDetail

RequestDetail getRequestDetail(long requestId)
                               throws java.io.IOException,
                                      javax.management.InstanceNotFoundException,
                                      javax.management.RuntimeOperationsException
Gets the runtime details of the specified request.
Parameters:
requestId - the request identifier of the request
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request was not found or if any metadata referenced for this operation was not found in the metadata repository.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

executeQueryRequests

oracle.as.scheduler.management.QueryResultHandle executeQueryRequests(Filter filter,
                                                                      RuntimeService.QueryField orderBy,
                                                                      boolean ascending)
                                                                      throws java.io.IOException,
                                                                             javax.management.InvalidAttributeValueException,
                                                                             javax.management.RuntimeOperationsException
Query requests whose attributes and properties match those specified by the fields in the filter.

The method provides the block-fetch mechanism for querying requests. It returns an handle to the results. This handle must then be used in subsequent calls to fetchQueryResults to fetch the desired number of rows. getQueryRequestsCount can be used to determine the number of requests returned by the query.

The runtime subsystem might close the handle if it is not used for a long time in order to release associated resources.

Parameters:
filter - contains field/comparator/value combinations used as parameters for retrieving query results.
orderBy - field based on which the results will be sorted.
ascending - flag indicating whether the ordering based on the given field should be ascending or descending.
Returns:
an instance of a handle to be used to retrieve information for requests that satisified the query.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InvalidAttributeValueException - if filter parameter validation fails.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

executeQueryRequests

oracle.as.scheduler.management.QueryResultHandle executeQueryRequests(Filter filter,
                                                                      RuntimeService.QueryField orderBy,
                                                                      boolean ascending,
                                                                      boolean includeProcessGroup)
                                                                      throws java.io.IOException,
                                                                             javax.management.InvalidAttributeValueException,
                                                                             javax.management.RuntimeOperationsException
Query requests whose attributes and properties match those specified by the fields in the filter.

The method provides the block-fetch mechanism for querying requests. It returns an handle to the results. This handle must then be used in subsequent calls to fetchQueryResults to fetch the desired number of rows. getQueryRequestsCount can be used to determine the number of requests returned by the query.

The runtime subsystem might close the handle if it is not used for a long time in order to release associated resources.

Parameters:
filter - contains field/comparator/value combinations used as parameters for retrieving query results.
orderBy - field based on which the results will be sorted.
ascending - flag indicating whether the ordering based on the given field should be ascending or descending.
includeProcessGroup - flag indicating whether the processGroup should be included in the search scope or not.
Returns:
an instance of a handle to be used to retrieve information for requests that satisified the query.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InvalidAttributeValueException - if filter parameter validation fails.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getQueryRequestsCount

long getQueryRequestsCount(oracle.as.scheduler.management.QueryResultHandle handle)
                           throws java.io.IOException,
                                  javax.management.RuntimeOperationsException
Returns return the number of requests that satisifed the query performed by executeQueryRequests.
Parameters:
handle - instance of handle returned by a prior call to executeQueryRequests
Returns:
the number of requests that satisified the query
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

fetchQueryResults

RequestDetail[] fetchQueryResults(oracle.as.scheduler.management.QueryResultHandle handle)
                                  throws java.io.IOException,
                                         javax.management.InstanceNotFoundException,
                                         javax.management.RuntimeOperationsException
Retrieves request details for the requests that satisified the query performed by executeQueryRequests.

This method returns information for all remaining requests that satisified the query. If this the first fetch method called after executeQueryRequests then all requests are returned and subsequent fetches will return no additional information.

The method returns an array of sparse RequestDetail objects that contain only few key attributes and proporties. The full details for a given request can be obtained by calling getRequestDetail.

The runtime subsystem might close the handle if it is not used for a long time in order to release associated resources.

Parameters:
handle - instance of handle returned by a prior call to executeQueryRequests
Returns:
an array of sparse RequestDetail objects. An empty array is returned if there is no request information to be returned.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the requests was not found.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

fetchQueryResults

RequestDetail[] fetchQueryResults(oracle.as.scheduler.management.QueryResultHandle handle,
                                  int maxRows)
                                  throws java.io.IOException,
                                         javax.management.InstanceNotFoundException,
                                         javax.management.RuntimeOperationsException
Retrieves request details for the requests that satisified the query performed by executeQueryRequests.

The method returns a given number of requests (block-fetch) as specified by maxRows. The retrieval of the requests is done in sequential fashion until the requests that satisified the query are returned.

The method returns an array of sparse RequestDetail objects that contain only few key attributes and proporties. The full details for a given request can be obtained by calling getRequestDetail.

The runtime subsystem might close the handle if it is not used for a long time in order to release associated resources.

Parameters:
handle - instance of handle returned by a prior call to executeQueryRequests
maxRows - maximum number of requests to be returned. If the number of remaining requests is less than this value, then only those requests are returned. If value is zero, then information for all remaining requests that satisified the query is returned.
Returns:
an array of sparse RequestDetail objects. An empty array is returned if there is no request information to be returned.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the requests was not found.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

close

void close(oracle.as.scheduler.management.QueryResultHandle handle)
           throws java.io.IOException,
                  javax.management.RuntimeOperationsException
Closes the handle returned by executeQueryRequests. Once the handle is closed it cannot be used by to retrieve information about the query.
Parameters:
handle - instance of handle to be closed
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs or handle is null.

holdRequest

void holdRequest(long requestId)
                 throws java.io.IOException,
                        javax.management.InstanceNotFoundException,
                        java.lang.IllegalStateException,
                        javax.management.OperationsException,
                        javax.management.RuntimeOperationsException
Withholds further processing of a request that is in WAIT or READY state. For parent requests, this operation will cascade to all eligible child requests.
Parameters:
requestId - of request to hold.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request was not found.
java.lang.IllegalStateException - if request is not in a compatible state.
javax.management.OperationsException - if this operation is not allowed on the specified request.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

releaseRequest

void releaseRequest(long requestId)
                    throws java.io.IOException,
                           javax.management.InstanceNotFoundException,
                           java.lang.IllegalStateException,
                           javax.management.OperationsException,
                           javax.management.RuntimeOperationsException
Releases a request from the HOLD state. For parent requests, this operation will cascade to all eligible child requests.
Parameters:
requestId - the request identifier of the request
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request was not found.
java.lang.IllegalStateException - if request is not in a compatible state.
javax.management.OperationsException - if this operation is not allowed on the specified request.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

cancelRequest

void cancelRequest(long requestId)
                   throws java.io.IOException,
                          java.lang.IllegalStateException,
                          javax.management.InstanceNotFoundException,
                          javax.management.RuntimeOperationsException
Cancels the processing of a request that is not in a terminal state.

For a singleton and child request in WAIT, READY, BLOCKED or HOLD state, this operation will cause them to go to CANCELLED state.

For a singleton and child request in RUNNING or COMPLETED state, cancellation is best effort and the state will go to a transitory CANCELLING state which will persist until the request has been cancelled and transitions to CANCELLED or some other terminal state.

For parent requests, this operation cascades to all its children.

Parameters:
requestId - the request identifier of the request
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request was not found.
java.lang.IllegalStateException - if request is already in a terminal state.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

deleteRequest

void deleteRequest(long requestId)
                   throws java.io.IOException,
                          javax.management.InstanceNotFoundException,
                          java.lang.IllegalStateException,
                          javax.management.OperationsException,
                          javax.management.RuntimeOperationsException
Marks a request for deletion. For parent requests, this operation will cascade to all children.

The target request must be a submitted request that has finished and is in a terminal state. An error occurs if the target request is not in a terminal state, or if it is a child request of some kind, for example, a JobSet step, a sub-request, a Schedule instance request, or Trigger instance request.

This does not physically remove request data, although the request will no longer be accessible (visible) for most operations.

Parameters:
requestId - the request identifier of the request
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request was not found.
java.lang.IllegalStateException - if the operation cannot be performed due to the current state of the request.
javax.management.OperationsException - the this operation is not supported for the request.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

queryLongRunningRequests

RequestDetail[] queryLongRunningRequests(java.lang.String processor,
                                         int count)
                                         throws java.io.IOException,
                                                javax.management.RuntimeOperationsException
Gets the longest running requests reverse ordered by elapsed time, longest to shortest.
Parameters:
processor - by mid-tier instance name that processed the request, or null for all.
count - number of results to return.
Returns:
request details for the longest running requests.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

queryUserRequests

RequestSummary[] queryUserRequests(java.lang.String application,
                                   State[] state,
                                   java.lang.String processor)
                                   throws java.io.IOException,
                                          javax.management.RuntimeOperationsException
Gets a summary of requests for each user reverse ordered according to number of requests, highest to lowest.
Parameters:
application - for the specified application or null for all applications.
state - array of State. Requests for the given states (only) will be selected. If null, then requests in the default states will be selected: running, success, error, warning, cancelled.
processor - the name of processing node for which to return the result, null for all.
Returns:
for each user returns the user name, application name and count of requests in the given states.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure
See Also:
for applicable states.

queryUserCompletedRequests

RequestSummary[] queryUserCompletedRequests(java.lang.String application,
                                            java.lang.String processor,
                                            CalendarWrapper start,
                                            CalendarWrapper end,
                                            long minTotalElapsed,
                                            int count)
                                            throws java.io.IOException,
                                                   javax.management.RuntimeOperationsException
Gets a summary of requests for each user reverse ordered according to number of requests, highest to lowest, for requests that have completed.
Parameters:
application - for the specified application or null for all applications.
processor - the name of processing node for which to return the result, null for all.
start - the start time of the request.
end - the end time of the request.
minTotalElapsed - the minimum total (cumulative) elapsed time in seconds for completed requests by user that should be used to filter out the result. A value of 0 indicates all results should be returned.
count - number of results to return. A value of 0 indicates all results should be returned.
Returns:
for each user returns the user name, application name and number of requests, total elapsed time for requests that have completed.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

queryCompletedRequestsDetail

javax.management.openmbean.TabularData queryCompletedRequestsDetail(java.lang.String application,
                                                                    java.lang.String processor,
                                                                    int deltaStart,
                                                                    int deltaEnd,
                                                                    long elapsed,
                                                                    int maxCount,
                                                                    java.util.Map<java.lang.String,java.lang.String> filterParamNameValues,
                                                                    java.util.List<java.lang.String> returnParamNames)
                                                                    throws java.io.IOException,
                                                                           javax.management.RuntimeOperationsException
Gets a map of requests that got completed within the specified start and end times. The result map will have key as requestid and value as another map containing the information about that request
Parameters:
application - application for the specified application or null for all applications
processor - processor the name of processing node for which to return the result, null for all.
deltaStart - start time of the request relative to cuttent time
deltaEnd - end time of the request relative to cuttent time
elapsed - the elapsed time in milliseconds for completed requests by user that should be used to filter out the result. A value of 0 indicates all results should be returned.
maxCount - count number of results to return. A value of 0 indicates all results should be returned.
filterParamNameValues - map with name-value pair of parameters to filter the requests
returnParamNames - list of parameter names to return with the resultset
Returns:
a TabularData
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

queryLongRunningRequestsDetail

javax.management.openmbean.TabularData queryLongRunningRequestsDetail(java.lang.String application,
                                                                      java.lang.String processor,
                                                                      int maxCount,
                                                                      java.util.Map<java.lang.String,java.lang.String> filterParamNameValues,
                                                                      java.util.List<java.lang.String> returnParamNames)
                                                                      throws java.io.IOException,
                                                                             javax.management.RuntimeOperationsException
Gets a map of requests that are running for long by filtering as per the application and processor. The result map will have key as requestid and value as another map containing the information about that request
Parameters:
application - application for the specified application or null for all applications
processor - processor the name of processing node for which to return the result, null for all.
maxCount - count number of results to return. A value of 0 indicates all results should be returned.
filterParamNameValues - map with name-value pair of parameters to filter the requests
returnParamNames - list of parameter names to return with the resultset
Returns:
a TabularData
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

queryReadyRequestsDetail

javax.management.openmbean.TabularData queryReadyRequestsDetail(java.lang.String application,
                                                                java.util.Map<java.lang.String,java.lang.String> filterParamNameValues,
                                                                java.util.List<java.lang.String> returnParamNames)
                                                                throws java.io.IOException,
                                                                       javax.management.RuntimeOperationsException
Gets a list of requests details that are in ready state

The result list will have set of maps containing the information about that request.

Parameters:
application - application for the specified application or null for all applications
filterParamNameValues - map with name-value pair of parameters to filter the requests
returnParamNames - list of parameter names to return with the resultset
Returns:
a TabularData
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

queryRunningRequestsByProcessor

RequestSummary[] queryRunningRequestsByProcessor(java.lang.String application)
                                                 throws java.io.IOException,
                                                        javax.management.RuntimeOperationsException
Gets a summary of requests for each user reverse ordered according to number of requests, highest to lowest, by processor.
Parameters:
application - for the specified application or null for all applications.
Returns:
for each processor returns the processor name, application name, and number of requests.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

queryApplicationRequests

RequestSummary[] queryApplicationRequests(State[] state,
                                          java.lang.String processor)
                                          throws java.io.IOException,
                                                 javax.management.RuntimeOperationsException
Gets a summary of requests by application. The result is reverse ordered by number of requests, highest to lowest.
Parameters:
state - array of State. Requests for the given states (only) will be selected. If null, then requests in the default states will be selected: running, success, error, warning, cancelled.
processor - the name of processing node for which to return the result, null for all.
Returns:
for each applicaton returns the application name, and count of requests in the given states.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure
See Also:
for applicable states.

queryJobCompletedRequests

RequestSummary[] queryJobCompletedRequests(java.lang.String application,
                                           java.lang.String processor,
                                           CalendarWrapper start,
                                           CalendarWrapper end,
                                           long elapsed,
                                           int count)
                                           throws java.io.IOException,
                                                  javax.management.RuntimeOperationsException
Gets a summary of requests by job or job set. The result is reverse ordered by total number of requests, highest to lowest.
Parameters:
application - for the specified application or null for all applications.
processor - the name of processing node for which to return the result, null for all.
start - requests that completed after, null for all.
end - requests that completed before, null for all.
elapsed - requests with elapsed time in seconds greater than, zero for all.
count - maximum number of results to return.
Returns:
for each job and job set definition returns the definition identifier, total number of requests, succeeded / warning / failed / cancelled count and last run date / time / identifier.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

queryWorkAssignmentRequests

RequestSummary[] queryWorkAssignmentRequests(java.lang.String application,
                                             java.lang.String processor,
                                             CalendarWrapper start,
                                             int count)
                                             throws java.io.IOException,
                                                    javax.management.RuntimeOperationsException
Gets a summary of requests by work assignment. The result is reverse ordered according to the number of requests, highest to lowest.
Parameters:
application - name, null for all.
processor - name, null for all.
start - requests that completed after. Used for restricting the result to most recent requests. null for all.
count - maximum number of results to return.
Returns:
for each work assignment returns the min / max / average latency, min / max / average processing time and counts for the running / succeeded / warning / cancelled / failed count.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

querySnapshotMonthlyRequests

RequestSummary[] querySnapshotMonthlyRequests(int month,
                                              int year)
                                              throws java.io.IOException,
                                                     javax.management.RuntimeOperationsException
Gets a summary of requests for the month specified.
Parameters:
month - in year (1-12)
year -
Returns:
for the period specified returns the total number of requests processed, total number of succeeded / warning / failed / cancelled requests and total requests scheduled on a per-day basis.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

querySnapshotWeeklyRequests

RequestSummary[] querySnapshotWeeklyRequests(int month,
                                             int year,
                                             int week)
                                             throws java.io.IOException,
                                                    javax.management.RuntimeOperationsException
Gets a summary of requests for the week specified.
Parameters:
month - in year (1-12)
year -
week - in month (1-6)
Returns:
for the period specified returns the total number of requests processed, total number of succeeded / warning / failed / cancelled requests and total requests scheduled on a per-day basis.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

querySnapshotDailyRequests

RequestSummary[] querySnapshotDailyRequests(int month,
                                            int year,
                                            int day)
                                            throws java.io.IOException,
                                                   javax.management.RuntimeOperationsException
Gets a summary of requests for the day specified.
Parameters:
month - in year (1-12)
year -
day - (1-31)
Returns:
for the period specified returns the total number of requests processed, total number of succeeded / warning / failed / cancelled requests and total requests scheduled on a per-hour basis.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

queryRequestSummary

RequestSummary queryRequestSummary(long id)
                                   throws java.io.IOException,
                                          javax.management.RuntimeOperationsException
Gets a summary for the request specified.
Parameters:
id - request identifier
Returns:
for the request specified returns the total number of runs, total number of succeeded / warning / failed / cancelled runs, min / max / average elapsed run time.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - due to runtime subsystem failure

getSQLJobDetail

SQLJobDetail getSQLJobDetail(long requestId)
                             throws java.io.IOException,
                                    javax.management.InstanceNotFoundException,
                                    javax.management.RuntimeOperationsException
Retrieves current database job details for a SQL job request.

This returns null if no database details are available. For example, if no information is available for the for the Oracle Scheduler job associated with the ESS request. That might occur if the Scheduler job has not yet been submitted, or the Scheduler job has completed and no information is available from Scheduler views.

Parameters:
requestId - the ESS request identifier
Returns:
the SQL job detail information, or null if no information is available
Throws:
java.io.IOException - if a protocol error occurs
javax.management.InstanceNotFoundException - if the request was not found or if any metadata referenced for this operation was not found in the metadata repository.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs

getSpawnedJobDetail

oracle.as.scheduler.management.SpawnedJobDetail getSpawnedJobDetail(long requestId)
                                                                    throws java.io.IOException,
                                                                           javax.management.InstanceNotFoundException,
                                                                           javax.management.RuntimeOperationsException
Retrieves job details for a process type (spawned) job request.

This returns null if no job details are available. That might occur if the process has not yet been created.

Parameters:
requestId - the ESS request identifier
Returns:
the spawned job detail information, or null if no information is available
Throws:
java.io.IOException - if a protocol error occurs
javax.management.InstanceNotFoundException - if the request was not found
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs

getBlockedRequests

long[] getBlockedRequests(long requestId)
                          throws java.io.IOException,
                                 javax.management.InstanceNotFoundException,
                                 javax.management.RuntimeOperationsException
Returns a list of request identifiers that are blocked by the given request.

Requests get blocked only if they are defined to be incompatible with each other and cannot run together.

Parameters:
requestId - the identifer of the request that might be blocking some other requests. Such a given request must be in RUNNING state.
Returns:
array of request identifiers blocked by the given request. If no requests are blocked, the method returns empty array.
Throws:
java.io.IOException - if a protocol error occurs.
javax.management.InstanceNotFoundException - if target request was not found.
javax.management.RuntimeOperationsException - if runtime service error

getBlockingRequests

long[] getBlockingRequests(long requestId)
                           throws java.io.IOException,
                                  javax.management.InstanceNotFoundException,
                                  javax.management.RuntimeOperationsException
Returns a list of request identifiers that are blocking the given request.

Requests get blocked only if they are defined to be incompatible with each other and cannot run together.

Parameters:
requestId - the identifer of the request that is blocked by other requests. Such a given request must be in BLOCKED state.
Returns:
array of request identifiers blocking the given request. If given request is in BLOCKED state, there must be at least 1 other request RUNNING that is blocking the given request.
Throws:
java.io.IOException - if a protocol error occurs.
javax.management.InstanceNotFoundException - if target request was not found.
javax.management.RuntimeOperationsException - if runtime service error

changeRequestPriority

void changeRequestPriority(long requestId,
                           int priority)
                           throws java.io.IOException,
                                  javax.management.InvalidAttributeValueException,
                                  javax.management.InstanceNotFoundException,
                                  javax.management.RuntimeOperationsException
Changes the priority for a submitted request that has not yet started to run. The new priority will be used for subsequent processing of the request.

This can be used to change the priority for a request that is in WAIT, READY, HOLD state.

The request priority will be changed even if it is read-only parameter for the request and normally not subject to be changed by the user.

Parameters:
requestId - the request identifier of the target request
priority - the new request priority value. Value can range from zero (highest) to nine (lowest).
Throws:
java.io.IOException - if a protocol error occurs.
javax.management.InvalidAttributeValueException - if a validation error occurs. For example, if the priority is not valid; or the request that cannot be changed due to it being in an unsupported state for the operation.
javax.management.InstanceNotFoundException - if the request was not found.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs

replaceScheduleAdhoc

void replaceScheduleAdhoc(long requestId,
                          Schedule schedule)
                          throws java.io.IOException,
                                 javax.management.InstanceNotFoundException,
                                 javax.management.InvalidAttributeValueException,
                                 javax.management.RuntimeOperationsException
Replace the current schedule for a request that has already been submitted.

The new schedule is an adhoc schedule. The old schedule could have been a metadata schedule or an adhoc schedule.

This can be used to replace the schedule for a request that is in WAIT or HOLD state.

All previously scheduled instances of this request that have not started running will be canceled. The new schedule will be effective immediately for scheduling new instances.

Parameters:
requestId - the request whose schedule is to be replaced. This request must be a submitted request, not a generated request.
schedule - the new schedule to use for this request
Throws:
java.io.IOException - if a protocol error occurs.
javax.management.InstanceNotFoundException - if requestId was not found.
javax.management.InvalidAttributeValueException - if the schedule is not valid or if requestId is not for a submitted request or represents a request in an unsupported state for the operation.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs

replaceSchedule

void replaceSchedule(long requestId,
                     MetadataObjectId schedule)
                     throws java.io.IOException,
                            javax.management.InstanceNotFoundException,
                            javax.management.InvalidAttributeValueException,
                            javax.management.RuntimeOperationsException
Replace the current schedule for a request that has already been submitted.

The new schedule will be a schedule obtained from the metadata of the application that submitted the request. The old schedule could have been a metadata schedule or an adhoc schedule.

This can be used to replace the schedule for a request that is in WAIT or HOLD state.

All previously scheduled instances of this request that have not started running will be canceled. The new schedule will be effective immediately for scheduling new instances.

Parameters:
requestId - the request whose schedule is to be replaced. This request must be a submitted request, not a generated request.
schedule - a MetadataObjectId representing the new schedule to use for this request
Throws:
java.io.IOException - if a protocol error occurs.
javax.management.InstanceNotFoundException - if requestId was not found.
javax.management.InvalidAttributeValueException - if the schedule is not valid or if requestId is not for a submitted request or represents a request in an unsupported state for the operation.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs

replaceScheduleStartEnd

void replaceScheduleStartEnd(long requestId,
                             MetadataObjectId schedule,
                             Schedule adhocSchedule,
                             CalendarWrapper start,
                             CalendarWrapper end)
                             throws java.io.IOException,
                                    javax.management.InstanceNotFoundException,
                                    javax.management.InvalidAttributeValueException,
                                    javax.management.RuntimeOperationsException
Replace the current schedule for a request that has already been submitted with a schedule.

The new schedule will be a schedule obtained from the metadata of the application that submitted the request or an adhoc schedule. The old schedule could have been a metadata schedule or an adhoc schedule. This operation cannot be invoked on a singleton request that only had a start time and no other schedule.

Either scheduleId or schedule must be specified. See updateRequestStartEnd(long, oracle.as.scheduler.CalendarWrapper, oracle.as.scheduler.CalendarWrapper).

This can be used to replace the schedule for a request that is in WAIT or HOLD state.

All previously scheduled instances of this request that have not started running will be canceled. The new schedule will be effective immediately for scheduling new instances.

This operation acquires a lock for the given request. The lock is released when close operation is subsequently invoked or the encompassing transaction is committed.

If an application tries to invoke this operation while the lock is being held by another thread, this method will block until the lock is released.

Parameters:
requestId - the request whose schedule is to be replaced. This request must be a submitted request, not a generated request.
schedule - a MetadataObjectId representing the new schedule to use for this request
adhocSchedule - the new schedule to use for this request
start - the new requested start time for the request. The request will not run prior to this time. If null, the current time will be used. If the request is meant to begin immediately, null should be specified.
end - the time past which this request or its child requests will not be dispatched for execution. If null, no end time is in effect.
Throws:
javax.management.InvalidAttributeValueException - if both schedule and adhocSchedule are null, the schedule is not valid or if requestId is not for a submitted request or represents a request in an unsupported state for the operation.
javax.management.InstanceNotFoundException - if requestId was not found or if the schedule metadata specified for this operation was not found in the metadata repository.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs
java.io.IOException

updateRequestStartEnd

void updateRequestStartEnd(long requestId,
                           CalendarWrapper start,
                           CalendarWrapper end)
                           throws java.io.IOException,
                                  javax.management.InstanceNotFoundException,
                                  javax.management.InvalidAttributeValueException,
                                  javax.management.RuntimeOperationsException
Replace the start and end time for a request that has already been submitted.

This method should may be invoked for submitted requests whether or not they not have an associated schedule or trigger. If a schedule or trigger is associated with the request and it is to be changed, please see replaceSchedule(long, oracle.as.scheduler.MetadataObjectId). If no schedule or trigger is associated with the request note that end has very little meaning. It is only used in validation to ensure that it does not come before start.

This operation acquires a lock for the given request. The lock is released when close operation is subsequently invoked or the encompassing transaction is committed.

If an application tries to invoke this operation while the lock is being held by another thread, this method will block until the lock is released.

Parameters:
requestId - the request whose schedule is to be replaced. This request must be a submitted request, not a generated request.
start - the new requested start time for the request. The request will not run prior to this time. If null, the current time will be used. If the request is meant to begin immediately, null should be specified.
end - the time past which this request or its child requests will not be dispatched for execution. If null, no end time is in effect.
Throws:
java.io.IOException
javax.management.InstanceNotFoundException
javax.management.InvalidAttributeValueException
javax.management.RuntimeOperationsException

addBinding

void addBinding(oracle.as.scheduler.management.Binding binding)
                throws java.io.IOException,
                       javax.management.InstanceNotFoundException,
                       javax.management.InstanceAlreadyExistsException,
                       javax.management.InvalidAttributeValueException,
                       javax.management.RuntimeOperationsException
Adds a new binding, which binds a work assignment to a processor.
Parameters:
binding - new binding to add
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if any metadata specified for this operation was not found in the metadata repository.
javax.management.InvalidAttributeValueException - if the binding validation failed, due to either invalid metadata or invalid binding mode.
javax.management.InstanceAlreadyExistsException - if the binding already exists.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

addBindings

void addBindings(java.util.List<oracle.as.scheduler.management.Binding> bindings)
                 throws java.io.IOException,
                        javax.management.InstanceNotFoundException,
                        javax.management.InstanceAlreadyExistsException,
                        javax.management.InvalidAttributeValueException,
                        javax.management.RuntimeOperationsException
Adds a list of new bindings.
Parameters:
bindings - list of bindings to add
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if any metadata specified for this operation was not found in the metadata repository.
javax.management.InvalidAttributeValueException - if the binding validation failed, due to either invalid metadata or invalid binding mode.
javax.management.InstanceAlreadyExistsException - if the binding already exists.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

removeBinding

void removeBinding(MetadataObjectId bindingName)
                   throws java.io.IOException,
                          javax.management.InstanceNotFoundException,
                          javax.management.RuntimeOperationsException
Removes a processor binding.
Parameters:
bindingName - metadata id of the bound work assignment
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.
javax.management.InstanceNotFoundException

removeBindings

void removeBindings(java.util.List<MetadataObjectId> bindingNames)
                    throws java.io.IOException,
                           javax.management.InstanceNotFoundException,
                           javax.management.RuntimeOperationsException
Removes a list of processor bindings.
Parameters:
bindingNames - list of metadata ids of bound work assignments
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the binding is not found.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

changeBindingMode

void changeBindingMode(MetadataObjectId bindingName,
                       boolean isExclusive)
                       throws java.io.IOException,
                              javax.management.InstanceNotFoundException,
                              javax.management.InvalidAttributeValueException,
                              javax.management.RuntimeOperationsException
Changes the mode of an existing binding.
Parameters:
bindingName - name of the binding to change
isExclusive - true if the binding mode should be set to exclusive; false if the binding mode should be set to standard.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the binding was not found.
javax.management.InvalidAttributeValueException - if the binding mode is invalid.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getBindings

java.util.List<oracle.as.scheduler.management.Binding> getBindings()
                                                                   throws java.io.IOException,
                                                                          javax.management.RuntimeOperationsException
Gets the processor bindings.
Returns:
list of processor bindings
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getExecutingRequests

long[] getExecutingRequests()
                            throws java.io.IOException,
                                   javax.management.RuntimeOperationsException
Retrieve the requests currently executing on this instance. This does not include asynchronous requests that are not in the local part of their execution.
Returns:
The set of requests IDs for requests currently executing on this instance.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

recoverRequest

void recoverRequest(long requestId)
                    throws java.io.IOException,
                           javax.management.InstanceNotFoundException,
                           javax.management.OperationsException,
                           javax.management.RuntimeOperationsException
Attempts to force a request to complete under certain conditions.

1. The request must already by in a terminal state or in State.CANCELLING. If a request is in another state, RuntimeService.cancel must be called first. If the request does not eventually transition to State.CANCELLED, then this operation may be invoked on the request.
2. All child requests of the given request must already be complete.

A completed> request is a request in a terminal state with a process phase of ProcessPhase.Complete.

Note that this operation will lock the request.

Parameters:
requestId - the request identifier of the request.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request is not found
javax.management.OperationsException - if the given request has child requests that are not complete.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

completeAsyncRequest

void completeAsyncRequest(long requestId,
                          oracle.as.scheduler.async.AsyncStatus status,
                          java.lang.String statusMessage)
                          throws java.io.IOException,
                                 javax.management.InstanceNotFoundException,
                                 javax.management.OperationsException,
                                 javax.management.RuntimeOperationsException
Complete an asynchronous request with the given status. The request must be waiting for an asynchronous response or in State.ERROR_MANUAL_RECOVERY. The caller must make sure the remote job is no longer executing before invoking this operation with a terminal status.

The status is used to transition the request to the appropriate state. Updatable.onEvent is not invoked during this operation.

Parameters:
requestId - the request identifier of the request
status - the asynchronous status. Note that AsyncStatus.UPDATE will result in nothing being done.
statusMessage - An error message if the status is ERROR or BIZ_ERROR, a warning message if the status is WARNING, the paused state if the status is PAUSED. The value will be ignored if the status is SUCCESS, CANCEL, or UPDATE.
Throws:
javax.management.InstanceNotFoundException - if the requestId is not found
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.
javax.management.OperationsException - if the request is not asynchronous or is not in the correct state or process phase.
java.io.IOException

getRequestDiagnosis

Diagnosis getRequestDiagnosis(long requestId)
                              throws java.io.IOException,
                                     javax.management.InstanceNotFoundException,
                                     javax.management.RuntimeOperationsException
Gets the diagnosis for the given request.
Parameters:
requestId - request to diagnose
Returns:
request diagnosis
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request is not found
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getLastFailedExecution

FailedExecutionResult getLastFailedExecution(long requestId)
                                             throws java.io.IOException,
                                                    javax.management.InstanceNotFoundException,
                                                    javax.management.RuntimeOperationsException
Gets information on the last failed execution attempt for a request.
Parameters:
requestId - id of request that failed
Returns:
failed execution result
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request is not found, or if no failed execution history was found for the request, meaning the request has not been retried.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getFailedExecutionHistory

java.util.List<FailedExecutionResult> getFailedExecutionHistory(long requestId)
                                                                throws java.io.IOException,
                                                                       javax.management.InstanceNotFoundException,
                                                                       javax.management.RuntimeOperationsException
Retrieves all failed execution attempts for a request.
Parameters:
requestId - id of request that failed
Returns:
list of failed execution results, in order of increasing execution attempt. The list will be empty if the request has never failed nor been retried.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if the request is not found
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

queryWorkAssignmentReadyRequests

java.util.List<RequestDetail> queryWorkAssignmentReadyRequests(MetadataObjectId waMid)
                                                               throws java.io.IOException,
                                                                      javax.management.InvalidAttributeValueException,
                                                                      javax.management.RuntimeOperationsException
Returns list of sparse request detail for the requests, in order of priority, that are in READY state and could be processed by the given work assignment.
Returns:
list of sparse RequestDetail for each request.
Throws:
javax.management.InvalidAttributeValueException - if the work assignment is not bound on this instance.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.
java.io.IOException

submitBatchDeleteRequest

long submitBatchDeleteRequest(java.lang.String desc,
                              CalendarWrapper start,
                              RequestParameters parameters)
                              throws java.io.IOException,
                                     javax.management.InstanceNotFoundException,
                                     javax.management.InvalidAttributeValueException,
                                     javax.management.RuntimeOperationsException
Submits a request for a batch delete job. The request parameters are used to specify the delete criteria.
Parameters:
desc - description for the request
start - the time at which the request is to be started. If null, the request will be start immediately.
parameters - the request parameters
Returns:
the request identifier for the submitted request.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if any metadata specified for this operation was not found in the metadata repository.
javax.management.InvalidAttributeValueException - if the request validation failed.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

submitBatchDeleteRequest

long submitBatchDeleteRequest(java.lang.String desc,
                              MetadataObjectId scheduleMetaId,
                              Schedule adhocSchedule,
                              CalendarWrapper start,
                              CalendarWrapper end,
                              RequestParameters parameters)
                              throws java.io.IOException,
                                     javax.management.InstanceNotFoundException,
                                     javax.management.InvalidAttributeValueException,
                                     javax.management.RuntimeOperationsException
Submits a request for a batch delete job. The request parameters are used to specify the delete criteria.

Either a metadata Schedule or adhoc Schedule can be given. This fails if both scheduleMetaId and adhocSchedule are non-null. If a metadata schedule is used, the Schedule metadata must be in the metadata repository configured for ESSAPP.

Parameters:
desc - description for the request
scheduleMetaId - the metadata object id of the schedule to use
adhocSchedule - the adhoc schedule to use
start - the time at which the request is to be started
end - the end time past which the request should not run.
parameters - the request parameters
Returns:
the request identifier for the submitted request.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if any metadata specified for this operation was not found in the metadata repository.
javax.management.InvalidAttributeValueException - if the request validation failed.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

updateAsyncThrottle

@Deprecated
void updateAsyncThrottle(oracle.as.scheduler.management.AsyncThrottle throttle)
                         throws java.io.IOException,
                                javax.management.RuntimeOperationsException
Deprecated. Async limits are now defined on the workshift.
Defines or updates limits for the number of asynchronous jobs that can be running at one time for a given WorkAssignment/Workshift.
Parameters:
throttle - object that specifies the limits
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

updateAsyncThrottle

@Deprecated
void updateAsyncThrottle(java.util.List<oracle.as.scheduler.management.AsyncThrottle> throttles)
                         throws java.io.IOException,
                                javax.management.RuntimeOperationsException
Deprecated. Async limits are now defined on the workshift.
Defines or updates limits for the number of asynchronous jobs that can be running at one time for a list of WorkAssignment/Workshift.
Parameters:
throttles - list of objects that specify the limits
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getAsyncThrottleForWorkshift

@Deprecated
oracle.as.scheduler.management.AsyncThrottle getAsyncThrottleForWorkshift(MetadataObjectId wshiftId)
                                                                          throws java.io.IOException,
                                                                                 javax.management.RuntimeOperationsException
Deprecated. 
Gets the configured limits and current allocations of the number of asynchronous jobs for the given Workshift.
Parameters:
wshiftId - metadata id of the workshift to get the async throttle infor for.
Returns:
throttle object that includes the limits and current allocations for each type of asynchronous job.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getAsyncLimits

java.util.List<oracle.as.scheduler.management.AsyncThrottle> getAsyncLimits(WorkAssignment workAssignment)
                                                                            throws javax.management.RuntimeOperationsException
Gets the async limits for all workshifts of the given work assignment.
Parameters:
workAssignment - work assignment object to use.
Returns:
list of throttle objects, one per workshift, that include the workshift and the async limits.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getAsyncThrottle

@Deprecated
oracle.as.scheduler.management.AsyncThrottle getAsyncThrottle(MetadataObjectId waId,
                                                                         MetadataObjectId wshiftId)
                                                              throws java.io.IOException,
                                                                     javax.management.RuntimeOperationsException
Deprecated. 
Gets the configured async limits for the given Workshift and the current allocations of the number of asynchronous jobs for the given WorkAssignment.
Returns:
throttle object that includes the limits and current allocations for each type of asynchronous job.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getAsyncThrottle

@Deprecated
java.util.List<oracle.as.scheduler.management.AsyncThrottle> getAsyncThrottle(MetadataObjectId waId)
                                                                              throws javax.management.RuntimeOperationsException
Deprecated. Async limits are now associated with the workshift only.
Gets the configured limits and current allocations of the number of asynchronous jobs for all workshifts of the given WorkAssignment. No information is returned for workshifts that have no limits defined.
Returns:
list of throttle objects that include the limits and current allocations for each type of asynchronous job. List includes one object per workshift that has defined limits or outstanding allocations.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

cleanExecutionGroup

void cleanExecutionGroup(java.lang.String domainName,
                         java.lang.String clusterName)
                         throws javax.management.OperationsException,
                                javax.management.RuntimeOperationsException
Cleans up artifacts from an ESS execution group. Normally, if a cluster with ESS is not going to be used anymore, all requests associated with the ESS hosted applications deployed to that cluster should be in ProcessPhase.Complete. Any requests not in a terminal state should be canceled, and if necessary, recoverd using recoverRequest. After all such requests are complete, the ESS hosted applications should be undeployed.

If for some reason, the above steps were not taken, then this operation can do the following. 1. Terminate all requests in the execution group. Requests that are not in a terminal state are transitioned to CANCELLED. All incompatibility locks are released and other cleanup occurs. 2. Application registration entries are removed for the execution group. 3. ESS instance registration entries are removed for the execution group. An execution group is based on a particular cluster or server. If the server/cluster has been removed

Parameters:
domainName - the name of the domain in which the execution group to remove resides
clusterName - the cluster name of the execution group to remove. If in a cluster, this is the cluster name of, otherwise this is the server name.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.OperationsException - if there are active ESS instances in the execution group being removed or if the execution group clean up is already occurring.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getInactiveBindings

java.util.List<oracle.as.scheduler.management.InactiveBinding> getInactiveBindings()
                                                                                   throws javax.management.RuntimeOperationsException
Gets the inactive bindings for the ESS instance. Inactive bindings include the following:
Returns:
list of inactive bindings
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getApplicationsInfo

java.util.List<oracle.as.scheduler.management.AppRegistrationInfo> getApplicationsInfo()
                                                                                       throws javax.management.RuntimeOperationsException

Retrieve application registration information for all applications in all servers for all process groups in this isolation group.

A separate entry is returned for each application/server combination.

The AppRegistrationInfo for ESSAPP is removed from the returned list. To get the full list, use getApplicationsInfo(boolean) with true

Returns:
a list of application registrations
Throws:
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getApplicationsInfo

java.util.List<oracle.as.scheduler.management.AppRegistrationInfo> getApplicationsInfo(boolean includeEssApp)
                                                                                       throws javax.management.RuntimeOperationsException

Retrieve application registration information for all applications in all servers for all process groups in this isolation group.

A separate entry is returned for each application/server combination.

Returns:
a list of application registrations
Throws:
javax.management.RuntimeOperationsException - if a RuntimeService subsystem failure occurs.

getLogContentDetail

ContentDetail getLogContentDetail(long requestId)
                                  throws java.io.IOException,
                                         javax.management.InstanceNotFoundException,
                                         javax.management.RuntimeOperationsException
Gets details for log content for the request.
Parameters:
requestId - request id.
Returns:
ContentDetail object specific to the request, or null if the log does not exist.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if requestid is not found.
javax.management.RuntimeOperationsException - if error accessing runtime store.

openLogContent

ContentHandle openLogContent(long requestId)
                             throws java.io.IOException,
                                    javax.management.InstanceNotFoundException,
                                    javax.management.RuntimeOperationsException
Gets the handle for log content for the request.
Parameters:
requestId - request id.
Returns:
ContentHandle object specific to the request;
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if requestid is not found.
javax.management.RuntimeOperationsException - if error accessing runtime store.

openLogContentForImport

ContentHandle openLogContentForImport(long requestId)
                                      throws javax.management.InstanceNotFoundException,
                                             javax.management.RuntimeOperationsException,
                                             javax.management.InvalidAttributeValueException
Opens the request log for import, or write, of log data.
Parameters:
requestId - request id.
Returns:
ContentHandle handle to use to import log data.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if requestid is not found.
javax.management.RuntimeOperationsException - if error accessing runtime store.
javax.management.InvalidAttributeValueException - if content exists and does not match this content type.

importLogData

void importLogData(ContentHandle ch,
                   java.lang.String data)
                   throws javax.management.InstanceNotFoundException,
                          javax.management.InvalidAttributeValueException,
                          javax.management.RuntimeOperationsException
Imports data to the request log.
Parameters:
ch - content handle from a previous call to openLogContentForImport.
data - log data to import.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if log content does not exist.
javax.management.InvalidAttributeValueException - if content handle is invalid or not open for write.
javax.management.RuntimeOperationsException - if error accessing runtime store.

getLogLines

java.lang.String[] getLogLines(ContentHandle ch,
                               int maxLines)
                               throws java.io.IOException,
                                      javax.management.InvalidAttributeValueException,
                                      javax.management.RuntimeOperationsException
Gets the lines from the log for a specific request.
Parameters:
ch - content handle from previous open call.
maxLines - maximum number of lines to get.
Returns:
array of lines from the log without line terminators; if no more lines, array will be empty.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InvalidAttributeValueException - if handle is invalid.
javax.management.RuntimeOperationsException - if error accessing runtime store.

getTextContent

char[] getTextContent(ContentHandle ch,
                      int maxChars)
                      throws java.io.IOException,
                             javax.management.InvalidAttributeValueException,
                             javax.management.RuntimeOperationsException
Gets the characters of the log for a specific request.
Parameters:
ch - content handle from previous open call.
maxChars - maximum number of chars to get.
Returns:
array of characters from the log without line terminators; if no more lines, array will be empty.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InvalidAttributeValueException - if handle is invalid.
javax.management.RuntimeOperationsException - if error accessing runtime store.

closeContent

void closeContent(ContentHandle ch)
                  throws java.io.IOException,
                         javax.management.InvalidAttributeValueException,
                         javax.management.RuntimeOperationsException
Close the content handle from previous open call
Parameters:
ch - content handle from previous open call.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InvalidAttributeValueException - if handle is invalid.
javax.management.RuntimeOperationsException - if error accessing runtime store.

getOutputContentDetail

java.util.List<ContentDetail> getOutputContentDetail(long requestId)
                                                     throws java.io.IOException,
                                                            javax.management.RuntimeOperationsException
Gets details for output content for the request.
Parameters:
requestId - request id.
Returns:
list of content detail instances;
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if error accessing runtime store.

isStandaloneEnv

boolean isStandaloneEnv()
                        throws java.io.IOException,
                               javax.management.RuntimeOperationsException
Returns whether the environment is standalone or fusion.
Returns:
boolean true if the environment is standalone, false for fusion;
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.RuntimeOperationsException - if error accessing runtime store.

getOutputContentDetail

ContentDetail getOutputContentDetail(long requestId,
                                     java.lang.String fileName)
                                     throws java.io.IOException,
                                            javax.management.InstanceNotFoundException,
                                            javax.management.RuntimeOperationsException
Gets the output content detail of a file for a request .
Parameters:
requestId - request id.
fileName - name of the output file.
Returns:
ContentDetail content detail instance, or null if the output content does not exist.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if requestid is not found.
javax.management.RuntimeOperationsException - if error accessing runtime store.

openOutputContent

ContentHandle openOutputContent(long requestId,
                                java.lang.String contentName)
                                throws java.io.IOException,
                                       javax.management.InstanceNotFoundException,
                                       javax.management.RuntimeOperationsException
Opens the output content for fetch. The content must be closed to release the handle.
Parameters:
requestId - request id.
contentName - name of the output content.
Returns:
ContentHandle object specific to the request;
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if content row does not exist.
javax.management.RuntimeOperationsException - if error accessing runtime store.

openOutputContentForImport

ContentHandle openOutputContentForImport(long requestId,
                                         java.lang.String contentName)
                                         throws javax.management.InstanceNotFoundException,
                                                javax.management.RuntimeOperationsException,
                                                javax.management.InvalidAttributeValueException
Opens the output content for import. The content must be closed to release the handle.
Parameters:
requestId - request id.
contentName - name of the output content.
Returns:
content handle opened for write, to be used with importOutputData.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if content row does not exist.
javax.management.InvalidAttributeValueException - if content exists and does not match this content, such as not imported.
javax.management.RuntimeOperationsException - if error accessing runtime store.

importOutputData

void importOutputData(ContentHandle ch,
                      byte[] bytes)
                      throws javax.management.InstanceNotFoundException,
                             javax.management.InvalidAttributeValueException,
                             javax.management.RuntimeOperationsException
Imports data to the request output content.
Parameters:
ch - content handle from a previous call to openOutputContentForImport.
bytes - binary data to import.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InstanceNotFoundException - if output content does not exist.
javax.management.InvalidAttributeValueException - if content handle is invalid or not open for write.
javax.management.RuntimeOperationsException - if error accessing runtime store.

getBinaryContent

byte[] getBinaryContent(ContentHandle handle,
                        int maxBytes)
                        throws java.io.IOException,
                               javax.management.InvalidAttributeValueException,
                               javax.management.RuntimeOperationsException
Gets at most maxBytes bytes from the binary content.
Parameters:
handle - content handle from previous open call.
maxBytes - maximum number of bytes to get.
Returns:
array of bytes from the content.
Throws:
java.io.IOException - if a protocol error occurred.
javax.management.InvalidAttributeValueException - if handle is invalid.
javax.management.RuntimeOperationsException - if error accessing runtime store.

checkRequestPrivilege

java.util.Map<java.lang.Long,java.lang.Boolean> checkRequestPrivilege(long[] requestIds,
                                                                      java.lang.String[] privileges)
                                                                      throws java.io.IOException,
                                                                             javax.management.InvalidAttributeValueException,
                                                                             javax.management.RuntimeOperationsException
Check whether the current user has privilegs on the input requests identified by a list of request ids.
Parameters:
requestIds - the request ids to be checked.
privileges - the ESS request data security privileges to be checked. If multiple privileges are provided, one request id check requestis passed only if the user has all the privileges on that request.
Returns:
the Map of passed (true) or denied (false) results. Each input request ids will have one entry in the Map.
Throws:
java.io.IOException - if a protocol error occurs
javax.management.InvalidAttributeValueException - if requestIds or Permissions are invalid
javax.management.RuntimeOperationsException - if error accessing runtime store.

queryRequestCountsForEMAlert

java.util.Map<java.lang.String,java.lang.Integer> queryRequestCountsForEMAlert(java.lang.String processor,
                                                                               int deltaStart,
                                                                               int deltaEnd)
                                                                               throws java.io.IOException,
                                                                                      javax.management.InvalidAttributeValueException,
                                                                                      javax.management.RuntimeOperationsException
Returns the map of requests counts for the following scenarios identified by a list of request ids. - No. of requests in ERROR_MANUAL_RECOVERY state - No. of requests in ERROR state - No. of timed out requests - No. of requests that have reached the retry limit
Parameters:
processor - by mid-tier instance name that processed the request, or null for all.
deltaStart - start time of the request relative to cuttent time, in minutes
deltaEnd - end time of the request relative to cuttent time, in minutes
Returns:
the Map of <String, Integer> Each scenarios above will have one entry in the Map.
Throws:
java.io.IOException - if a protocol error occurs
javax.management.InvalidAttributeValueException - if validation failed.
javax.management.RuntimeOperationsException - if error accessing runtime store.

Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service
11g Release 1 (11.1.1.6.3)
E26229-05
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008, 2012 Oracle. All rights reserved.