oracle.as.scheduler
Class Diagnosis

java.lang.Object
  oracle.as.scheduler.Diagnosis

All Implemented Interfaces:

java.io.Serializable

public class Diagnosis
extends java.lang.Object
implements java.io.Serializable

Request diagnosis. A diagnosis provides information about the request including its state and an optional diagnostic code that provides additional information about why the request is in that state.

See Also:

Serialized Form

Nested Class Summary

static class	Diagnosis.AsyncExecutionType Enum of job types.
static class	Diagnosis.DiagnosticCode Enum of diagnostic codes.

Field Summary

protected java.lang.String	m_application
protected Diagnosis.AsyncExecutionType	m_asyncExecType
protected int	m_asyncLimit
protected long	m_blockingRequestId
protected boolean	m_hasDisabledUpdateEvents
protected java.lang.String	m_isolationGroup
protected long	m_parentRequestId
protected java.lang.String	m_processGroup
protected java.lang.String	m_requestedProcessor
protected java.util.Calendar	m_scheduledTime
protected long	m_subRequestId
protected MetadataObjectId	m_workAssignment
protected MetadataObjectId	m_workshift

Constructor Summary

protected	Diagnosis(long requestId, State state) Constructs a new request diagnosis with minimal information.
protected	Diagnosis(long requestId, State state, Diagnosis.DiagnosticCode diagnosticCode) Constructs a new request diagnosis.

Method Summary

static Diagnosis	from(javax.management.openmbean.CompositeData cd) Create an instance of the model specific class out of an associated CompositeData instance
java.lang.String	getApplication() Gets the application.
Diagnosis.AsyncExecutionType	getAsyncExecType() Gets the async execution type of this request.
int	getAsyncLimit() Gets the async limit that caused this request to be throttled.
long	getBlockingRequestId() Gets the request id of a request that is blocking this request.
Diagnosis.DiagnosticCode	getDiagnosticCode() Gets the disgnostic code for the request.
java.lang.String	getIsolationGroup() Gets the isolation group.
long	getParentRequestId() Gets the parent request id of the request.
java.lang.String	getProcessGroup() Gets the process group.
java.lang.String	getRequestedProcessor() Gets the requested processor.
long	getRequestId() Gets the request identifier associated with this diagnosis.
java.util.Calendar	getScheduledTime() Gets the scheduled time of the request.
State	getState() Gets the state for the request.
long	getSubRequestId() Gets the request id of a non-terminal subrequest of this request.
MetadataObjectId	getWorkAssignment() Gets the metadata id of a work assignment that could process the request.
MetadataObjectId	getWorkshift() Gets the metadata id of a workshift for the diagnosis.
boolean	hasDisabledUpdateEvents() Indicates if the running request has disabled update events.
protected void	setExtras(java.util.Calendar scheduledTime, java.lang.String requestedProcessor, java.lang.String isolationGroup, java.lang.String processGroup, java.lang.String application, MetadataObjectId workAssignment, MetadataObjectId workshift, long parentRequestId, long blockingRequestId, long subRequestId, Diagnosis.AsyncExecutionType asyncExecType, int asyncLimit, boolean hasDisabledUpdateEvents) Sets all the optional information in the Diagnosis.
protected void	setScheduledTime(java.util.Calendar scheduledTime) Sets the scheduled time for a request in WAIT state.
javax.management.openmbean.CompositeData	toCompositeData(javax.management.openmbean.CompositeType ct) Convert an instance of this model specific type to a CompositeData.
static javax.management.openmbean.CompositeType	toCompositeType() Returns the CompositeType that describes this model specific class.
java.lang.String	toMinimalString()
java.lang.String	toString()
java.lang.String	toString(java.util.Locale locale, java.util.TimeZone timeZone) Support EM's need to acquire a localized message String for the Diagnosis.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_scheduledTime

protected java.util.Calendar m_scheduledTime

m_requestedProcessor

protected java.lang.String m_requestedProcessor

m_processGroup

protected java.lang.String m_processGroup

m_isolationGroup

protected java.lang.String m_isolationGroup

m_application

protected java.lang.String m_application

m_workAssignment

protected MetadataObjectId m_workAssignment

m_workshift

protected MetadataObjectId m_workshift

m_parentRequestId

protected long m_parentRequestId

m_blockingRequestId

protected long m_blockingRequestId

m_subRequestId

protected long m_subRequestId

m_asyncExecType

protected Diagnosis.AsyncExecutionType m_asyncExecType

m_asyncLimit

protected int m_asyncLimit

m_hasDisabledUpdateEvents

protected boolean m_hasDisabledUpdateEvents

Constructor Detail

Diagnosis

protected Diagnosis(long requestId,
                    State state)

Constructs a new request diagnosis with minimal information.

Diagnosis

protected Diagnosis(long requestId,
                    State state,
                    Diagnosis.DiagnosticCode diagnosticCode)

Constructs a new request diagnosis.

Method Detail

getRequestId

public long getRequestId()

Gets the request identifier associated with this diagnosis.

Returns:

request identifier

getState

public State getState()

Gets the state for the request.

Returns:

request state

getDiagnosticCode

public Diagnosis.DiagnosticCode getDiagnosticCode()

Gets the disgnostic code for the request.

Returns:

diagnostic code

getScheduledTime

public java.util.Calendar getScheduledTime()

Gets the scheduled time of the request. For DiagnosticCode of RETRY_DELAY, it is the time the request will be retried. For FUTURE_START, it is the normal scheduled time of the request. For PREPROCESS_DELAY and POSTPROCESS_DELAY, it is the time the delay ends.

The scheduled time will be available for the following DiagnosticCodes

