oracle.ifs.core.runtime

Class ClusteredServer

java.lang.Object

oracle.ifs.core.runtime.Server

oracle.ifs.core.runtime.IfsServer

oracle.ifs.core.runtime.ClusteredServer

All Implemented Interfaces:

ServerInterface, TimerContext

Direct Known Subclasses:

AclIndexAgent, AuditEventDispatchAgent, BaseAgent, FolderIndexAgent, LifecycleAgent, LockExpirationAgent, NonCompetingClusteredServer, RetainedEventAgent

Deprecated.

9.3.4.0: extend IfsServer instead and use new runtime system.

public abstract class ClusteredServer
extends IfsServer

A ClusteredServer is an abstract base class for IfsServers that participate in a clustered environment.

Author:

Dave Long

(Unpublished)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.core.runtime.IfsServer

IfsServer.ServerRequest

Field Summary

Fields inherited from class oracle.ifs.core.runtime.Server

LEVEL_HIGH, LEVEL_LOW, LEVEL_MEDIUM, LEVEL_OFF

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

SERVERSTATUS_DISPOSED, SERVERSTATUS_RUNNING, SERVERSTATUS_STARTING, SERVERSTATUS_STOPPED, SERVERSTATUS_STOPPING, SERVERSTATUS_SUSPENDED, SERVERSTATUS_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
ClusteredServer() Deprecated. Constructs a ClusteredServer.

Method Summary

Modifier and Type	Method and Description
void	cancelRegistration() Deprecated. Cancels the registration for this Server.
boolean	checkRegistration(Long tokenId) Deprecated. Checks the registration for this Server.
protected String	deriveAgentIdentifier() Deprecated.
protected String	deriveRunningServerIdentifier() Deprecated.
protected String	getAgentIdentifier() Deprecated. Gets the agent identifier.
protected String	getAgentIdentifierPrefix() Deprecated. Gets the prefix to use for deriving the agent identifier for this server.
protected long	getRegistrationPeriod() Deprecated. Gets the registration period.
protected String	getRunningNodeIdentifier() Deprecated. Gets the string used to identify a running node.
protected String	getRunningNodeName() Deprecated. Gets the running node name.
String	getRunningServerIdentifier() Deprecated. Gets the string used to identify a running server.
boolean	initializeRegistration() Deprecated. Initializes the registration for this Server.
boolean	isRegistered() Deprecated. Checks to see if this Server is registered to handle the processing in the cluster.
boolean	isServerRunning() Deprecated. Checks to see if the Server is considered a "running server", by adding itself to the table of running servers.
protected boolean	isTokenNonCompeting() Deprecated. Returns indication as to whether the server token is non-competing.

Methods inherited from class oracle.ifs.core.runtime.IfsServer

checkSession, connectSession, constructSession, convertTimerInterval, convertTimerInterval, convertTimerInterval, dispose, getLastTimerActivation, getLogger, getNextTimerActivation, getService, getTimerActivationPeriod, getTimerClassName, getTimerConfiguration, handlePriorityChangeRequest, handlePropertyChangeRequest, handlePropertyChangeRequest, handleRequest, handleRequests, handleResumeRequest, handleServerStateControllerRequest, handleStopRequest, handleSuspendRequest, handleTimerExpired, initialize, isNonCompeting, isPropertyReadonly, isServiceAvailable, isTimerActive, postCheckServerStateRequest, postRequest, postRun, preRun, processEvent, processEvents, queueEvent, resetTimer, restart, resume, run, serviceAvailabilityCheckNeeded, setPriority, setProperty, setProperty, start, startTimer, stop, stopRequested, stopTimer, suspend, timerExpired, waitForServiceAvailability, waitServer

Methods inherited from class oracle.ifs.core.runtime.Server

acquireSession, constructLibrarySessionPool, createServerState, deregister, disconnectSession, getConfigurationOverridesTable, getConfigurationTable, getCredential, getDesiredStatus, getIfsHome, getInitialConfigurationTable, getLoggerForLegacyLogging, getName, getNode, getNodeName, getOracleHome, getParameterTable, getPriority, getProperties, getProperty, getServerConfigurationName, getServerState, getServerStateValue, getServerType, getServiceName, getSession, getStateTable, getStatus, getSystemUserCredential, handleServerConfigurationOverrideRequest, handleServerStateEvent, initialize, initialize, isAgent, isDisposed, isInitialized, isLogged, log, log, log, releaseSession, releaseSession, setDesiredStatus, setDesiredStatus, setSessionTimeoutPrevented, setStateProperty, setStatus, startStandalone, startStandalone, supportsPriority, supportsSuspendResume, toStatusLabel, toStatusLabel, toStatusLabel, verifyNotDisposed, verifyNotDisposed

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusteredServer

