oracle.ifs.core.runtime

Class Node

java.lang.Object

oracle.ifs.core.runtime.Node

All Implemented Interfaces:

IfsEventHandler, NodeInterface, TimerContext

public class Node
extends Object
implements NodeInterface, IfsEventHandler, TimerContext

A Node is a managed CMSDK process.

A Node manages a set of Servers and typically one Service (although a set of Services can be defined).

Version:

1.0

Author:

Dave Long

(Published)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Node.NodeRequest A NodeRequest is structure holding a Node request.

Field Summary

Fields inherited from interface oracle.ifs.core.runtime.NodeInterface

NODESTATUS_DISPOSED, NODESTATUS_RUNNING, NODESTATUS_STARTING, NODESTATUS_STOPPED, NODESTATUS_STOPPING, NODESTATUS_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
Node() Constructs a Node.

Method Summary

Modifier and Type	Method and Description
protected LibrarySession	acquireSession() Acquires a LibrarySession from the session pool.
protected void	checkNodeState() Check if NodeState has been disposed or finalized.
protected void	checkTimer() Check the timer, and reset if needed.
void	configure(String ncName, String svcName, AttributeValueTable ncOverrides) Configure this Node.
void	configure(String ncName, String svcName, AttributeValueTable ncOverrides, DataSource ds) Configure this Node, including a DataSource.
protected LibrarySessionPool	constructLibrarySessionPool(int maxSessCount, String serviceName, String appName, SystemUserCredential cred) Constructs a LibrarySessionPool.
protected TimerInterface	createTimer() Creates a Timer.
protected void	disableEventListening() Disable listening for events on RuntimeState instances.
void	dispose() Deprecated. 9.3.4.0: use ControllerJob to request Node to dispose
protected void	disposeNode() Disposes this Node.
protected void	disposeService() Disposes the Service managed by this Node.
protected void	enableEventListening() Enable listening events on any RuntimeState.
AttributeValueTable	getConfigurationTable() Gets the Configuration Table for this Node.
AttributeValue	getConfigurationValue(String key) Gets a Configuration value from the Configuration Table for this Node.
int	getDesiredStatus() Gets the desired status of this Node.
String	getIfsHome() Gets the CM SDK home directory for this Node.
String	getNodeConfigurationName() Gets the name of the NodeConfiguration.
String	getNodeName() Gets the name of this Node.
NodeState	getNodeState(LibrarySession session) Gets the NodeState for this Node.
String	getOracleHome() Deprecated. 9.3.4.0: no longer a property that the Node makes available
AttributeValueTable	getOverridesTable() Gets the Overrides Table for this Node.
String	getServiceConfigurationName() Gets the name of the ServiceConfiguration.
String	getServiceName() Gets the name that identifies the running Service.
ServiceState	getServiceState(LibrarySession session) Gets the ServiceState for the service that this Node manages.
protected LibrarySession	getSession() Gets the session for this Node.
AttributeValueTable	getStateTable() Gets the State Table for this Node.
int	getStatus() Gets the status of this Node.
protected AttributeValueTable	getTimerConfiguration() Gets the Timer Configuration.
protected void	handleControllerRequest(RuntimeState target) Called to handle a ControllerRequest that was posted to the specified RuntimeState object, if one is active.
protected void	handleDisposeNode() Called when the Node is requested to dispose.
void	handleEvent(IfsEvent event) Handles events on RuntimeState objects.
protected void	handleHandlerControllerRequest(HandlerState hs) Called to handle a ControllerRequest that was posted to the specified HandlerState object, if one is active.
protected void	handleNodeConfigurationOverride(String propName) Handle a NodeConfiguration override.
protected void	handleNodeConfigurationOverrideRequest(NodeState ns) Handle NodeConfiguration overrides that have been posted.
protected void	handleNodeControllerRequest(NodeState ns) Called to handle a ControllerRequest that was posted to the specified NodeState object, if one is active.
protected void	handleNodeDisposed() Called as a notification when the Node is disposed.
protected void	handleNodeStateEvent(String eventKey) Handle a NodeState event, specified as an AuditEvent key.
protected void	handleRequest(Node.NodeRequest request) Handles the specified pending request for this Node.
protected void	handleRequests() Dispatches any pending requests for this Node.
protected void	handleRestartNode() Called when the Node is requested to restart.
protected void	handleServerControllerRequest(ServerState ss) Called to handle a ControllerRequest that was posted to the specified ServerState object, if one is active.
protected void	handleServerDisposed(ServerState ss) Called to process notification that one of the managed Servers has been disposed.
protected void	handleServiceControllerRequest(ServiceState svs) Called to handle a ControllerRequest that was posted to the specified ServiceState object, if one is active.
protected void	handleStartNewServerRequest(ServerState ss) Handle a request to start a new managed server.
protected void	handleStartNode() Called when the Node is requested to start.
protected void	handleStopNode() Called when the Node is requested to stop.
protected void	handleTimerExpired() Called when the Node's timer expires.
protected void	initialize() Initializes this Node.
protected void	initializeLogging() Initialize logging system, if it is not already initialized, or if "reinitialize" is specified in the Node configuration.
protected void	initializeTimerCounts() Initialize the timer counts.
protected boolean	isNodeDisposed() Indicates the Node has been requested to dispose, and that the run loop should end.
protected void	performCriticalTimedDuties() Perform the critical timed Node duties.
protected void	performTimedChallengerDuties() Perform Controller challenge duties.
protected void	performTimedControllerDuties() Perform the timed Controller Node duties.
protected void	performTimedDuties() Perform timed Node duties.
protected void	postControllerAlertRequest(AttributeValue runtimeTarget) Post request to alert the Controller, issued from the specified RuntimeState.
protected void	postControllerReplyRequest(AttributeValue runtimeTarget) Post request to reply to the Controller, issued from the specified RuntimeState.
protected void	postControllerRequestRequest(AttributeValue runtimeTarget) Post request to a request from the Controller, issued on the specified RuntimeState.
protected void	postControllerTimedDuties() Post request to alert the Controller to perform its timed duties.
void	postDisposeNodeRequest() Post request to dispose a node.
void	postNodeDisposedRequest() Post request to indicate that the node is disposed.
protected void	postRequest(int type) Posts a request to this Node, with no payload.
protected void	postRequest(int type, Object payload) Posts a request to this Node, with an optional opaque payload.
void	postRestartNodeRequest() Post request to restart a node.
protected void	postRun() Performs post-run tasks for this Node.
void	postServerDisposedRequest(AttributeValue ssValue, Server server) Post request to respond to a Server indicating that it has been disposed.
void	postStartNodeRequest() Post request to start a node.
void	postStopNodeRequest() Post request to stop a node.
protected void	preRun() The pre-run tasks for this Node.
protected void	processEvent(IfsEvent event) Processes an IfsEvent previously placed in this Node's event queue by queueEvent.
protected void	processEvents() Dispatches any IfsEvents previously placed in this Node's event queue by queueEvent.
protected void	queueEvent(IfsEvent event) Queues an IfsEvent for this Node.
protected void	releaseSession() Releases the Node's session back to the session pool.
protected void	resetTimer() Resets the timer for this Node.
void	run() Execute the "Run loop" for this Node.
protected void	setDesiredStatus(int status) Sets the desired status of this Node.
protected void	setDesiredStatus(int status, boolean force) Sets the desired status of this Node.
protected void	setStatus(int status) Sets the status of this Node.
protected boolean	shouldRemovePreviousOverrides() Gets indication as to whether previous overrides should be applied when restarting a Node.
protected void	showRuntimeStates() Show the all undisposed RuntimeState objects, organized by the managing Node.
void	start() Requests to start the Node.
protected void	startNode() Starts (or restarts) the Node.
void	startService() Starts the service associated with this Node.
protected void	startTimer() Starts a timer that will generate "timer expiration" requests for this Node at a specified interval.
void	stop() Deprecated. 9.3.4.0: use ControllerJob to request Node to stop
protected void	stopNode() Stops this Node.
protected void	stopTimer() Stops the timer for this Node.
void	timerExpired() Notififcation that the timer has expired.
static String	toStatusLabel(int status) Gets a localized label for the specified status of a Node, using a default Localizer.
static String	toStatusLabel(int status, LibrarySessionInterface session) Gets a localized label for the specified status of a Node, using the specified session's Localizer.
static String	toStatusLabel(int status, Localizer localizer) Gets a localized label for the specified status of a Node, using the specified Localizer.
protected void	triggerExit() Called when the Node must exit immediately.
protected void	updateAcknowledgeDate() Update the last ack date.
protected void	updateNodeStateLogLevelOverrides() Update the NodeState with updated LogLevelOverrides information.
protected void	waitNode() Blocks the current thread until one of the following occurs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Node

