oracle.ifs.core.beans

Class NodeState

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.NodeState

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieNodeState

public class NodeState
extends TieRuntimeState

A NodeState tracks the runtime state of a Node.

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	CLASS_NAME The name of the ClassObject representing this class.
static String	LASTACKNOWLEDGEDATE_ATTRIBUTE The name of the Attribute that holds the date of the last acknowledge by the running Node.
static String	RUNTIME_PROPERTY_ASSIGNABLE
static String	RUNTIME_PROPERTY_EVENTHANDLERAGENT
static String	RUNTIME_PROPERTY_EXPLICITLYIDLESERVERNAMES
static String	RUNTIME_PROPERTY_FORCEDEXIT
static String	RUNTIME_PROPERTY_SUPPORTEDNODECAPABILITIES
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	NodeState(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a NodeState object.

Method Summary

Modifier and Type	Method and Description
void	addExplicitlyIdleServerName(String serverName) Adds the specified managed Server name to the list of explicitly idle Server names.
static NodeState	create(NodeConfiguration nc, ServiceState serviceState, String nodeName, Long newNodeStateId) Create a NodeState based on the specified inputs.
protected String	getConfigurationOverrideAuditEventKey() Gets the Audit Event key to use for posting configuration overrides.
String	getDefaultLogLevel() Gets the default log level in effect for the running Node.
Level	getEffectiveLogLevel(String loggerName) Gets the effective log level in effect for the running Node for the specified class or package name.
String	getEffectiveLogLevelName(String loggerName) Gets the name of the effective log level in effect for the running Node for the specified class or package name.
ServerState	getEventHandlerAgentState() Gets the ServerState that reflects the EventHandlerAgent, which manages the Handlers.
String[]	getExplicitlyIdleServerNames() Gets the array of explicitly idle Server names.
HandlerState[]	getHandlerStates() Selects the set of HandlerState instances managed by this NodeState.
Date	getLastAcknowledgeDate() Returns the date of the last acknowledge by the running Node.
String[]	getLogLevelOverrides() Gets the log level overrides in effect for the running Node.
static NodeState[]	getNodeStates(LibrarySession session) Selects the set of NodeState instances that are active.
ServerState[]	getServerStates() Selects the set of active ServerState instances managed by this NodeState.
ServiceState	getServiceState() Returns the ServiceState for the service associated with the node that is reflected by this instance.
String[]	getSupportedNodeCapabilities() Gets the array of Node capabilities supported by this instance's Node.
long	getTimeSinceLastAcknowledge() Returns the elapsed time (in ms) since the last acknowledge by the running Node.
boolean	isAssignable() Gets indication as to whether this Node is assignable by the Controller for Servers/Handlers that are assigned.
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	postDisposeNodeRequest() Posts a request to dispose the Node.
void	postLoadServerRequest(String serverName, String scName, AttributeValueTable overrides) Deprecated. 9.3.4.0 use ServerSpecification to add new Servers to a running system
void	postRestartNodeRequest() Posts a request to restart the Node.
void	postStartNodeRequest() Posts a request to Start the Node.
void	postStopNodeRequest() Posts a request to Stop the Node.
void	removeExplicitlyIdleServerName(String serverName) Remove the specified managed Server name from the list of explicitly idle Server names.
void	setAssignable(boolean val) Sets indication as to whether this Node is assignable by the Controller for Servers/Handlers that are assigned.
void	setEventHandlerAgentState(ServerState ss) Gets the ServerState that reflects the EventHandlerAgent, which manages the Handlers.
void	setExitedForcibly(boolean val) Sets indication as to whether this Node was forced to exit due to some irregularity.
void	setExplicitlyIdleServerNames(String[] serverNames) Sets the array of explicitly idle Server names.
void	setLastAcknowledgeDate() Updates the date of the last acknowledge by the running Node to the cuurrent time, adjusted by the DBMS clock offset.
void	setSupportedNodeCapabilities(String[] nodeCaps) Sets the array of Node capabilities supported by this instance's Node.
void	updateForSimpleControllerJob(ControllerJob job) Update the instance's ControllerRequest to place a simple ControllerJob.
boolean	wasExitedForcibly() Gets indication as to whether this Node was forced to exit due to some irregularity.

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

addStateProperty, getAuditEvents, getConfigurationBundle, getConfigurationName, getConfigurationOverrideBundle, getConfigurationOverridePropertyValue, getConfigurationPropertyValue, getControllerAlert, getControllerReply, getControllerRequest, getCreateDate, getDisposeDate, getManagingNodeState, getNodeState, getRuntimeClassification, getRuntimeStateBundle, getRuntimeStatePropertyValue, getRuntimeStates, getStateProperty, getStatePropertyTable, getStatePropertyTableSnapshot, getStatus, getStatusCode, getStatusDate, getStatusName, hasNameAttribute, isAssigned, 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, 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)

LASTACKNOWLEDGEDATE_ATTRIBUTE

