oracle.ifs.core.beans

Class ControllerState

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

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieControllerState

public class ControllerState
extends TieRuntimeState

A ControllerState is used to track the data and drive the execution of managing the ECMSDK runtime system by the Controller.

Author:

Dave Long

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	CHALLENGERACKNOWLEDGEDATE_ATTRIBUTE The name of the Attribute representing The date of the last acknowledge by the Node challenging to act as the controller.
static String	CHALLENGERNODESTATE_ATTRIBUTE The name of the Attribute representing The NodeState that is is challenging to act as the runtime controller.
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	CONTROLLERACKNOWLEDGEDATE_ATTRIBUTE The name of the Attribute representing The date of the last acknowledge by the Node acting as the controller.
static String	CONTROLLERNODESTATE_ATTRIBUTE The name of the Attribute representing The NodeState that is acting as the runtime controller.

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	ControllerState(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a ControllerState object.

Method Summary

Modifier and Type	Method and Description
void	acknowledgeChallenger() Acknowledge as Challenger.
void	acknowledgeController() Acknowledge as Controller.
void	checkControllerActions(RuntimeState rs) Checks the specified RuntimeState for any required Controller actions.
protected void	clearChallenger() Clear the current Challenger.
void	clearController() Clear the Controller.
static ControllerState	create(LibrarySession sess, String name, List<AttributeValueTable> propsList) Create a ControllerState based on the specified inputs.
static ControllerState	get(LibrarySession session) Gets the singleton ControllerState instance.
long	getAcknowledgeDateExpirationPeriod() Gets the acknowledge date expiration period, expressed as a number of milliseconds such as 40000.
String	getAcknowledgeDateExpirationPeriodString() Gets the acknowledge date expiration period, expressed as a String such as "40S".
Date	getChallengerAcknowledgeDate() Gets The date of the last acknowledge by the Node challenging to act as the controller.
NodeState	getChallengerNodeState() Gets The NodeState that is is challenging to act as the runtime controller.
Date	getControllerAcknowledgeDate() Gets The date of the last acknowledge by the Node acting as the controller.
NodeState	getControllerNodeState() Gets The NodeState that is acting as the runtime controller.
ControllerPlan	getControllerPlan() Get the current ControllerPlan.
ControllerPlanExecution	getControllerPlanExecution() Get the current ControllerPlanExecution.
static String	getRuntimeSystemSummary(LibrarySession session, boolean showDates) Gets a basic printable Runtime system summary.
void	handleEvent(IfsEvent event) Handles the specified event.
boolean	hasChallengerDuties(NodeState callingNode) Detects if there are any regular challenge duties.
boolean	isAcknowledgeDateExpired(Date ackDate) Checks if the specified acknowledge date is non-null and representing a date that is older than the specified time period associated with this object.
void	performTimedChallengerDuties(NodeState callingNode) Handles the regular challenge duties.
void	performTimedControllerDuties(NodeState callingNode) Perform timed Controller duties.
void	setControllerPlan(ControllerPlan cplan) Set the current ControllerPlan.
void	setControllerPlanExecution(ControllerPlanExecution cplanExec) Set the current ControllerPlanExecution.
void	takeoverChallenger(NodeState callingNode) Take over as Challenger.
protected void	takeoverController(NodeState callingNode) Take over as Controller.

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

addStateProperty, getAuditEvents, getConfigurationBundle, getConfigurationName, getConfigurationOverrideAuditEventKey, 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, 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, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, 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

CONTROLLERNODESTATE_ATTRIBUTE

public static final String CONTROLLERNODESTATE_ATTRIBUTE

The name of the Attribute representing The NodeState that is acting as the runtime controller.

See Also:

Constant Field Values

CONTROLLERACKNOWLEDGEDATE_ATTRIBUTE

public static final String CONTROLLERACKNOWLEDGEDATE_ATTRIBUTE

The name of the Attribute representing The date of the last acknowledge by the Node acting as the controller.

See Also:

Constant Field Values

CHALLENGERNODESTATE_ATTRIBUTE

public static final String CHALLENGERNODESTATE_ATTRIBUTE

The name of the Attribute representing The NodeState that is is challenging to act as the runtime controller.

See Also:

Constant Field Values

CHALLENGERACKNOWLEDGEDATE_ATTRIBUTE

public static final String CHALLENGERACKNOWLEDGEDATE_ATTRIBUTE

The name of the Attribute representing The date of the last acknowledge by the Node challenging to act as the controller.

See Also:

Constant Field Values

Constructor Detail

ControllerState

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

Construct a ControllerState object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

create

public static ControllerState create(LibrarySession sess,
                                     String name,
                                     List<AttributeValueTable> propsList)
                              throws IfsException

Create a ControllerState based on the specified inputs.

Parameters:

sess - the session context

name - the name to use for the instance

propsList - the initial state properties

Returns:

the newly created ControllerState

Throws:

IfsException - if the operation fails

(Published)

getControllerNodeState

public NodeState getControllerNodeState()
                                 throws IfsException

Gets The NodeState that is acting as the runtime controller.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getControllerAcknowledgeDate

public Date getControllerAcknowledgeDate()
                                  throws IfsException

Gets The date of the last acknowledge by the Node acting as the controller.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getChallengerNodeState

public NodeState getChallengerNodeState()
                                 throws IfsException

Gets The NodeState that is is challenging to act as the runtime controller.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getChallengerAcknowledgeDate

public Date getChallengerAcknowledgeDate()
                                  throws IfsException

Gets The date of the last acknowledge by the Node challenging to act as the controller.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

get

public static ControllerState get(LibrarySession session)
                           throws IfsException

Gets the singleton ControllerState instance.

Parameters:

session - the session context

Returns:

the singleton ControllerState instance

Throws:

IfsException - if the operation fails, or if the singleton object does not exist

getRuntimeSystemSummary

public static String getRuntimeSystemSummary(LibrarySession session,
                                             boolean showDates)
                                      throws IfsException

Gets a basic printable Runtime system summary.

Parameters:

session - the session context

showDates - whether to show the date values

Returns:

the Runtime system summary

Throws:

IfsException - if the operation fails

performTimedControllerDuties

public void performTimedControllerDuties(NodeState callingNode)
                                  throws IfsException

Perform timed Controller duties.

Called from the Node that is currently listed as the Controller. First check to see if that Node has been challenged as the Controller - the current implementation assumes that the challenger had a good reason to challenge (e.g. the current Controller was not acknowledging in a timely manner), so it gives up the Controller role, allowing the challenger to take over.

Parameters:

callingNode - the NodeState for the caller

Throws:

IfsException - if the operation fails

(Published)

hasChallengerDuties

public boolean hasChallengerDuties(NodeState callingNode)
                            throws IfsException

Detects if there are any regular challenge duties.

Parameters:

callingNode - the NodeState for the caller

Returns:

true iff there are challenge duties

Throws:

IfsException - if the operation fails

(Published)

performTimedChallengerDuties

public void performTimedChallengerDuties(NodeState callingNode)
                                  throws IfsException

Handles the regular challenge duties.

Parameters:

callingNode - the NodeState for the caller

Throws:

IfsException - if the operation fails

(Published)

acknowledgeController

public void acknowledgeController()
                           throws IfsException

Acknowledge as Controller.

Throws:

IfsException - if the operation fails

(Unpublished)

takeoverController

protected void takeoverController(NodeState callingNode)
                           throws IfsException

Take over as Controller.

Parameters:

callingNode - the NodeState for the caller

Throws:

IfsException - if the operation fails

(Unpublished)

clearController

public void clearController()
                     throws IfsException

Clear the Controller.

Throws:

IfsException - if the operation fails

(Unpublished)

acknowledgeChallenger

public void acknowledgeChallenger()
                           throws IfsException

Acknowledge as Challenger.

Throws:

IfsException - if the operation fails

(Unpublished)

takeoverChallenger

public void takeoverChallenger(NodeState callingNode)
                        throws IfsException

Take over as Challenger.

Parameters:

callingNode - the NodeState for the caller

Throws:

IfsException - if the operation fails

(Unpublished)

clearChallenger

protected void clearChallenger()
                        throws IfsException

Clear the current Challenger.

Throws:

IfsException - if the operation fails

(Unpublished)

isAcknowledgeDateExpired

public boolean isAcknowledgeDateExpired(Date ackDate)
                                 throws IfsException

Checks if the specified acknowledge date is non-null and representing a date that is older than the specified time period associated with this object.

If the specified Date object is null, false is returned. Note: this time period is currently hardcoded to be 30 seconds.

Parameters:

ackDate - the Date of last ack (or null if none)

Returns:

true iff the specified value is non-null and old

Throws:

IfsException - if the operation fails

(Published)

checkControllerActions

public void checkControllerActions(RuntimeState rs)
                            throws IfsException

Checks the specified RuntimeState for any required Controller actions.

This is also called by Node when a special IfsEvent is received.

Parameters:

rs - the RuntimeState to check

Throws:

IfsException - if the operation fails

(Published)

getControllerPlan

public ControllerPlan getControllerPlan()
                                 throws IfsException

Get the current ControllerPlan.

Returns:

the current ControllerPlan

Throws:

IfsException - if the operation fails

(Published)

setControllerPlan

public void setControllerPlan(ControllerPlan cplan)
                       throws IfsException

Set the current ControllerPlan.

Parameters:

cplan - the ControllerPlan

Throws:

IfsException - if the operation fails

(Published)

getControllerPlanExecution

public ControllerPlanExecution getControllerPlanExecution()
                                                   throws IfsException

Get the current ControllerPlanExecution.

Returns:

the current ControllerPlanExecution

Throws:

IfsException - if the operation fails

(Published)

setControllerPlanExecution

public void setControllerPlanExecution(ControllerPlanExecution cplanExec)
                                throws IfsException

Set the current ControllerPlanExecution.

Parameters:

cplanExec - the current ControllerPlanExecution

Throws:

IfsException - if the operation fails

(Published)

getAcknowledgeDateExpirationPeriodString

public String getAcknowledgeDateExpirationPeriodString()
                                                throws IfsException

Gets the acknowledge date expiration period, expressed as a String such as "40S".

Returns:

the acknowledge date expiration period

Throws:

IfsException - if the operation fails

(Published)

getAcknowledgeDateExpirationPeriod

public long getAcknowledgeDateExpirationPeriod()
                                        throws IfsException

Gets the acknowledge date expiration period, expressed as a number of milliseconds such as 40000.

Returns:

the acknowledge date expiration period

Throws:

IfsException - if the operation fails

(Published)

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

Description copied from class: LibraryObject

Handles the specified event.

Specified by:

handleEvent in interface IfsEventHandler

Overrides:

handleEvent in class LibraryObject

Parameters:

event - the event

Throws:

IfsException - if the operation fails