public Node()
     throws IfsException

Constructs a Node.

Subclasses should provide a zero-argument constructor.

Throws:

IfsException - if the operation fails

(Published)

Method Detail

getNodeName

public String getNodeName()

Gets the name of this Node.

Specified by:

getNodeName in interface NodeInterface

Returns:

the name

(Published)

getNodeConfigurationName

public String getNodeConfigurationName()

Gets the name of the NodeConfiguration.

Specified by:

getNodeConfigurationName in interface NodeInterface

Returns:

the node configuration name

(Published)

getServiceConfigurationName

public String getServiceConfigurationName()

Gets the name of the ServiceConfiguration.

Specified by:

getServiceConfigurationName in interface NodeInterface

Returns:

the service configuration name

(Published)

getServiceName

public String getServiceName()

Gets the name that identifies the running Service.

Specified by:

getServiceName in interface NodeInterface

Returns:

the service name

(Published)

getStatus

public int getStatus()

Gets the status of this Node.

Specified by:

getStatus in interface NodeInterface

Returns:

the enumerated status

(Published)

getDesiredStatus

public int getDesiredStatus()

Gets the desired status of this Node.

Specified by:

getDesiredStatus in interface NodeInterface

Returns:

the enumerated status

(Published)

getConfigurationValue

public AttributeValue getConfigurationValue(String key)
                                     throws IfsException