public static final String LASTACKNOWLEDGEDATE_ATTRIBUTE

The name of the Attribute that holds the date of the last acknowledge by the running Node.

See Also:

Constant Field Values

(Published)

RUNTIME_PROPERTY_EVENTHANDLERAGENT

public static final String RUNTIME_PROPERTY_EVENTHANDLERAGENT

See Also:

Constant Field Values

RUNTIME_PROPERTY_SUPPORTEDNODECAPABILITIES

public static final String RUNTIME_PROPERTY_SUPPORTEDNODECAPABILITIES

See Also:

Constant Field Values

RUNTIME_PROPERTY_EXPLICITLYIDLESERVERNAMES

public static final String RUNTIME_PROPERTY_EXPLICITLYIDLESERVERNAMES

See Also:

Constant Field Values

RUNTIME_PROPERTY_ASSIGNABLE

public static final String RUNTIME_PROPERTY_ASSIGNABLE

See Also:

Constant Field Values

RUNTIME_PROPERTY_FORCEDEXIT

public static final String RUNTIME_PROPERTY_FORCEDEXIT

See Also:

Constant Field Values

Constructor Detail

NodeState

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

Constructs a NodeState 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 NodeState create(NodeConfiguration nc,
                               ServiceState serviceState,
                               String nodeName,
                               Long newNodeStateId)
                        throws IfsException

Create a NodeState based on the specified inputs.

Parameters:

nc - the NodeConfiguration

serviceState - the associated ServiceState

nodeName - the name of the node

serviceId - the Service ID

newNodeStateId - the ID to use for the NodeState (optional)

Returns:

the newly created NodeState

Throws:

IfsException - if the operation fails

(Published)

getServiceState

public ServiceState getServiceState()
                             throws IfsException

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

Returns:

the Service state

Throws:

IfsException - if operation fails

(Published)

getLastAcknowledgeDate

public Date getLastAcknowledgeDate()
                            throws IfsException

Returns the date of the last acknowledge by the running Node.

Returns:

the date of the last acknowledge

Throws:

IfsException - if the operation fails

(Published)

getTimeSinceLastAcknowledge

public long getTimeSinceLastAcknowledge()
                                 throws IfsException

Returns the elapsed time (in ms) since the last acknowledge by the running Node.

Returns:

the elapsed time (in ms) since the last acknowledge

Throws:

IfsException - if the operation fails

(Published)

getNodeStates

public static NodeState[] getNodeStates(LibrarySession session)
                                 throws IfsException

Selects the set of NodeState instances that are active.

The NodeState objects will be sorted by ID.

Parameters:

session - session context

Returns:

array of NodeState instances

Throws:

IfsException - if operation fails

getServerStates

public ServerState[] getServerStates()
                              throws IfsException

Selects the set of active ServerState instances managed by this NodeState.

The ServerState objects will be sorted by ID.

Returns:

array of ServerState instances managed by this node

Throws:

IfsException - if operation fails

getHandlerStates

public HandlerState[] getHandlerStates()
                                throws IfsException

Selects the set of HandlerState instances managed by this NodeState.

The HandlerState objects will be sorted by ID.

Returns:

array of HandlerState instances managed by this node

Throws:

IfsException - if operation fails

setLastAcknowledgeDate

public void setLastAcknowledgeDate()
                            throws IfsException

Updates the date of the last acknowledge by the running Node to the cuurrent time, adjusted by the DBMS clock offset.

Throws:

IfsException - if the operation fails

(Published)

getEventHandlerAgentState

public ServerState getEventHandlerAgentState()
                                      throws IfsException

Gets the ServerState that reflects the EventHandlerAgent, which manages the Handlers.

Returns:

the ServerState, or none if one is not registered

Throws:

IfsException - if the operation fails

(Published)

setEventHandlerAgentState

public void setEventHandlerAgentState(ServerState ss)
                               throws IfsException

Gets the ServerState that reflects the EventHandlerAgent, which manages the Handlers.

Parameters:

ss - the ServerState, or none if one is not registered

Throws:

IfsException - if the operation fails

(Published)

getSupportedNodeCapabilities

public String[] getSupportedNodeCapabilities()
                                      throws IfsException

Gets the array of Node capabilities supported by this instance's Node.

Returns:

the set of supported Node types

Throws:

IfsException - if the operation fails

(Published)

setSupportedNodeCapabilities

public void setSupportedNodeCapabilities(String[] nodeCaps)
                                  throws IfsException

Sets the array of Node capabilities supported by this instance's Node.

Parameters:

nodeCaps - the set of supported Node types

Throws:

IfsException - if the operation fails

(Published)

getExplicitlyIdleServerNames

public String[] getExplicitlyIdleServerNames()
                                      throws IfsException

Gets the array of explicitly idle Server names.

Returns:

the set of explicitly idle Server names

Throws:

IfsException - if the operation fails

(Published)

setExplicitlyIdleServerNames