public ClusteredServer()
                throws IfsException

Deprecated.

Constructs a ClusteredServer.

Throws:

IfsException - if the operation fails

Method Detail

isTokenNonCompeting

protected boolean isTokenNonCompeting()
                               throws IfsException

Deprecated.

Returns indication as to whether the server token is non-competing.

A non-competing token is one that always assumes a Primary registration type, and always attempts to free the ApplicationToken upon unregistration.

Overrides:

isTokenNonCompeting in class IfsServer

Returns:

true if token is non-competing; false otherwise

Throws:

IfsException - if the operation fails

getRunningServerIdentifier

public String getRunningServerIdentifier()
                                  throws IfsException

Deprecated.

Gets the string used to identify a running server.

Is a composite of the agent identifier and the running node identifer, e.g. "IFS.AGENT.INTERNAL.CleanupAgent:stadc35_node1:9461928".

Returns:

the running server identifier

Throws:

IfsException - if the operation fails

deriveAgentIdentifier

protected String deriveAgentIdentifier()
                                throws IfsException

Deprecated.

Throws:

IfsException

deriveRunningServerIdentifier

protected String deriveRunningServerIdentifier()
                                        throws IfsException

Deprecated.

Throws:

IfsException

getAgentIdentifierPrefix

protected String getAgentIdentifierPrefix()
                                   throws IfsException

Deprecated.

Gets the prefix to use for deriving the agent identifier for this server.

Returns:

the agent identifier prefix to use

Throws:

IfsException - if the operation fails

getRunningNodeName

protected String getRunningNodeName()
                             throws IfsException

Deprecated.

Gets the running node name.

Will derive this on this first call by using either the real node name, or using the node name set in standalone mode.

Returns:

the running node name

Throws:

IfsException - if the operation fails

getRunningNodeIdentifier

protected String getRunningNodeIdentifier()
                                   throws IfsException

Deprecated.

Gets the string used to identify a running node.

Is a composite of the running node name and the service ID, e.g. "stadc35_node1:9461928".

Returns:

the running node identifier

Throws:

IfsException - if the operation fails

getAgentIdentifier

protected String getAgentIdentifier()
                             throws IfsException

Deprecated.

Gets the agent identifier.

Will derive this on this first call by invoking deriveAgentIdentifier.

Returns:

the agent identifier

Throws:

IfsException - if the operation fails

getRegistrationPeriod

protected long getRegistrationPeriod()

Deprecated.

Gets the registration period.

Returns:

the registration period

initializeRegistration

public boolean initializeRegistration()
                               throws IfsException

Deprecated.

Initializes the registration for this Server.

This method is called when the Server is about to enter the run loop, and when it is resumed.

Returns:

true if the server instance is registered; false otherwise

Throws:

IfsException - if the operation fails

cancelRegistration

public void cancelRegistration()
                        throws IfsException

Deprecated.

Cancels the registration for this Server.

This method is called when the Server exits the run loop, and when it is suspended.

Can be extended by clustered servers that have subordinate agent IDs to release (e.g. in EventHandlerAgent).

Throws:

IfsException - if the operation fails

checkRegistration

public boolean checkRegistration(Long tokenId)
                          throws IfsException

Deprecated.

Checks the registration for this Server.

The tokenId argument specified indicates whether there is a specific token context for the check registration request, which can occur is the re-check is triggered by an event. If the tokenId specified is null, the re-check should be performed without exception.

Parameters:

tokenId - the token Id context; null indicates that the registration check should unequivocally

Returns:

true if the server instance is registered; false otherwise

Throws:

IfsException - if the operation fails

isRegistered

public final boolean isRegistered()
                           throws IfsException

Deprecated.

Checks to see if this Server is registered to handle the processing in the cluster.

This method is called prior to any processing in the server, e.g. the timer expired handler, any event handlers, etc.

Returns:

true if the server instance is registered; false otherwise

Throws:

IfsException - if the operation fails

isServerRunning

public boolean isServerRunning()
                        throws IfsException

Deprecated.

Checks to see if the Server is considered a "running server", by adding itself to the table of running servers.

Returns:

true if the server is considered a "running server"; false otherwise

Throws:

IfsException - if the operation fails