Gets a Configuration value from the Configuration Table for this Node.

Specified by:

getConfigurationValue in interface NodeInterface

Parameters:

key - the configuration property key

Returns:

the Configuration value, or null if not defined

Throws:

IfsException - if the operation fails

(Published)

getOracleHome

public String getOracleHome()
                     throws IfsException

Deprecated. 9.3.4.0: no longer a property that the Node makes available

Gets the Oracle home directory for this Server's node.

The Oracle home directory is specified by the Node's IFS.NODE.OracleHome property.

Specified by:

getOracleHome in interface NodeInterface

Returns:

the Oracle home directory

Throws:

IfsException - if the operation fails

(Published)

getIfsHome

public String getIfsHome()
                  throws IfsException

Gets the CM SDK home directory for this Node.

The CM SDK home directory is specified by the node's IFS.NODE.IfsHome property.

Specified by:

getIfsHome in interface NodeInterface

Returns:

the CM SDK home directory

Throws:

IfsException - if the operation fails

(Published)

getNodeState

public NodeState getNodeState(LibrarySession session)
                       throws IfsException

Gets the NodeState for this Node.

Specified by:

getNodeState in interface NodeInterface

Parameters:

session - the session context to use

Returns:

the NodeState associated with this Node

Throws:

IfsException - if the operation fails

(Published)

getServiceState

public ServiceState getServiceState(LibrarySession session)
                             throws IfsException

Gets the ServiceState for the service that this Node manages.

Specified by:

getServiceState in interface NodeInterface

Parameters:

session - the session context to use

Returns:

the ServiceState associated with the Service managed by this Node

Throws:

IfsException - if the operation fails

(Published)

getConfigurationTable

