oracle.ifs.core.beans

Class RuntimeState

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.core.beans.RuntimeState

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieRuntimeState

public class RuntimeState
extends TieSystemObject

A RuntimeState is an abstract class used to track the runtime state of Nodes, services, Servers, and Handlers.

Author:

Dave Long

(Published)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RuntimeState.Status Enumeration for the various statuses.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	CONFIGURATIONBUNDLE_ATTRIBUTE Name of the ConfigurationBundle Attribute.
static String	CONFIGURATIONNAME_ATTRIBUTE Name of the ConfigurationName Attribute.
static String	CONFIGURATIONOVERRIDEBUNDLE_ATTRIBUTE Name of the ConfigurationOverrideBundle Attribute.
static String	CONTROLLERALERT_ATTRIBUTE Name of the ControllerAlert Attribute.
static String	CONTROLLERREPLY_ATTRIBUTE Name of the ControllerReply Attribute.
static String	CONTROLLERREQUEST_ATTRIBUTE Name of the ControllerRequest Attribute.
static String	CREATEDATE_ATTRIBUTE Name of the CreateDate Attribute.
static String	DISPOSEDATE_ATTRIBUTE Name of the DisposeDate Attribute.
static String	MANAGINGNODESTATE_ATTRIBUTE Name of the Attribute which holds the managing NodeState.
static String	NAME_ATTRIBUTE Name of the Name Attribute.
static String	RUNTIMESTATEBUNDLE_ATTRIBUTE Name of the RuntimeStateBundle Attribute.
static String	STATEPROPERTYTABLE_ATTRIBUTE Name of the StatePropertyTable Attribute.
static String	STATUS_ATTRIBUTE Name of the Status Attribute.
static int	STATUSCODE_DISPOSED The ControllerRequest code to Resume an object after it was subsequently Suspended.
static int	STATUSCODE_FINALIZED The ControllerRequest code to apply configuration overrides to an object.
static int	STATUSCODE_RUNNING The ControllerRequest code to Start an object after it was subsequently stopped.
static int	STATUSCODE_STARTING The ControllerRequest code to Restart an object.
static int	STATUSCODE_STOPPED The ControllerRequest code to Start an object for the first time, also known as "Load and Start" for Servers.
static int	STATUSCODE_STOPPING The ControllerRequest code to Stop an object after it was subsequently stopped.
static int	STATUSCODE_SUSPENDED The ControllerRequest code to Suspend an object taht is running.
static int	STATUSCODE_UNKNOWN The ControllerRequest code that indicates no request is in progress.
static String	STATUSDATE_ATTRIBUTE Name of the 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	RuntimeState(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a RuntimeState object.

Method Summary

Modifier and Type	Method and Description
void	addStateProperty(String key, AttributeValue val) Adds (or replaces) a state property.
AuditEvent[]	getAuditEvents() Gets all audit events that have been posted on the target.
PropertyBundle	getConfigurationBundle() Returns the Configuration PropertyBundle that is used to reflect the initial configuration.
String	getConfigurationName() Returns the name of the Configuration object used to create the runtime object reflected by this RuntimeState.
protected String	getConfigurationOverrideAuditEventKey() Gets the Audit Event key to use for posting configuration overrides.
PropertyBundle	getConfigurationOverrideBundle() Returns the Configuration Override PropertyBundle that is used to reflect any overrides to the initial configuration.
AttributeValue	getConfigurationOverridePropertyValue(String key) Returns a configuration override property from the Configuration Override PropertyBundle.
AttributeValue	getConfigurationPropertyValue(String key) Returns a configuration property from the Configuration PropertyBundle.
ControllerAlert	getControllerAlert() Returns the ControllerAlert in effect for this instance.
ControllerReply	getControllerReply() Returns the ControllerReply in effect for this instance.
ControllerRequest	getControllerRequest() Returns the ControllerRequest in effect for this instance.
Date	getCreateDate() Returns the date this object was created.
Date	getDisposeDate() Returns the date when the Runtime object reflected by this RuntimeState was disposed.
NodeState	getManagingNodeState() Returns the NodeState corresponding to the Node that is managing this instance.
NodeState	getNodeState() Returns the NodeState that is intended to manage the instance.
String	getRuntimeClassification() Returns the runtime classification fragment used by the Controller to assign this instance.
PropertyBundle	getRuntimeStateBundle() Returns the Runtime State PropertyBundle that is used to reflect the state of the running object.
AttributeValue	getRuntimeStatePropertyValue(String key) Returns a runtime state property from the runtime state PropertyBundle.
static RuntimeState[]	getRuntimeStates(LibrarySession session) Selects the set of RuntimeState instances that are active.
AttributeValue	getStateProperty(String key) Returns the value of a state property from the StatePropertyTable.
SimplePropertyTable	getStatePropertyTable() Returns the State Property Table (as an embedded SimplePropertyTable) that is used to reflect the state of the runtime object.
AttributeValueTable	getStatePropertyTableSnapshot() Returns a static snapshot of the State Property Table.
RuntimeState.Status	getStatus() Gets the status of the RuntimeState (enumerated).
int	getStatusCode() Gets the status code of the RuntimeState (enumerated).
Date	getStatusDate() Returns the date this object last experienced a Status change.
String	getStatusName() Gets the name of the status of the marking (enumerated).
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
boolean	isAssigned() Gets indication as to whether this instance was assigned by the Controller.
boolean	isControllerReplyActive() Returns true if there is an active ControllerReply in effect for this instance.
boolean	isControllerRequestActive() Returns true if there is an active ControllerRequest in effect for this instance.
boolean	isDisposed() Returns true if this instance is disposed.
boolean	isFinalized() Returns true if this instance is finalized.
boolean	isRunning() Returns true if this instance has the status of RUNNING.
boolean	isStopped() Returns true if this instance has the status of STOPPED.
boolean	isStopping() Returns true if this instance has the status of STOPPING.
AuditEvent	postAuditEvent(String eventKey) Posts an audit event, without any properties.
AuditEvent	postAuditEvent(String eventKey, AttributeValue[] props) Posts an audit event, with the specified properties.
AuditEvent	postAuditEvent(String eventKey, Long auxNumber) Posts an audit event, without any properties.
AuditEvent	postAuditEvent(String eventKey, String auxString) Posts an audit event, without any properties.
AuditEvent	postAuditEvent(String eventKey, String auxString, Long auxNumber, AttributeValue[] props) Posts an audit event, with the specified properties.
void	postConfigurationOverrideRequest(AttributeValueTable overrides) Posts configuration override request for this RuntimeState.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
void	putConfigurationOverrideProperty(String name, AttributeValue av) Adds a Property to the Configuration override PropertyBundle.
void	putConfigurationProperty(String name, AttributeValue av) Adds a Property to the Configuration PropertyBundle.
void	putRuntimeStateProperty(String name, AttributeValue av) Adds a Property to the runtime state PropertyBundle.
void	removeAllConfigurationOverrideProperties() Removes all Configuration Override Properties.
void	removeAllConfigurationProperties() Removes all Configuration Properties.
void	removeAllRuntimeStateProperties() Removes all runtime state Properties.
void	removeAllStateProperties() Removes all state properties.
void	removeConfigurationOverrideProperty(String name) Removes a Configuration Override Property.
void	removeConfigurationProperty(String name) Removes a Configuration Property.
void	removeRuntimeStateProperty(String name) Removes a runtime state Property.
void	removeStateProperty(String key) Removes a state property.
void	setConfigurationBundle(PropertyBundle bundle) Sets the Configuration PropertyBundle.
void	setConfigurationOverrideBundle(PropertyBundle bundle) Sets the Configuration Override PropertyBundle.
void	setStatus(RuntimeState.Status status) Sets a status.
void	setStatusCode(int statusCode) Sets a new status code.
void	setStatusDisposed() Sets a status of "Disposed".
void	setStatusFinalized() Sets a status of "Finalized".
void	setStatusRunning() Sets a status of "Running".
void	setStatusStarting() Sets a status of "Starting".
void	setStatusStopped() Sets a status of "Stopped".
void	setStatusStopping() Sets a status of "Stopping".
void	setStatusSuspended() Sets a status of "Suspended".
void	updateControllerReplyForAcknowledge() Update the instance's ControllerReply to respond with a simple "acknowledge" (ACK).
void	updateControllerReplyForNonAcknowledge() Update the instance's ControllerReply to respond with a simple "non-acknowledge" (NACK).
void	updateForSimpleControllerAlert(int code) Update the instance's ControllerAlert to post a simple alert.
void	updateForSimpleControllerAlert(int code, ControllerJob job) Update the instance's ControllerAlert to post a simple alert, along with an optional associated ControllerJob.
void	updateForSimpleControllerJob(ControllerJob job) Update the instance's ControllerRequest to place a simple ControllerJob.
void	updateForSimpleControllerReply(int code) Update the instance's ControllerReply to respond with a simple reply.
void	updateForSimpleControllerRequest(int code) Update the instance's ControllerRequest to place a simple request.
void	updateForSimpleControllerRequest(int code, ControllerJob job) Update the instance's ControllerRequest to place a simple request.

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, 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

(Published)

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

Name of the Name Attribute.

See Also:

Constant Field Values

(Published)

CONFIGURATIONNAME_ATTRIBUTE

public static final String CONFIGURATIONNAME_ATTRIBUTE

Name of the ConfigurationName Attribute.

See Also:

Constant Field Values

(Published)

STATUS_ATTRIBUTE

public static final String STATUS_ATTRIBUTE

Name of the Status Attribute.

See Also:

Constant Field Values

(Published)

STATUSDATE_ATTRIBUTE

public static final String STATUSDATE_ATTRIBUTE

Name of the StatusDate Attribute.

See Also:

Constant Field Values

(Published)

CREATEDATE_ATTRIBUTE

public static final String CREATEDATE_ATTRIBUTE

Name of the CreateDate Attribute.

See Also:

Constant Field Values

(Published)

DISPOSEDATE_ATTRIBUTE

public static final String DISPOSEDATE_ATTRIBUTE

Name of the DisposeDate Attribute.

See Also:

Constant Field Values

(Published)

CONFIGURATIONBUNDLE_ATTRIBUTE

public static final String CONFIGURATIONBUNDLE_ATTRIBUTE

Name of the ConfigurationBundle Attribute.

See Also:

Constant Field Values

(Published)

CONFIGURATIONOVERRIDEBUNDLE_ATTRIBUTE

public static final String CONFIGURATIONOVERRIDEBUNDLE_ATTRIBUTE

Name of the ConfigurationOverrideBundle Attribute.

See Also:

Constant Field Values

(Published)

RUNTIMESTATEBUNDLE_ATTRIBUTE

public static final String RUNTIMESTATEBUNDLE_ATTRIBUTE

Name of the RuntimeStateBundle Attribute.

See Also:

Constant Field Values

(Published)

STATEPROPERTYTABLE_ATTRIBUTE

public static final String STATEPROPERTYTABLE_ATTRIBUTE

Name of the StatePropertyTable Attribute.

See Also:

Constant Field Values

(Published)

MANAGINGNODESTATE_ATTRIBUTE

public static final String MANAGINGNODESTATE_ATTRIBUTE

Name of the Attribute which holds the managing NodeState.

See Also:

Constant Field Values

(Published)

CONTROLLERREQUEST_ATTRIBUTE

public static final String CONTROLLERREQUEST_ATTRIBUTE

Name of the ControllerRequest Attribute.

See Also:

Constant Field Values

(Published)

CONTROLLERREPLY_ATTRIBUTE

public static final String CONTROLLERREPLY_ATTRIBUTE

Name of the ControllerReply Attribute.

See Also:

Constant Field Values

(Published)

CONTROLLERALERT_ATTRIBUTE

public static final String CONTROLLERALERT_ATTRIBUTE

Name of the ControllerAlert Attribute.

See Also:

Constant Field Values

(Published)

STATUSCODE_UNKNOWN

public static final int STATUSCODE_UNKNOWN

The ControllerRequest code that indicates no request is in progress.

See Also:

Constant Field Values

(Published)

STATUSCODE_STOPPED

public static final int STATUSCODE_STOPPED

The ControllerRequest code to Start an object for the first time, also known as "Load and Start" for Servers.

See Also:

Constant Field Values

(Published)

STATUSCODE_RUNNING

public static final int STATUSCODE_RUNNING

The ControllerRequest code to Start an object after it was subsequently stopped.

See Also:

Constant Field Values

(Published)

STATUSCODE_STOPPING

public static final int STATUSCODE_STOPPING

The ControllerRequest code to Stop an object after it was subsequently stopped.

See Also:

Constant Field Values

(Published)

STATUSCODE_STARTING

public static final int STATUSCODE_STARTING

The ControllerRequest code to Restart an object.

See Also:

Constant Field Values

(Published)

STATUSCODE_SUSPENDED

public static final int STATUSCODE_SUSPENDED

The ControllerRequest code to Suspend an object taht is running.

See Also:

Constant Field Values

(Published)

STATUSCODE_DISPOSED

public static final int STATUSCODE_DISPOSED

The ControllerRequest code to Resume an object after it was subsequently Suspended.

See Also:

Constant Field Values

(Published)

STATUSCODE_FINALIZED

public static final int STATUSCODE_FINALIZED

The ControllerRequest code to apply configuration overrides to an object.

See Also:

Constant Field Values

(Published)

Constructor Detail

RuntimeState

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

Constructs a RuntimeState object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Description copied from class: LibraryObject

Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true if the object has a NAME attribute.

Throws:

IfsException - if operation fails.

getConfigurationName

public String getConfigurationName()
                            throws IfsException

Returns the name of the Configuration object used to create the runtime object reflected by this RuntimeState.

Returns:

the name of the associated Configuration object

Throws:

IfsException - if the operation fails.

getStatusCode

public int getStatusCode()
                  throws IfsException

Gets the status code of the RuntimeState (enumerated).

Returns:

the code of the status

Throws:

IfsException - if the operation fails

getStatus

public RuntimeState.Status getStatus()
                              throws IfsException

Gets the status of the RuntimeState (enumerated).

Returns:

the status of the RuntimeState

Throws:

IfsException - if the operation fails

getStatusName

public String getStatusName()
                     throws IfsException

Gets the name of the status of the marking (enumerated).

Returns:

the name of the status of the marking

Throws:

IfsException - if the operation fails

getStatusDate

public Date getStatusDate()
                   throws IfsException

Returns the date this object last experienced a Status change.

Returns:

Date of last status change

Throws:

IfsException - if the operation fails

(Published)

getCreateDate

public Date getCreateDate()
                   throws IfsException

Returns the date this object was created.

Returns:

Date of creation

Throws:

IfsException - if the operation fails

(Published)

getDisposeDate

public Date getDisposeDate()
                    throws IfsException

Returns the date when the Runtime object reflected by this RuntimeState was disposed.

Returns:

Date the Runtime object was disposed

Throws:

IfsException - if the operation fails

(Published)

isRunning

public boolean isRunning()
                  throws IfsException

Returns true if this instance has the status of RUNNING.

Returns:

true if this instance has the status of RUNNING

Throws:

IfsException - if the operation fails

(Published)

isStopped

public boolean isStopped()
                  throws IfsException

Returns true if this instance has the status of STOPPED.

Returns:

true if this instance has the status of STOPPED

Throws:

IfsException - if the operation fails

(Published)

isStopping

public boolean isStopping()
                   throws IfsException

Returns true if this instance has the status of STOPPING.

Returns:

true if this instance has the status of STOPPING

Throws:

IfsException - if the operation fails

(Published)

isDisposed

public boolean isDisposed()
                   throws IfsException

Returns true if this instance is disposed.

Returns:

true if this instance is disposed

Throws:

IfsException - if the operation fails

(Published)

isFinalized

public boolean isFinalized()
                    throws IfsException

Returns true if this instance is finalized.

Returns:

true if this instance is finalized

Throws:

IfsException - if the operation fails

(Published)

getManagingNodeState

public NodeState getManagingNodeState()
                               throws IfsException

Returns the NodeState corresponding to the Node that is managing this instance.

Returns:

the managing NodeState

Throws:

IfsException - if operation fails

(Published)

getNodeState

public NodeState getNodeState()
                       throws IfsException

Returns the NodeState that is intended to manage the instance.

This is overridden by ServerState and HandlerState to return the NodeState that is specified by the Controller when requesting to Start a Server or Handler. For all other RuntimeState subclasses (namely NodeState and ServiceState), this returns the Managing Node.

Returns:

the Node state

Throws:

IfsException - if operation fails

(Published)

getControllerRequest

public ControllerRequest getControllerRequest()
                                       throws IfsException

Returns the ControllerRequest in effect for this instance.

Returns null if no ControllerRequest is present.

Returns:

the ControllerRequest

Throws:

IfsException - if operation fails

(Published)

getControllerReply

public ControllerReply getControllerReply()
                                   throws IfsException

Returns the ControllerReply in effect for this instance.

Returns null if no ControllerReply is present.

Returns:

the ControllerReply

Throws:

IfsException - if operation fails

(Published)

getControllerAlert

public ControllerAlert getControllerAlert()
                                   throws IfsException

Returns the ControllerAlert in effect for this instance.

Returns null if no ControllerAlert is present.

Returns:

the ControllerAlert

Throws:

IfsException - if operation fails

(Published)

isControllerRequestActive

public boolean isControllerRequestActive()
                                  throws IfsException

Returns true if there is an active ControllerRequest in effect for this instance.

This performs additional checks to eliminate any potentially stale data from the cache in making this determination. It has the side effect of clearing the target object and its ControllerRequest from the data cache.

Returns:

true if there is an active ControllerRequest

Throws:

IfsException - if operation fails

(Published)

isControllerReplyActive

public boolean isControllerReplyActive()
                                throws IfsException

Returns true if there is an active ControllerReply in effect for this instance.

This performs additional checks to eliminate any potentially stale data from the cache in making this determination. It has the side effect of clearing the target object and its ControllerReply from the data cache.

Returns:

true if there is an active ControllerReply

Throws:

IfsException - if operation fails

(Published)

isAssigned

public boolean isAssigned()
                   throws IfsException

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

Always returns false for RuntimeStates other than ServerState and HandlerState.

Returns:

false, unless overridden

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.

Always returns null for RuntimeStates other than ServerState and HandlerState.

Returns:

null, unless overridden

Throws:

IfsException - if operation fails

(Published)

getConfigurationBundle

public PropertyBundle getConfigurationBundle()
                                      throws IfsException

Returns the Configuration PropertyBundle that is used to reflect the initial configuration.

Returns null if no PropertyBundle is present.

Returns:

the configuration PropertyBundle

Throws:

IfsException - if operation fails

(Published)

getConfigurationPropertyValue

public AttributeValue getConfigurationPropertyValue(String key)
                                             throws IfsException

Returns a configuration property from the Configuration PropertyBundle.

Parameters:

key - the property's key

Returns:

the property value, or null if no property exists with that key

Throws:

IfsException - if the operation fails

(Published)

getConfigurationOverrideBundle

public PropertyBundle getConfigurationOverrideBundle()
                                              throws IfsException

Returns the Configuration Override PropertyBundle that is used to reflect any overrides to the initial configuration.

Returns null if no PropertyBundle is present.

Returns:

the configuration override PropertyBundle

Throws:

IfsException - if operation fails

(Published)

getConfigurationOverridePropertyValue

public AttributeValue getConfigurationOverridePropertyValue(String key)
                                                     throws IfsException

Returns a configuration override property from the Configuration Override PropertyBundle.

Parameters:

key - the property's key

Returns:

the property value, or null if no property exists with that key

Throws:

IfsException - if the operation fails

(Published)

getRuntimeStates

public static RuntimeState[] getRuntimeStates(LibrarySession session)
                                       throws IfsException

Selects the set of RuntimeState instances that are active.

The RuntimeState objects will be sorted by ID.

Parameters:

session - session context

Returns:

array of RuntimeState instances

Throws:

IfsException - if operation fails

getRuntimeStateBundle

public PropertyBundle getRuntimeStateBundle()
                                     throws IfsException

Returns the Runtime State PropertyBundle that is used to reflect the state of the running object.

Returns null if no PropertyBundle is present.

Returns:

the runtime state PropertyBundle

Throws:

IfsException - if operation fails

(Published)

getRuntimeStatePropertyValue

public AttributeValue getRuntimeStatePropertyValue(String key)
                                            throws IfsException

Returns a runtime state property from the runtime state PropertyBundle.

Parameters:

key - the property's key

Returns:

the property value, or null if no property exists with that key

Throws:

IfsException - if the operation fails

(Published)

getStatePropertyTable

public SimplePropertyTable getStatePropertyTable()
                                          throws IfsException

Returns the State Property Table (as an embedded SimplePropertyTable) that is used to reflect the state of the runtime object.

Returns:

the runtime state PropertyBundle

Throws:

IfsException - if operation fails

(Published)

getStatePropertyTableSnapshot

public AttributeValueTable getStatePropertyTableSnapshot()
                                                  throws IfsException

Returns a static snapshot of the State Property Table.

Returns:

the static snapshot of the State Property Table

Throws:

IfsException - if operation fails

(Published)

getStateProperty

public AttributeValue getStateProperty(String key)
                                throws IfsException

Returns the value of a state property from the StatePropertyTable.

Parameters:

key - the state property key

Returns:

the value of the state property, or null if the key is not defined

Throws:

IfsException - if operation fails

(Published)

addStateProperty

public void addStateProperty(String key,
                             AttributeValue val)
                      throws IfsException

Adds (or replaces) a state property.

Parameters:

key - the state property key

val - the value of the state property

Throws:

IfsException - if operation fails

(Published)

removeStateProperty

public void removeStateProperty(String key)
                         throws IfsException

Removes a state property.

Parameters:

key - the state property key

Throws:

IfsException - if operation fails

(Published)

removeAllStateProperties

public void removeAllStateProperties()
                              throws IfsException

Removes all state properties.

Throws:

IfsException - if operation fails

(Published)

setStatusCode

public void setStatusCode(int statusCode)
                   throws IfsException

Sets a new status code.

Parameters:

statusCode - the new Status code

Throws:

IfsException - if operation fails

setStatus

public void setStatus(RuntimeState.Status status)
               throws IfsException

Sets a status.

Parameters:

status - the new Status

Throws:

IfsException - if operation fails

setStatusStopped

public void setStatusStopped()
                      throws IfsException

Sets a status of "Stopped".

Throws:

IfsException - if operation fails

setStatusRunning

public void setStatusRunning()
                      throws IfsException

Sets a status of "Running".

Throws:

IfsException - if operation fails

setStatusStopping

public void setStatusStopping()
                       throws IfsException

Sets a status of "Stopping".

Throws:

IfsException - if operation fails

setStatusStarting

public void setStatusStarting()
                       throws IfsException

Sets a status of "Starting".

Throws:

IfsException - if operation fails

setStatusSuspended

public void setStatusSuspended()
                        throws IfsException

Sets a status of "Suspended".

Throws:

IfsException - if operation fails

setStatusDisposed

public void setStatusDisposed()
                       throws IfsException

Sets a status of "Disposed".

Throws:

IfsException - if operation fails

setStatusFinalized

public void setStatusFinalized()
                        throws IfsException

Sets a status of "Finalized".

Throws:

IfsException - if operation fails

setConfigurationBundle

public void setConfigurationBundle(PropertyBundle bundle)
                            throws IfsException

Sets the Configuration PropertyBundle.

Parameters:

bundle - the Configuration bundle setting

Throws:

IfsException - if operation fails

(Published)

putConfigurationProperty

public void putConfigurationProperty(String name,
                                     AttributeValue av)
                              throws IfsException

Adds a Property to the Configuration PropertyBundle.

Parameters:

name - the name of the new property

av - the value of the new property

Throws:

IfsException - if operation fails

(Published)

removeConfigurationProperty

public void removeConfigurationProperty(String name)
                                 throws IfsException

Removes a Configuration Property.

Parameters:

name - the name of the property to remove

Throws:

IfsException - if operation fails

(Published)

removeAllConfigurationProperties

public void removeAllConfigurationProperties()
                                      throws IfsException

Removes all Configuration Properties.

Throws:

IfsException - if operation fails

(Published)

setConfigurationOverrideBundle

public void setConfigurationOverrideBundle(PropertyBundle bundle)
                                    throws IfsException

Sets the Configuration Override PropertyBundle.

Parameters:

bundle - the Configuration override bundle setting

Throws:

IfsException - if operation fails

(Published)

putConfigurationOverrideProperty

public void putConfigurationOverrideProperty(String name,
                                             AttributeValue av)
                                      throws IfsException

Adds a Property to the Configuration override PropertyBundle.

Parameters:

name - the name of the new property

av - the value of the new property

Throws:

IfsException - if operation fails

(Published)

removeConfigurationOverrideProperty

public void removeConfigurationOverrideProperty(String name)
                                         throws IfsException

Removes a Configuration Override Property.

Parameters:

name - the name of the property to remove

Throws:

IfsException - if operation fails

(Published)

removeAllConfigurationOverrideProperties

public void removeAllConfigurationOverrideProperties()
                                              throws IfsException

Removes all Configuration Override Properties.

Throws:

IfsException - if operation fails

(Published)

putRuntimeStateProperty

public void putRuntimeStateProperty(String name,
                                    AttributeValue av)
                             throws IfsException

Adds a Property to the runtime state PropertyBundle.

Parameters:

name - the name of the new property

av - the value of the new property

Throws:

IfsException - if operation fails

(Published)

removeRuntimeStateProperty

public void removeRuntimeStateProperty(String name)
                                throws IfsException

Removes a runtime state Property.

Parameters:

name - the name of the property to remove

Throws:

IfsException - if operation fails

(Published)

removeAllRuntimeStateProperties

public void removeAllRuntimeStateProperties()
                                     throws IfsException

Removes all runtime state Properties.

Throws:

IfsException - if operation fails

(Published)

getAuditEvents

public AuditEvent[] getAuditEvents()
                            throws IfsException

Gets all audit events that have been posted on the target.

Returns:

the events that have been posted

Throws:

IfsException - if the operation fails

(Published)

postAuditEvent

public AuditEvent postAuditEvent(String eventKey)
                          throws IfsException

Posts an audit event, without any properties.

Parameters:

eventKey - the event key

Returns:

the event that was posted

Throws:

IfsException - if the operation fails

(Published)

postAuditEvent

public AuditEvent postAuditEvent(String eventKey,
                                 Long auxNumber)
                          throws IfsException

Posts an audit event, without any properties.

Parameters:

eventKey - the event key

auxNumber - the auxiliary number payload

Returns:

the event that was posted

Throws:

IfsException - if the operation fails

(Published)

postAuditEvent

public AuditEvent postAuditEvent(String eventKey,
                                 String auxString)
                          throws IfsException

Posts an audit event, without any properties.

Parameters:

eventKey - the event key

auxString - the auxiliary String payload

Returns:

the event that was posted

Throws:

IfsException - if the operation fails

(Published)

postAuditEvent

public AuditEvent postAuditEvent(String eventKey,
                                 AttributeValue[] props)
                          throws IfsException

Posts an audit event, with the specified properties.

Parameters:

eventKey - the event key

props - the event properties

Returns:

the event that was posted

Throws:

IfsException - if the operation fails

(Published)

postAuditEvent

public AuditEvent postAuditEvent(String eventKey,
                                 String auxString,
                                 Long auxNumber,
                                 AttributeValue[] props)
                          throws IfsException

Posts an audit event, with the specified properties.

Parameters:

eventKey - the event key

auxString - the auxiliary String payload

auxNumber - the auxiliary number payload

props - the event properties

Returns:

the event that was posted

Throws:

IfsException - if the operation fails

(Published)

postConfigurationOverrideRequest

public void postConfigurationOverrideRequest(AttributeValueTable overrides)
                                      throws IfsException

Posts configuration override request for this RuntimeState.

Uses getConfigurationOverrideAuditEventKey to determine the audit event key to use.

Parameters:

overrides - the configuration overrides to post

Throws:

IfsException - if the operation fails

(Published)

getConfigurationOverrideAuditEventKey

protected String getConfigurationOverrideAuditEventKey()
                                                throws IfsException

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

Returns:

the Audit Event key

Throws:

IfsException - if the operation fails

(Published)

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being freed in order to all delete or modify objects related to the target object. Subclasses are expected to invoke super.preFree.

Overrides:

preFree in class LibraryObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.

updateForSimpleControllerJob

public void updateForSimpleControllerJob(ControllerJob job)
                                  throws IfsException

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

Parameters:

job - the ControllerJob

Throws:

IfsException - if the operation fails

(Published)

updateForSimpleControllerRequest

public void updateForSimpleControllerRequest(int code)
                                      throws IfsException

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

A "simple" Request is one that only sets the RequestCode and the RequestDate on the ControllerRequest object.

Parameters:

code - the Request code

Throws:

IfsException - if the operation fails

(Published)

updateForSimpleControllerRequest

public void updateForSimpleControllerRequest(int code,
                                             ControllerJob job)
                                      throws IfsException

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

A "simple" Request is one that only sets the RequestCode and the RequestDate on the ControllerRequest object.

Parameters:

code - the Request code

job - the associated ControllerJob (optional)

Throws:

IfsException - if the operation fails

(Published)

updateForSimpleControllerReply

public void updateForSimpleControllerReply(int code)
                                    throws IfsException

Update the instance's ControllerReply to respond with a simple reply.

A "simple" Reply is one that only sets the ReplyCode and the ReplyDate on the ControllerReply object.

Parameters:

code - the Reply code

Throws:

IfsException - if the operation fails

(Published)

updateForSimpleControllerAlert

public void updateForSimpleControllerAlert(int code)
                                    throws IfsException

Update the instance's ControllerAlert to post a simple alert.

A "simple" Alert is one that only sets the AlertCode and the AlertDate on the ControllerAlert object.

Parameters:

code - the Alert code

Throws:

IfsException - if the operation fails

(Published)

updateForSimpleControllerAlert

public void updateForSimpleControllerAlert(int code,
                                           ControllerJob job)
                                    throws IfsException

Update the instance's ControllerAlert to post a simple alert, along with an optional associated ControllerJob.

A "simple" Alert is one that only sets the AlertCode and the AlertDate on the ControllerAlert object.

Parameters:

code - the Alert code

job - the associated ControllerJob, if any

Throws:

IfsException - if the operation fails

(Published)

updateControllerReplyForAcknowledge

public void updateControllerReplyForAcknowledge()
                                         throws IfsException

Update the instance's ControllerReply to respond with a simple "acknowledge" (ACK).

Throws:

IfsException - if the operation fails

(Published)

updateControllerReplyForNonAcknowledge

public void updateControllerReplyForNonAcknowledge()
                                            throws IfsException

Update the instance's ControllerReply to respond with a simple "non-acknowledge" (NACK).

Throws:

IfsException - if the operation fails

(Published)