RETRY_DELAY

FUTURE_START

PREPROCESS_DELAY

POSTPROCESS_DELAY

Returns:

current scheduled time of the waiting request

getRequestedProcessor

public java.lang.String getRequestedProcessor()

Gets the requested processor.

Requested processor will be available for the following DiagnosticCodes

REQUESTED_PROCESSOR_NOT_ACTIVE

Returns:

value of SYS_requestedProcessor specified by the request

getApplication

public java.lang.String getApplication()

Gets the application.

Application will be available for the following DiagnosticCodes

NO_APPLICATION

TERMINAL

Returns:

application required for the request

getProcessGroup

public java.lang.String getProcessGroup()

Gets the process group.

Process group will be available for the following DiagnosticCodes

NO_ACTIVE_SERVER

NO_APPLICATION

TERMINAL

Returns:

process group

getIsolationGroup

public java.lang.String getIsolationGroup()

Gets the isolation group.

Isolation group will be available for the following DiagnosticCodes

NO_ACTIVE_SERVER

NO_APPLICATION

TERMINAL

Returns:

isolation group

getWorkAssignment

public MetadataObjectId getWorkAssignment()

Gets the metadata id of a work assignment that could process the request. This may or may not be the work assignment that actually does process the request. For TERMINAL, this is the work assignment that processed the last phase of the request.

The work assignment will be available for the following DiagnosticCodes

PROCESSOR_WAIT

INACTIVE_WORK_ASSIGNMENT_WAIT

NO_LOADED_WORK_ASSIGNMENT

DISABLED_WORK_ASSIGNMENT

THROTTLED

TERMINAL

Returns:

work assignment id

getWorkshift

public MetadataObjectId getWorkshift()

Gets the metadata id of a workshift for the diagnosis. For TERMINAL, this is the workshift under which the last phase of the request was processed.

The workshift will be available for the following DiagnosticCodes

THROTTLED

TERMINAL

Returns:

workshift id

getParentRequestId

public long getParentRequestId()

Gets the parent request id of the request.

The parent request id will be available for the following DiagnosticCodes

PARENT_NOT_PAUSED

Returns:

parent request id of the request, or -1 if the parent request id is not set.

getBlockingRequestId

public long getBlockingRequestId()

Gets the request id of a request that is blocking this request. There could be several requests blocking this request, and this request id is one of those requests.

The blocking request id will be available for the following DiagnosticCodes

BLOCKED

Returns:

request id of a request that is blocking this request, or -1 if the blocking request id is not set.

getSubRequestId

public long getSubRequestId()

Gets the request id of a non-terminal subrequest of this request. If this request has submitted multiple subrequests, the request id of one of those subrequests that is in a non-terminal state will be included in the diagnosis. If all subrequests of the request are in a terminal state, no subrequest id is included.

The subrequest id will be available for the following DiagnosticCodes

PAUSED

Returns:

request id of a subrequest in a non-terminal state or -1 if all subrequests are in a terminal state.

getAsyncExecType

public Diagnosis.AsyncExecutionType getAsyncExecType()

Gets the async execution type of this request.

The async execution type will be available for the following DiagnosticCodes

THROTTLED

Returns:

execution type for a throttled async request; or UNKNOWN

getAsyncLimit

public int getAsyncLimit()

Gets the async limit that caused this request to be throttled.

The async limit will be available for the following DiagnosticCodes

THROTTLED

Returns:

current async limit for a throttled request; else AsyncThrottle.UNSPECIFIED for a request that is not throttled.

hasDisabledUpdateEvents

public boolean hasDisabledUpdateEvents()

Indicates if the running request has disabled update events. This can only be the case for an asynchronous Java request.

This flag will be available for an async Java request in RUNNING state.

Returns:

true if the request has disabled update events.

setExtras

protected void setExtras(java.util.Calendar scheduledTime,
                         java.lang.String requestedProcessor,
                         java.lang.String isolationGroup,
                         java.lang.String processGroup,
                         java.lang.String application,
                         MetadataObjectId workAssignment,
                         MetadataObjectId workshift,
                         long parentRequestId,
                         long blockingRequestId,
                         long subRequestId,
                         Diagnosis.AsyncExecutionType asyncExecType,
                         int asyncLimit,
                         boolean hasDisabledUpdateEvents)

Sets all the optional information in the Diagnosis.

setScheduledTime

protected void setScheduledTime(java.util.Calendar scheduledTime)

Sets the scheduled time for a request in WAIT state.

Parameters:

scheduledTime -

toCompositeType

public static javax.management.openmbean.CompositeType toCompositeType()

Returns the CompositeType that describes this model specific class.

toCompositeData

public javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)

Convert an instance of this model specific type to a CompositeData. This ensure that clients that do not have access to the model specific class can still use the MBean. The MXBean framework can perform this conversion automatically. However MXBeans are part of JDK 6.0 and AS11g is required to support JDK 5.0

Parameters:

ct - This parameter is there only for future compatibility reasons with JDK 6.0. It can be ignored at this point.

from

public static Diagnosis from(javax.management.openmbean.CompositeData cd)
                      throws java.lang.IllegalArgumentException

Create an instance of the model specific class out of an associated CompositeData instance

Throws:

java.lang.IllegalArgumentException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toMinimalString

public java.lang.String toMinimalString()

toString

public java.lang.String toString(java.util.Locale locale,
                                 java.util.TimeZone timeZone)

Support EM's need to acquire a localized message String for the Diagnosis.

Parameters:

locale - locale to use; uses default if null

timeZone - time zone to use for formatting dates; uses default if null

Returns:

localized message for the diagnosis