public class ControllerPlanExecution extends TieSimpleObject
Modifier and Type | Field and Description |
---|---|
static String |
ACTIVE_ATTRIBUTE
The name of the Attribute representing
An indicator of whether this ControllerJob is still being worked on by the Controller.
|
static String |
ASSIGNEDNODES_ATTRIBUTE
The name of the Attribute representing
the Nodes assigned for execution that matches the Node types
indicated in the associated plan.
|
static String |
CLASS_NAME
The name of the ClassObject representing this class.
|
static String |
CONTROLLERPLAN_ATTRIBUTE
The name of the Attribute representing
Reference to the ControllerPlan being executed.
|
static String |
EXECUTIONDATE_ATTRIBUTE
The name of the Attribute representing
The date this ControllerPlanExecution was started.
|
static String |
EXECUTIONPLANTABLELIST_ATTRIBUTE
The name of the Attribute representing
Reference to object holding the details describing the execution plan.
|
static String |
FULLYSTARTED_ATTRIBUTE
The name of the Attribute representing
An indicator of whether this plan execution has reached a fully started state,
meaning that runnables are assigned to the most appropriate Node.
|
static String |
NODECOUNT_ATTRIBUTE
The name of the Attribute representing
The number of Nodes expected according to the associated plan.
|
static String |
UUID_ATTRIBUTE
The name of the Attribute representing the UUID.
|
DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, NAME_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE
Modifier | Constructor and Description |
---|---|
protected |
ControllerPlanExecution(LibrarySession session,
Long id,
Long classId,
S_LibraryObjectData data)
Construct a ControllerPlanExecution object.
|
Modifier and Type | Method and Description |
---|---|
void |
addRunningNodeState(NodeState newNode)
Add a new NodeState to the set of available NodeStates
managed by this instance.
|
void |
clearRecoveryBeginDate()
Clears the recovery begin Date.
|
void |
clearStartupBeginDate()
Clears the startup begin Date.
|
static ControllerPlanExecution |
create(ControllerPlan cplan)
Create a simple ControllerPlanExecution from a ControllerPlan.
|
HandlerState |
createAssignedHandlerState(AuditSpecification spec)
Get an available NodeState to assign for the specified Handler.
|
ServerState |
createAssignedServerState(ServerSpecification spec)
Get an available NodeState to assign for the specified ServerSpecification
and if found, create a ServerState the Controller can request to start new.
|
NodeState[] |
getAssignedNodes()
Gets the Nodes assigned for execution that matches the Node types
indicated in the associated plan.
|
List<AttributeValueTable> |
getAssignments()
Gets the set of assignment definitions for this plan execution.
|
ControllerPlan |
getControllerPlan()
Gets Reference to the ControllerPlan being executed.
|
static ControllerPlanExecution |
getCurrent(LibrarySession session)
Gets the currently executing ControllerPlanExecution.
|
Date |
getExecutionDate()
Gets The date this ControllerPlanExecution was started.
|
SimplePropertyTableList |
getExecutionPlanTableList()
Gets Reference to object holding the details describing the plan execution.
|
int |
getNodeCount()
Gets the number of Nodes expected according to the associated plan.
|
SimplePropertyTable |
getObjectPropertyTable()
Gets the SimplePropertyTable representing this object's metadata.
|
Date |
getRecoveryBeginDate()
Gets the recovery begin Date, the time/date at which recovery
towards becoming fully started begins.
|
String |
getRecoveryPeriod()
Gets the recovery time period, which is the duration to wait before
returning back to a "fully started" state after one or more assigned
Nodes are no longer assigned.
|
long |
getRecoveryPeriodDuration()
Gets the recovery time period duration.
|
Date |
getStartupBeginDate()
Gets the startup begin Date, the time/date at which starting up
towards becoming fully started begins.
|
String |
getStartupPeriod()
Gets the startup time period, which is the duration to wait
while assigning Nodes before automatically changing to a
"fully started" state.
|
long |
getStartupPeriodDuration()
Gets the startup time period duration.
|
String |
getUuid()
Gets the value of the UUID attribute.
|
boolean |
hasUnassignedNodes()
Gets whether there are any unassigned Nodes in the
current set of assigned nodes.
|
boolean |
isActive()
Gets an indicator of whether this ControllerJob is still being worked on by the Controller.
|
boolean |
isAssignedNode(NodeState ns)
Gets whether the specified NodeState is one of the assigned nodes.
|
boolean |
isEveryAssignmentFinal()
Gets an indicator of whether every assignment entry should be
considered as being defined as "final", meaning the classification
hierarchy will not be checked further if no Node is defined
at the lowest defined level.
|
boolean |
isFullyStarted()
Gets an indicator of whether this plan execution has reached
a fully started state, meaning that runnables are assigned to the
most appropriate Node.
|
boolean |
isNormalControllerRelease()
Gets an indicator of whether the Controller was released normally.
|
boolean |
isRecalculationNeeded()
Gets an indicator of whether
recalculation of assignemnt counts is needed.
|
boolean |
isShorthanded()
Gets an indicator of whether we were shorthanded when going into
"Fully Started" mode, indicating that a rebalnce operation will be required
once all Nodes ae restarted.
|
boolean |
isShutdownInProgress()
Gets an indicator of whether a shutdown is in progress.
|
void |
performTimedDuties()
Perform timed duties.
|
protected void |
recalculateAssignmentCounts()
Recaclulate the counts for all Assignments.
|
protected void |
recalculateAssignmentCountsIfNeeded()
Recalculate the counts for all Assignments, if a property
indicates that a reclaculation is needed prior to assigning
any server/handler.
|
boolean |
recoveryPeriodElapsed()
See if the recovery period has elapsed.
|
void |
setActive(boolean active)
Sets the ACTIVE attribute for this object.
|
void |
setAssignedNodes(NodeState[] nodeStates)
Sets the Nodes assigned for execution that matches the Node types
indicated in the associated plan.
|
void |
setEveryAssignmentFinal(boolean val)
Sets an indicator of whether every assignment entry should be
considered as being defined as "final", meaning the classification
hierarchy will not be checked further if no Node is defined
at the lowest defined level.
|
void |
setFullyStarted(boolean started)
Sets an indicator of whether this plan execution has reached
a fully started state, meaning that runnables are assigned to the
most appropriate Node.
|
void |
setNormalControllerRelease(boolean val)
Sets an indicator of whether the Controller was released normally.
|
void |
setRecalculationNeeded(boolean val)
Sets an indicator of whether
recalculation of assignemnt counts is needed.
|
void |
setRecoveryBeginDate()
Sets the recovery begin Date to the current time/date.
|
void |
setRecoveryBeginDate(Date val)
Sets the recovery begin Date to the specified value.
|
void |
setRecoveryPeriod(String val)
Sets the recovery time period, which is the duration to wait before
returning back to a "fully started" state after one or more assigned
Nodes are no longer assigned.
|
void |
setShorthanded(boolean val)
Sets an indicator of whether we were shorthanded when going into
"Fully Started" mode, indicating that a rebalnce operation will be required
once all Nodes ae restarted.
|
void |
setShutdownInProgress(boolean val)
Sets an indicator of whether a shutdown is in progress.
|
void |
setStartupBeginDate()
Sets the startup begin Date to the current time/date.
|
void |
setStartupBeginDate(Date val)
Sets the startup begin Date to the specified value.
|
void |
setStartupPeriod(String val)
Sets the startup time period, which is the duration to wait
while assigning Nodes before automatically changing to a
"fully started" state.
|
boolean |
startupPeriodElapsed()
See if the startup period has elapsed.
|
free, handleCreate, isValidEventType
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, hasNameAttribute, hasPropertyBundleAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postCreate, postEvent, postEvent, postFree, postUpdate, preCreate, preFree, prePostAuditEvent, preUpdate, 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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getAttributeByUpperCaseName, getClassId, getId, getSessionInterface
getTraceLogger, isTraced, trace
public static final String CLASS_NAME
public static final String UUID_ATTRIBUTE
public static final String CONTROLLERPLAN_ATTRIBUTE
public static final String EXECUTIONDATE_ATTRIBUTE
public static final String ACTIVE_ATTRIBUTE
public static final String FULLYSTARTED_ATTRIBUTE
public static final String NODECOUNT_ATTRIBUTE
public static final String ASSIGNEDNODES_ATTRIBUTE
public static final String EXECUTIONPLANTABLELIST_ATTRIBUTE
protected ControllerPlanExecution(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) throws IfsException
session
- current LibrarySessionid
- object idclassId
- class iddata
- data componentIfsException
- if the operation failspublic static ControllerPlanExecution create(ControllerPlan cplan) throws IfsException
cplan
- the ControllerPlanIfsException
- if the operation failsprotected void recalculateAssignmentCounts() throws IfsException
IfsException
- if the operation failsprotected void recalculateAssignmentCountsIfNeeded() throws IfsException
IfsException
- if the operation failspublic static ControllerPlanExecution getCurrent(LibrarySession session) throws IfsException
session
- the session contextIfsException
- if the operation failspublic String getUuid() throws IfsException
IfsException
- if the operation failspublic ControllerPlan getControllerPlan() throws IfsException
IfsException
- if the operation failspublic Date getExecutionDate() throws IfsException
IfsException
- if the operation failspublic boolean isActive() throws IfsException
IfsException
- if the operation failspublic boolean isFullyStarted() throws IfsException
IfsException
- if the operation failspublic int getNodeCount() throws IfsException
IfsException
- if the operation failspublic NodeState[] getAssignedNodes() throws IfsException
IfsException
- if the operation failspublic boolean isAssignedNode(NodeState ns) throws IfsException
ns
- the NodeState to checkIfsException
- if the operation failspublic boolean hasUnassignedNodes() throws IfsException
IfsException
- if the operation failspublic SimplePropertyTableList getExecutionPlanTableList() throws IfsException
IfsException
- if the operation failspublic SimplePropertyTable getObjectPropertyTable() throws IfsException
Is stored as the "Object Property Table of the SimplePropertyTableList.
IfsException
- if the operation failspublic void setActive(boolean active) throws IfsException
active
- the new Active status valueIfsException
- if operation failspublic void setAssignedNodes(NodeState[] nodeStates) throws IfsException
nodeStates
- the new array of assigned NodeStatesIfsException
- if the operation failspublic void setFullyStarted(boolean started) throws IfsException
started
- true if the plan execution is fully started state;
false if notIfsException
- if the operation failspublic boolean isShutdownInProgress() throws IfsException
IfsException
- if the operation failspublic void setShutdownInProgress(boolean val) throws IfsException
val
- whether a shutdown is in progressIfsException
- if the operation failspublic boolean isNormalControllerRelease() throws IfsException
IfsException
- if the operation failspublic void setNormalControllerRelease(boolean val) throws IfsException
val
- whether the Controller was released normally.IfsException
- if the operation failspublic String getStartupPeriod() throws IfsException
IfsException
- if the operation failspublic long getStartupPeriodDuration() throws IfsException
IfsException
- if the operation failspublic void setStartupPeriod(String val) throws IfsException
val
- the startup time periodIfsException
- if the operation failspublic String getRecoveryPeriod() throws IfsException
IfsException
- if the operation failspublic long getRecoveryPeriodDuration() throws IfsException
IfsException
- if the operation failspublic void setRecoveryPeriod(String val) throws IfsException
val
- the recovery time periodIfsException
- if the operation failspublic boolean isEveryAssignmentFinal() throws IfsException
IfsException
- if the operation failspublic void setEveryAssignmentFinal(boolean val) throws IfsException
val
- whether every assignemnt should be treated as finalIfsException
- if the operation failspublic Date getStartupBeginDate() throws IfsException
IfsException
- if the operation failspublic void setStartupBeginDate() throws IfsException
IfsException
- if the operation failspublic void clearStartupBeginDate() throws IfsException
IfsException
- if the operation failspublic void setStartupBeginDate(Date val) throws IfsException
val
- the startup begin DateIfsException
- if the operation failspublic boolean startupPeriodElapsed() throws IfsException
IfsException
- if the operation failspublic Date getRecoveryBeginDate() throws IfsException
IfsException
- if the operation failspublic void setRecoveryBeginDate() throws IfsException
IfsException
- if the operation failspublic void clearRecoveryBeginDate() throws IfsException
IfsException
- if the operation failspublic void setRecoveryBeginDate(Date val) throws IfsException
val
- the recovery begin DateIfsException
- if the operation failspublic boolean recoveryPeriodElapsed() throws IfsException
IfsException
- if the operation failspublic boolean isShorthanded() throws IfsException
IfsException
- if the operation failspublic void setShorthanded(boolean val) throws IfsException
val
- whether to mark being shorthandedIfsException
- if the operation failspublic boolean isRecalculationNeeded() throws IfsException
IfsException
- if the operation failspublic void setRecalculationNeeded(boolean val) throws IfsException
val
- whether recalculation of assignemnt counts is neededIfsException
- if the operation failspublic List<AttributeValueTable> getAssignments() throws IfsException
assList
- the set assignment value tablesIfsException
- if the operation failspublic void performTimedDuties() throws IfsException
IfsException
- if the operation failspublic void addRunningNodeState(NodeState newNode) throws IfsException
ns
- the new NodeState to addIfsException
- if the operation failspublic ServerState createAssignedServerState(ServerSpecification spec) throws IfsException
spec
- the ServerSpecificationIfsException
- if the operation failspublic HandlerState createAssignedHandlerState(AuditSpecification spec) throws IfsException
spec
- the AuditSpecification representing the HandlerIfsException
- if the operation failsCopyright © 2023. All rights reserved.