public AttributeValueTable getConfigurationTable()

Gets the Configuration Table for this Node.

Returns:

the Configuration Table

(Published)

getOverridesTable

public AttributeValueTable getOverridesTable()

Gets the Overrides Table for this Node.

Returns:

the Overrides Table

(Published)

getStateTable

public AttributeValueTable getStateTable()

Gets the State Table for this Node.

Returns:

the State Table

(Published)

configure

public void configure(String ncName,
                      String svcName,
                      AttributeValueTable ncOverrides)
               throws IfsException

Configure this Node.

Parameters:

ncName - the name of the NodeConfiguration

svcName - the name of the ServiceConfiguration (can be null)

ncOverrides - the table of NodeConfiguration parameter overrides

Throws:

IfsException - if the operation fails

(Published)

configure

public void configure(String ncName,
                      String svcName,
                      AttributeValueTable ncOverrides,
                      DataSource ds)
               throws IfsException

Configure this Node, including a DataSource.

Parameters:

ncName - the name of the NodeConfiguration

svcName - the name of the ServiceConfiguration (can be null)

ncOverrides - the table of NodeConfiguration parameter overrides

ds - the DatatSource to use in starting the Service

Throws:

IfsException - if the operation fails

(Published)

startService

public void startService()
                  throws IfsException

Starts the service associated with this Node.

The primary service is defined in the NodeConfiguration. Currently this is picked up from the overrides specified in the configure method.

Throws:

IfsException - if the operation fails

(Published)

start

public void start()
           throws IfsException

Requests to start the Node.

Called from the startNode operation, currently defined in RuntimeOperations, which is the standard way of starting Node's within a script.

Throws:

IfsException - if the operation fails

(Published)

stop

public void stop()
          throws IfsException

Deprecated. 9.3.4.0: use ControllerJob to request Node to stop

Requests this Node to stop.

Throws:

IfsException - if the operation fails

(Published)

dispose

public void dispose()
             throws IfsException

Deprecated. 9.3.4.0: use ControllerJob to request Node to dispose

Requests to dispose this Node.

Throws:

IfsException - if the operation fails

(Published)

startNode

protected void startNode()
                  throws IfsException

Starts (or restarts) the Node.

Throws:

IfsException - if the operation fails

(Published)

shouldRemovePreviousOverrides

protected boolean shouldRemovePreviousOverrides()
                                         throws IfsException

Gets indication as to whether previous overrides should be applied when restarting a Node.

This is an override point for Node subclasses. It is called within startNode, from within the Node's controlled "run loop".

Returns:

true if previously applied overrides should be removed as part of Node restart

Throws:

IfsException - if the operation fails

(Published)

initializeLogging

protected void initializeLogging()
                          throws IfsException

Initialize logging system, if it is not already initialized, or if "reinitialize" is specified in the Node configuration.

Configure LogManager if indicated by settings in the Node configuration.

Throws:

IfsException - if the operation fails

(Published)

initialize

protected void initialize()
                   throws IfsException

Initializes this Node.

This is an extensibility point, called to allow subclasses perform initialization after the basic initialization occurs by the source that launches the Node.

Throws:

IfsException - if the operation fails

(Published)

run

public void run()

Execute the "Run loop" for this Node.

(Published)

preRun

protected void preRun()
               throws Exception

The pre-run tasks for this Node.

Extensiblity point for activity prior to the start of the run loop.

Throws:

Exception - if the operation fails

(Published)

postRun

protected void postRun()

Performs post-run tasks for this Node.

Extensiblity point for activity after exiting the run loop.

(Published)

isNodeDisposed

protected boolean isNodeDisposed()

Indicates the Node has been requested to dispose, and that the run loop should end.

Returns:

whether this Node has been requested to dispose

(Published)

startTimer

protected void startTimer()
                   throws IfsException

Starts a timer that will generate "timer expiration" requests for this Node at a specified interval.

If the timer is already started, it is stopped and restarted.

Throws:

