oracle.ifs.core.beans

Class HandlerState

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.core.beans.RuntimeState

oracle.ifs.beans.TieRuntimeState

oracle.ifs.core.beans.HandlerState

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieHandlerState

public class HandlerState
extends TieRuntimeState

A HandlerState tracks the runtime state of an event Handler.

Author:

Dave Long

(Published)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.core.beans.RuntimeState

RuntimeState.Status

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSIGNED_ATTRIBUTE Name of the Assigned Attribute.
static String	AUDITSPECIFICATION_ATTRIBUTE Name of the AuditSpecification Attribute.
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	NODESTATE_ATTRIBUTE Name of the NodeState Attribute
static String	RUNTIMECLASSIFICATION_ATTRIBUTE Name of the RuntimeClassification Attribute.
static String	SERVERSTATE_ATTRIBUTE Name of the ServerState Attribute for the EventhandlerAgent.
static String	SERVICESTATE_ATTRIBUTE Name of the ServiceState Attribute

Fields inherited from class oracle.ifs.core.beans.RuntimeState

CONFIGURATIONBUNDLE_ATTRIBUTE, CONFIGURATIONNAME_ATTRIBUTE, CONFIGURATIONOVERRIDEBUNDLE_ATTRIBUTE, CONTROLLERALERT_ATTRIBUTE, CONTROLLERREPLY_ATTRIBUTE, CONTROLLERREQUEST_ATTRIBUTE, CREATEDATE_ATTRIBUTE, DISPOSEDATE_ATTRIBUTE, MANAGINGNODESTATE_ATTRIBUTE, NAME_ATTRIBUTE, RUNTIMESTATEBUNDLE_ATTRIBUTE, STATEPROPERTYTABLE_ATTRIBUTE, STATUS_ATTRIBUTE, STATUSCODE_DISPOSED, STATUSCODE_FINALIZED, STATUSCODE_RUNNING, STATUSCODE_STARTING, STATUSCODE_STOPPED, STATUSCODE_STOPPING, STATUSCODE_SUSPENDED, STATUSCODE_UNKNOWN, STATUSDATE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HandlerState(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a HandlerState object.

Method Summary

Modifier and Type	Method and Description
static HandlerState	create(AuditSpecification spec, NodeState ns, boolean assigned, String classif) Create a HandlerState based on the specified inputs.
HandlerState	createCopy(NodeState ns) Create a HandlerState based on the target object, using the specified NodeState as the managing Node.
AuditSpecification	getAuditSpecification() Returns the AuditSpecification that was used to created this instance, as indicated by the Controller.
Long	getAuditSpecificationId() Returns the AuditSpecification ID that was used to created this instance, as indicated by the Controller.
protected String	getConfigurationOverrideAuditEventKey() Gets the Audit Event key to use for posting configuration overrides.
NodeState	getNodeState() Returns the NodeState for the node associated with the handler that is reflected by this instance.
String	getRuntimeClassification() Returns the runtime classification fragment used by the Controller to assign this instance.
ServerState	getServerState() Returns the ServerState for the server associated with the handler that is reflected by this instance.
ServiceState	getServiceState() Returns the ServiceState for the service associated with the handler that is reflected by this instance.
boolean	isAssigned() Gets indication as to whether this instance was assigned by the Controller.
protected boolean	isValidEventType(AuditEvent event) Checks to see if the event type in the process of being posted on the target LibraryObject is consistent with the target.
void	postDisposeHandlerRequest() Posts a request to Dispose the Handler.
void	setNodeState(NodeState ns) Sets the NodeState that manages this instance.

Methods inherited from class oracle.ifs.core.beans.RuntimeState

addStateProperty, getAuditEvents, getConfigurationBundle, getConfigurationName, getConfigurationOverrideBundle, getConfigurationOverridePropertyValue, getConfigurationPropertyValue, getControllerAlert, getControllerReply, getControllerRequest, getCreateDate, getDisposeDate, getManagingNodeState, getRuntimeStateBundle, getRuntimeStatePropertyValue, getRuntimeStates, getStateProperty, getStatePropertyTable, getStatePropertyTableSnapshot, getStatus, getStatusCode, getStatusDate, getStatusName, hasNameAttribute, isControllerReplyActive, isControllerRequestActive, isDisposed, isFinalized, isRunning, isStopped, isStopping, postAuditEvent, postAuditEvent, postAuditEvent, postAuditEvent, postAuditEvent, postConfigurationOverrideRequest, preFree, putConfigurationOverrideProperty, putConfigurationProperty, putRuntimeStateProperty, removeAllConfigurationOverrideProperties, removeAllConfigurationProperties, removeAllRuntimeStateProperties, removeAllStateProperties, removeConfigurationOverrideProperty, removeConfigurationProperty, removeRuntimeStateProperty, removeStateProperty, setConfigurationBundle, setConfigurationOverrideBundle, setStatus, setStatusCode, setStatusDisposed, setStatusFinalized, setStatusRunning, setStatusStarting, setStatusStopped, setStatusStopping, setStatusSuspended, updateControllerReplyForAcknowledge, updateControllerReplyForNonAcknowledge, updateForSimpleControllerAlert, updateForSimpleControllerAlert, updateForSimpleControllerJob, updateForSimpleControllerReply, updateForSimpleControllerRequest, updateForSimpleControllerRequest

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

(Published)

SERVICESTATE_ATTRIBUTE

public static final String SERVICESTATE_ATTRIBUTE

Name of the ServiceState Attribute

See Also:

Constant Field Values

(Published)

NODESTATE_ATTRIBUTE

public static final String NODESTATE_ATTRIBUTE

Name of the NodeState Attribute

See Also:

Constant Field Values

(Published)

SERVERSTATE_ATTRIBUTE

public static final String SERVERSTATE_ATTRIBUTE

Name of the ServerState Attribute for the EventhandlerAgent.

See Also:

Constant Field Values

(Published)

AUDITSPECIFICATION_ATTRIBUTE

public static final String AUDITSPECIFICATION_ATTRIBUTE

Name of the AuditSpecification Attribute.

See Also:

Constant Field Values

(Published)

ASSIGNED_ATTRIBUTE

public static final String ASSIGNED_ATTRIBUTE

Name of the Assigned Attribute.

See Also:

Constant Field Values

(Published)

RUNTIMECLASSIFICATION_ATTRIBUTE

public static final String RUNTIMECLASSIFICATION_ATTRIBUTE

Name of the RuntimeClassification Attribute.

See Also:

Constant Field Values

(Published)

Constructor Detail

HandlerState

protected HandlerState(LibrarySession session,
                       Long id,
                       Long classId,
                       S_LibraryObjectData data)
                throws IfsException

Constructs a HandlerState object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

create

public static HandlerState create(AuditSpecification spec,
                                  NodeState ns,
                                  boolean assigned,
                                  String classif)
                           throws IfsException

Create a HandlerState based on the specified inputs.

Parameters:

spec - the AuditSpecification

ns - the Node to assign

assigned - whether the HandlerState was assigned by the Controller

classif - the RuntimeClassification value used to assign

Returns:

the newly created HandlerState

Throws:

IfsException - if the operation fails

(Published)

createCopy

public HandlerState createCopy(NodeState ns)
                        throws IfsException

Create a HandlerState based on the target object, using the specified NodeState as the managing Node.

Parameters:

ns - the Node to manage the instance

Returns:

the newly created HandlerState

Throws:

IfsException - if the operation fails

(Published)

getServiceState

public ServiceState getServiceState()
                             throws IfsException

Returns the ServiceState for the service associated with the handler that is reflected by this instance.

Returns:

the Service state

Throws:

IfsException - if operation fails

(Published)

getNodeState

public NodeState getNodeState()
                       throws IfsException

Returns the NodeState for the node associated with the handler that is reflected by this instance.

Overrides:

getNodeState in class RuntimeState

Returns:

the Node state

Throws:

IfsException - if operation fails

(Published)

getServerState

public ServerState getServerState()
                           throws IfsException

Returns the ServerState for the server associated with the handler that is reflected by this instance.

Returns:

the Server state

Throws:

IfsException - if operation fails

(Published)

getAuditSpecification

public AuditSpecification getAuditSpecification()
                                         throws IfsException

Returns the AuditSpecification that was used to created this instance, as indicated by the Controller.

Returns:

the AuditSpecification

Throws:

IfsException - if operation fails

(Published)

getAuditSpecificationId

public Long getAuditSpecificationId()
                             throws IfsException

Returns the AuditSpecification ID that was used to created this instance, as indicated by the Controller.

Useful variant to get the AuditSpecification ID even if the AuditSpecification object has been freed.

Returns:

the AuditSpecification ID

Throws:

IfsException - if operation fails

(Published)

isAssigned

public boolean isAssigned()
                   throws IfsException

Gets indication as to whether this instance was assigned by the Controller.

Overrides:

isAssigned in class RuntimeState

Returns:

true if this instance was assigned by the Controller

Throws:

IfsException - if operation fails

(Published)

getRuntimeClassification

public String getRuntimeClassification()
                                throws IfsException

Returns the runtime classification fragment used by the Controller to assign this instance.

Overrides:

getRuntimeClassification in class RuntimeState

Returns:

the runtime classification fragment used in assignment

Throws:

IfsException - if the operation fails.

setNodeState

public void setNodeState(NodeState ns)
                  throws IfsException

Sets the NodeState that manages this instance.

This is issued by the Node that takes over management of this Handler.

Parameters:

ns - the managing NodeState

Throws:

IfsException - if operation fails

(Published)

postDisposeHandlerRequest

public void postDisposeHandlerRequest()
                               throws IfsException

Posts a request to Dispose the Handler.

Throws:

IfsException - if the operation fails

(Published)

getConfigurationOverrideAuditEventKey

protected String getConfigurationOverrideAuditEventKey()
                                                throws IfsException

Gets the Audit Event key to use for posting configuration overrides.

Overrides:

getConfigurationOverrideAuditEventKey in class RuntimeState

Returns:

the Audit Event key

Throws:

IfsException - if the operation fails

(Published)

isValidEventType

protected boolean isValidEventType(AuditEvent event)
                            throws IfsException

Checks to see if the event type in the process of being posted on the target LibraryObject is consistent with the target.

Overrides:

isValidEventType in class LibraryObject

Parameters:

event - the event being posted on this object

Returns:

true if the type is consistent; false otherwise

Throws:

IfsException - if the operation fails