public void setExplicitlyIdleServerNames(String[] serverNames)
                                  throws IfsException

Sets the array of explicitly idle Server names.

Parameters:

serverNames - the set of explicitly idle Server names

Throws:

IfsException - if the operation fails

(Published)

addExplicitlyIdleServerName

public void addExplicitlyIdleServerName(String serverName)
                                 throws IfsException

Adds the specified managed Server name to the list of explicitly idle Server names.

Parameters:

serverName - the idle Server name to add

Throws:

IfsException - if the operation fails

(Published)

removeExplicitlyIdleServerName

public void removeExplicitlyIdleServerName(String serverName)
                                    throws IfsException

Remove the specified managed Server name from the list of explicitly idle Server names.

Parameters:

serverName - the idle Server name to remove

Throws:

IfsException - if the operation fails

(Published)

isAssignable

public boolean isAssignable()
                     throws IfsException

Gets indication as to whether this Node is assignable by the Controller for Servers/Handlers that are assigned.

Returns:

true if this Node is assignable; false otherwise

Throws:

IfsException - if the operation fails

(Published)

setAssignable

public void setAssignable(boolean val)
                   throws IfsException

Sets indication as to whether this Node is assignable by the Controller for Servers/Handlers that are assigned.

Parameters:

val - the indication

Throws:

IfsException - if the operation fails

(Published)

wasExitedForcibly

public boolean wasExitedForcibly()
                          throws IfsException

Gets indication as to whether this Node was forced to exit due to some irregularity.

Returns:

true if this Node was forced to exit; false otherwise

Throws:

IfsException - if the operation fails

(Published)

setExitedForcibly

public void setExitedForcibly(boolean val)
                       throws IfsException

Sets indication as to whether this Node was forced to exit due to some irregularity.

Parameters:

val - the indication

Throws:

IfsException - if the operation fails

(Published)

updateForSimpleControllerJob

public void updateForSimpleControllerJob(ControllerJob job)
                                  throws IfsException

Update the instance's ControllerRequest to place a simple ControllerJob.

Overridden by NodeState to handle an optional Job setting to toggle the Assignable state of the NodeState prior to issuing the Simple ControllerJob.

Overrides:

updateForSimpleControllerJob in class RuntimeState

Parameters:

job - the ControllerJob

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)

postLoadServerRequest

public void postLoadServerRequest(String serverName,
                                  String scName,
                                  AttributeValueTable overrides)
                           throws IfsException

Deprecated. 9.3.4.0 use ServerSpecification to add new Servers to a running system

Posts a request to load a new managed Server.

Parameters:

serverName - the name for the new Server

scName - the name of the ServerConfiguration to use

overrides - the configuration overrides to use

Throws:

IfsException - if the operation fails

(Published)

postRestartNodeRequest

public void postRestartNodeRequest()
                            throws IfsException

Posts a request to restart the Node.

Throws:

IfsException - if the operation fails

(Published)

postDisposeNodeRequest

public void postDisposeNodeRequest()
                            throws IfsException

Posts a request to dispose the Node.

Throws:

IfsException - if the operation fails

(Published)

postStartNodeRequest

public void postStartNodeRequest()
                          throws IfsException

Posts a request to Start the Node.

Throws:

IfsException - if the operation fails

(Published)

postStopNodeRequest

public void postStopNodeRequest()
                         throws IfsException

Posts a request to Stop the Node.

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

getLogLevelOverrides

public String[] getLogLevelOverrides()
                              throws IfsException

Gets the log level overrides in effect for the running Node.

Uses the String[] stored in the RuntimeState PropertyBundle via the property "IFS.LOG.LogLevelOverrides". Each String in the returned array uses the syntax: "classOrPackage : level". For example: "oracle.ifs.core.runtime : FINE".

Returns:

the log level override entries

Throws:

IfsException - if the operation fails

(Published)

getDefaultLogLevel

public String getDefaultLogLevel()
                          throws IfsException

Gets the default log level in effect for the running Node.

Uses the String stored in the RuntimeState PropertyBundle via the property "IFS.LOG.DefaultLogLevel". The String returned is the name of a log level, e.g. "INFO".

Returns:

the default log level

Throws:

IfsException - if the operation fails

(Published)

getEffectiveLogLevel

public Level getEffectiveLogLevel(String loggerName)
                           throws IfsException

Gets the effective log level in effect for the running Node for the specified class or package name.

Parameters:

loggerName - the logger name (class or package name); must not be null

Returns:

the log level in effect for the specified logger, or null if the log level cannot be determined

Throws:

IfsException - if the operation fails

(Published)

getEffectiveLogLevelName

public String getEffectiveLogLevelName(String loggerName)
                                throws IfsException

Gets the name of the effective log level in effect for the running Node for the specified class or package name.

Parameters:

loggerName - the logger name (class or package name); must not be null

Returns:

the log level name in effect for the specified logger

Throws:

IfsException - if the operation fails

(Published)