IfsException - (IFS-45364) if the operation fails

(Published)

stopTimer

protected void stopTimer()
                  throws IfsException

Stops the timer for this Node.

If the timer is not started, this method has no effect.

Throws:

IfsException - if the operation fails

(Published)

resetTimer

protected void resetTimer()
                   throws IfsException

Resets the timer for this Node.

This has the effect of preventing the next "timer expired" event from occurring until the Activation Period elapses relative to the current time. If the timer is not started, this method has no effect.

Throws:

IfsException - if the operation fails

(Published)

enableEventListening

protected void enableEventListening()
                             throws IfsException

Enable listening events on any RuntimeState.

Throws:

IfsException - if the operation fails

(Published)

disableEventListening

protected void disableEventListening()
                              throws IfsException

Disable listening for events on RuntimeState instances.

Throws:

IfsException - if the operation fails

(Published)

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

Handles events on RuntimeState objects.

This queues the events for processing inside the run loop.

Specified by:

handleEvent in interface IfsEventHandler

Parameters:

event - the event to handle

Throws:

IfsException - if the operation fails

(Published)

queueEvent

protected final void queueEvent(IfsEvent event)
                         throws IfsException

Queues an IfsEvent for this Node.

This is called by the handleEvent method of an IfsEventHandler. The event remains in the Node's event queue until processEvents is called from within the Node's run loop, at which point processEvent is called to process the event.

Parameters:

event - the event to queue

Throws:

IfsException - (IFS-45369) if the operation fails

(Published)

processEvents

protected final void processEvents()
                            throws IfsException

Dispatches any IfsEvents previously placed in this Node's event queue by queueEvent.

Throws:

IfsException - (IFS-45371) if the operation fails

(Published)

processEvent

protected void processEvent(IfsEvent event)
                     throws Exception

Processes an IfsEvent previously placed in this Node's event queue by queueEvent.

This method is called by processEvents. Override it to perform tasks in response to an event. Unless overridden, no operation is performed by this method.

The processEvents method will rethrow any exception thrown by this method.

Parameters:

event - the event

Throws:

Exception - if the operation fails

(Published)

postRequest

protected void postRequest(int type)

Posts a request to this Node, with no payload.

Parameters:

type - the enumerated request type

(Published)

postRequest

protected void postRequest(int type,
                           Object payload)

Posts a request to this Node, with an optional opaque payload.

Parameters:

type - the enumerated request type

payload - the optional Object payload

(Published)

handleRequests

protected final void handleRequests()
                             throws IfsException

Dispatches any pending requests for this Node.

Results in calls to handleRequest for each of the queued requests.

Throws:

IfsException - (IFS-45370) if the operation fails

(Published)

handleRequest

protected void handleRequest(Node.NodeRequest request)
                      throws IfsException

Handles the specified pending request for this Node.

This method can be overridden by subclasses to process custom requests. The implmentation in this base class handles the standard requests, which result in calls to: handleRequest, which in turn calls handleTimerExpired.

These calls occur in the same thread that called this method. Should one of these methods throw, request handling will cease, any requests not yet dispatched will remain pending, and this method will rethrow the exception.

Parameters:

request - the NodeRequest to handle

Throws:

IfsException - (IFS-45370) if the operation fails

(Published)

waitNode

protected final void waitNode()
                       throws IfsException

Blocks the current thread until one of the following occurs.

• the timer expires
• a request is posted
• queueEvent is called to enqueue an event

Throws:

IfsException - (IFS-45372) if the operation fails

(Published)

postStartNodeRequest

public void postStartNodeRequest()

Post request to start a node.

(Published)

postStopNodeRequest

public void postStopNodeRequest()

Post request to stop a node.

(Published)

postRestartNodeRequest

public void postRestartNodeRequest()

Post request to restart a node.

(Published)

postDisposeNodeRequest

public void postDisposeNodeRequest()

Post request to dispose a node.

(Published)

postNodeDisposedRequest

public void postNodeDisposedRequest()

Post request to indicate that the node is disposed.

(Published)

postServerDisposedRequest

public void postServerDisposedRequest(AttributeValue ssValue,
                                      Server server)

Post request to respond to a Server indicating that it has been disposed.

Specified by:

postServerDisposedRequest in interface NodeInterface

Parameters:

ssValue - the ServerState value for the Server that was disposed

server - the Server that was disposed

(Published)

postControllerRequestRequest

protected void postControllerRequestRequest(AttributeValue runtimeTarget)

Post request to a request from the Controller, issued on the specified RuntimeState.

Parameters:

runtimeTarget - the RuntimeState target (as an AttributeValue)

(Published)

postControllerReplyRequest

protected void postControllerReplyRequest(AttributeValue runtimeTarget)

Post request to reply to the Controller, issued from the specified RuntimeState.

Parameters:

runtimeTarget - the RuntimeState target (as an AttributeValue)

(Published)

postControllerAlertRequest

protected void postControllerAlertRequest(AttributeValue runtimeTarget)

Post request to alert the Controller, issued from the specified RuntimeState.

Parameters:

runtimeTarget - the RuntimeState target (as an AttributeValue)

(Published)

postControllerTimedDuties

protected void postControllerTimedDuties()

Post request to alert the Controller to perform its timed duties.

(Published)

timerExpired

public void timerExpired()

Notififcation that the timer has expired.

Specified by:

timerExpired in interface TimerContext

(Published)

triggerExit

protected void triggerExit()

Called when the Node must exit immediately.

(Unpublished)

handleTimerExpired

protected void handleTimerExpired()
                           throws IfsException

Called when the Node's timer expires.

Throws:

IfsException - if the operation fails

(Published)

performTimedDuties

protected void performTimedDuties()
                           throws IfsException

Perform timed Node duties.

Throws:

IfsException - if the operation fails

(Published)

performCriticalTimedDuties

protected void performCriticalTimedDuties()
                                   throws IfsException

Perform the critical timed Node duties.

Throws:

IfsException - if the operation fails

(Published)

checkNodeState

protected void checkNodeState()
                       throws IfsException

Check if NodeState has been disposed or finalized.

Throws:

IfsException - if the operation fails

(Published)

updateAcknowledgeDate

protected void updateAcknowledgeDate()
                              throws IfsException

Update the last ack date.

Throws:

IfsException - if the operation fails

(Published)

showRuntimeStates

protected void showRuntimeStates()
                          throws IfsException

Show the all undisposed RuntimeState objects, organized by the managing Node.

Throws:

IfsException - if the operation fails

checkTimer

protected void checkTimer()
                   throws IfsException

Check the timer, and reset if needed.

Throws:

IfsException - if the operation fails

performTimedChallengerDuties

protected void performTimedChallengerDuties()
                                     throws IfsException

Perform Controller challenge duties.

Throws:

IfsException - if the operation fails

(Published)

performTimedControllerDuties

protected void performTimedControllerDuties()
                                     throws IfsException

Perform the timed Controller Node duties.

Throws:

IfsException - if the operation fails

(Published)

handleStartNode

protected void handleStartNode()
                        throws IfsException

Called when the Node is requested to start.

Throws:

IfsException - if the operation fails

(Published)

handleStopNode

protected void handleStopNode()
                       throws IfsException

Called when the Node is requested to stop.

Throws:

IfsException - if the operation fails

(Published)

handleRestartNode

protected void handleRestartNode()
                          throws IfsException

Called when the Node is requested to restart.

Throws:

IfsException - if the operation fails

(Published)

handleDisposeNode

protected void handleDisposeNode()
                          throws IfsException

Called when the Node is requested to dispose.

Throws:

IfsException - if the operation fails

(Published)

handleNodeDisposed

protected void handleNodeDisposed()
                           throws IfsException

Called as a notification when the Node is disposed.

Throws:

IfsException - if the operation fails

(Published)

handleServerDisposed

protected void handleServerDisposed(ServerState ss)
                             throws IfsException

Called to process notification that one of the managed Servers has been disposed.

Parameters:

ss - the ServerState that was disposed

Throws:

IfsException - if the operation fails

(Published)

handleControllerRequest

protected void handleControllerRequest(RuntimeState target)
                                throws IfsException

Called to handle a ControllerRequest that was posted to the specified RuntimeState object, if one is active.

Called when an IfsEvent is received that indicates a ControllerRequest has been added to the RuntimeState object, or during the Node's timed duties where all RuntimeStates managed by the Node are visited to handle any pending ControllerRequests. It is a no-op if no ControllerRequests are pending.

Parameters:

target - the target RuntimeState object

Throws:

IfsException - if the operation fails

(Published)

handleNodeControllerRequest

protected void handleNodeControllerRequest(NodeState ns)
                                    throws IfsException

Called to handle a ControllerRequest that was posted to the specified NodeState object, if one is active.

Called when an IfsEvent is received that indicates a ControllerRequest has been added to the NodeState object, or during the Node's timed duties. It is a no-op if no ControllerRequests are pending.

Parameters:

ns - the target NodeState object

Throws:

IfsException - if the operation fails

(Published)

handleServerControllerRequest

protected void handleServerControllerRequest(ServerState ss)
                                      throws IfsException

Called to handle a ControllerRequest that was posted to the specified ServerState object, if one is active.

Called when an IfsEvent is received that indicates a ControllerRequest has been added to the ServerState object, or during the Node's timed duties. It is a no-op if no ControllerRequests are pending.

Parameters:

ss - the target ServerState object

Throws:

IfsException - if the operation fails

(Published)

handleHandlerControllerRequest

protected void handleHandlerControllerRequest(HandlerState hs)
                                       throws IfsException

Called to handle a ControllerRequest that was posted to the specified HandlerState object, if one is active.

Called when an IfsEvent is received that indicates a ControllerRequest has been added to the HandlerState object, or during the Node's timed duties. It is a no-op if no ControllerRequests are pending.

Parameters:

hs - the target HandlerState object

Throws:

IfsException - if the operation fails

(Published)

handleServiceControllerRequest

protected void handleServiceControllerRequest(ServiceState svs)
                                       throws IfsException

Called to handle a ControllerRequest that was posted to the specified ServiceState object, if one is active.

Called when an IfsEvent is received that indicates a ControllerRequest has been added to the ServiceState object, or during the Node's timed duties. It is a no-op if no ControllerRequests are pending.

Parameters:

svs - the target ServiceState object

Throws:

IfsException - if the operation fails

(Published)

stopNode

protected void stopNode()
                 throws IfsException

Stops this Node.

Throws:

IfsException - if the operation fails

(Published)

disposeNode

protected void disposeNode()
                    throws IfsException

Disposes this Node.

Throws:

IfsException - if the operation fails

(Published)

disposeService

protected void disposeService()
                       throws IfsException

Disposes the Service managed by this Node.

Throws:

IfsException - if the operation fails

(Published)

acquireSession

protected LibrarySession acquireSession()
                                 throws IfsException

Acquires a LibrarySession from the session pool.

Returns:

the acquired session

Throws:

IfsException - if the operation fails

(Published)

getSession

protected LibrarySession getSession()
                             throws IfsException

Gets the session for this Node.

Returns:

the Node's session

Throws:

IfsException - if the operation fails

(Published)

releaseSession

protected void releaseSession()
                       throws IfsException

Releases the Node's session back to the session pool.

Throws:

IfsException - if the operation fails

(Published)

constructLibrarySessionPool

protected LibrarySessionPool constructLibrarySessionPool(int maxSessCount,
                                                         String serviceName,
                                                         String appName,
                                                         SystemUserCredential cred)
                                                  throws IfsException

Constructs a LibrarySessionPool.

Parameters:

maxSessCount - the maximum number of sessions that can be constructed by this pool

serviceName - the service name

appName - the application name (for DB connection metadata)

cred - the system user credentials

Returns:

the newly constructed LibrarySessionPool

Throws:

IfsException - if the operation fails

(Published)

handleNodeStateEvent

protected void handleNodeStateEvent(String eventKey)
                             throws IfsException

Handle a NodeState event, specified as an AuditEvent key.

Parameters:

eventKey - the NodeState event key

Throws:

IfsException - if the operation fails

(Published)

handleNodeConfigurationOverrideRequest

protected void handleNodeConfigurationOverrideRequest(NodeState ns)
                                               throws IfsException

Handle NodeConfiguration overrides that have been posted.

Parameters:

ns - the NodeState instance

Throws:

IfsException - if the operation fails

(Published)

handleNodeConfigurationOverride

protected void handleNodeConfigurationOverride(String propName)
                                        throws IfsException

Handle a NodeConfiguration override.

The overridden value can be obtained from the current configuration table.

Parameters:

propName - the NodeConfiguration property name

Throws:

IfsException - if the operation fails

(Published)

updateNodeStateLogLevelOverrides

protected void updateNodeStateLogLevelOverrides()
                                         throws IfsException

Update the NodeState with updated LogLevelOverrides information.

Throws:

IfsException - if the operation fails

(Published)

handleStartNewServerRequest

protected void handleStartNewServerRequest(ServerState ss)
                                    throws IfsException

Handle a request to start a new managed server.

Parameters:

ss - the ServerState created by the Controller to request a Server to start on its managing Node

Throws:

IfsException - if the operation fails

(Published)

setDesiredStatus

protected void setDesiredStatus(int status)
                         throws IfsException

Sets the desired status of this Node.

Parameters:

status - the new status

Throws:

IfsException - if the operation fails

(Published)

setDesiredStatus

protected void setDesiredStatus(int status,
                                boolean force)
                         throws IfsException

Sets the desired status of this Node.

Parameters:

status - the new status

force - if true, set the desired status regardless of the current status

Throws:

IfsException - if the operation fails

(Published)

setStatus

protected void setStatus(int status)
                  throws IfsException

Sets the status of this Node.

Parameters:

status - the new status

Throws:

IfsException - if the operation fails

(Published)

toStatusLabel

public static String toStatusLabel(int status)
                            throws IfsException

Gets a localized label for the specified status of a Node, using a default Localizer.

Equivalent to toStatusLabel(status, null).

Parameters:

status - the status

Returns:

the label

Throws:

IfsException - if the operation fails

(Published)

toStatusLabel

public static String toStatusLabel(int status,
                                   LibrarySessionInterface session)
                            throws IfsException

Gets a localized label for the specified status of a Node, using the specified session's Localizer.

Equivalent to toStatusLabel(status, session.getLocalizer()).

Parameters:

status - the status

session - the session

Returns:

the label

Throws:

IfsException - if the operation fails

(Published)

toStatusLabel

public static String toStatusLabel(int status,
                                   Localizer localizer)
                            throws IfsException

Gets a localized label for the specified status of a Node, using the specified Localizer.

If localizer is null, this method is equivalent to toStatusLabel(status, new Localizer()).

Parameters:

status - the status

localizer - the Localizer

Returns:

the label

Throws:

IfsException - if the operation fails

(Published)

createTimer

protected TimerInterface createTimer()
                              throws IfsException

Creates a Timer.

The Timer configuration is hardcoded to run every 5 minutes, with a base time of day of 00:00:00.

Returns:

the Timer, or null if the Timer could not be created

Throws:

IfsException - if the operation fails

(Published)

initializeTimerCounts

protected void initializeTimerCounts()
                              throws IfsException

Initialize the timer counts.

Throws:

IfsException - if the operation fails

(Published)

getTimerConfiguration

protected AttributeValueTable getTimerConfiguration()
                                             throws IfsException

Gets the Timer Configuration.

Node Subclasses may override this to derive different values for the timer settings.

Returns:

the Timer configuration

Throws:

IfsException - if the operation fails

(Published)