oracle.ifs.common

Class ClusteringToken

java.lang.Object

oracle.ifs.common.ClusteringToken

Direct Known Subclasses:

TieClusteringToken

Deprecated.

9.3.4.0: no longer used by the new runtime system.

public class ClusteringToken
extends Object

A ClusteringToken represents the state of an agent token, from the perspective of a specific instance checking its registation for the token.

Author:

Dave Long

(Unpublished)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ClusteringToken.RegistrationTypeCalculator Deprecated. A RegistrationTypeCalculator calcualtes the registration type for a ClusteringToken.
class	ClusteringToken.TokenState Deprecated. A TokenState represents the persistent state of the token, in a form that is convenient to use by ClusteringToken operations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	POSITIONAL_NODE_ALIAS_PREFIX Deprecated. Prefix used to identify posiitonal node alias names.
static String[]	REGISTRATION_TYPE_STRINGS Deprecated. String representations of the enumerated registration types.
static int	SERVER_REGISTRATION_TYPE_BACKUP Deprecated. The Registration type value used classify Backup server registrations.
static int	SERVER_REGISTRATION_TYPE_NONE Deprecated. The Registration type value used to indicate no registration.
static int	SERVER_REGISTRATION_TYPE_PRIMARY Deprecated. The Registration type value used classify Primary server registrations.
static int	SERVER_REGISTRATION_TYPE_SECONDARY Deprecated. The Registration type value used classify Secondary server registrations.
static int	SERVER_REGISTRATION_TYPE_UNKNOWN Deprecated. The Registration type value used to indicate no registration.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected boolean	challengeNode(LibrarySession session, String nodeId) Deprecated. Challenge the node token for the specified Node ID.
protected void	challengeNodes(LibrarySession session, ApplicationToken appToken) Deprecated. Challenge one of the nodes holding either registree or standby.
boolean	checkRegistration(LibrarySession session, Long appTokenId) Deprecated. Checks the registration for this Server.
String	getAgentIdentifier() Deprecated. Gets the agent identifier.
String	getClusteringStatus() Deprecated. Returns the clustering status, used to publish the status of this instance.
String	getEffectiveNodeList() Deprecated. Gets the effective node list, used to calculate the registration type (responsibility).
protected int	getPositionInStringArray(String value, String[] array, boolean ignoreCase) Deprecated. Return position of the specified string in the array, or -1 if it is not in the array.
long	getRegistrationPeriod() Deprecated. Gets the registration period.
protected int	getRegistrationType() Deprecated. Gets the enum used to classify the type (responsibility) of registration.
protected int	getRegistrationTypeFromString(String regTypeStr) Deprecated. Gets the enumerated int constant that corresponds to the string value used to classify the type (responsibility) of registration.
String	getRegistrationTypeString() Deprecated. Gets the string constant that corresponds to the enumerated valued used to classify the type (responsibility) of registration.
protected String	getRegistrationTypeString(int regType) Deprecated. Gets the string constant that corresponds to the enumerated valued used to classify the type (responsibility) of registration.
String	getRunningNodeIdentifier() Deprecated. Gets the string used to identify a running node.
String	getRunningNodeName() Deprecated. Gets the name of the running node.
String	getRunningServerIdentifier() Deprecated. Gets the string used to identify a running server.
void	initialize(String agentId, String nodeId, String serverId, String nodeName, long regPeriod, boolean nonCompete) Deprecated. Initializes a ClusteringToken.
protected static void	initializeDefaultDeclarations() Deprecated. Initialize the set of tables that define the default agent ID declarations.
boolean	isRegistered() Deprecated. Gets indication of whether this token is registered, from the perspective of the caller
boolean	isTokenNonCompeting() Deprecated. Returns indication as to whether the token is non-competing.
protected boolean	performTokenUpdates(LibrarySession session, ApplicationToken appToken) Deprecated. Perform any appropriate updates to the ApplicationToken.
void	refreshRegistrationType(LibrarySession session) Deprecated. Refreshes the registration type (responsibility) for this token.
void	releaseRegistration(LibrarySession session) Deprecated. Releases the registration for the token.
protected void	releaseToken(LibrarySession session, String agentId, ApplicationToken token) Deprecated. Releases the token.
protected void	setClusteringStatus(String status) Deprecated. Sets the clustering status.
void	setRegistrationPeriod(long regPeriod) Deprecated. Sets the registration period.
protected boolean	updateTokenClearNodeRegistration(LibrarySession session, ApplicationToken token, String nodeId, long expirePeriod) Deprecated. Updates the specified node token, in an attempt to expire it.
protected boolean	updateTokenClearRegistration(LibrarySession session, String agentId, ApplicationToken appToken, String nodeId) Deprecated. Updates the specified ApplicationToken, in an attempt to clear its registraton.

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_REGISTRATION_TYPE_UNKNOWN

public static final int SERVER_REGISTRATION_TYPE_UNKNOWN

Deprecated.

The Registration type value used to indicate no registration.

See Also:

Constant Field Values

SERVER_REGISTRATION_TYPE_NONE

public static final int SERVER_REGISTRATION_TYPE_NONE

Deprecated.

The Registration type value used to indicate no registration.

See Also:

Constant Field Values

SERVER_REGISTRATION_TYPE_BACKUP

public static final int SERVER_REGISTRATION_TYPE_BACKUP

Deprecated.

The Registration type value used classify Backup server registrations.

See Also:

Constant Field Values

SERVER_REGISTRATION_TYPE_SECONDARY

public static final int SERVER_REGISTRATION_TYPE_SECONDARY

Deprecated.

The Registration type value used classify Secondary server registrations.

See Also:

Constant Field Values

SERVER_REGISTRATION_TYPE_PRIMARY

public static final int SERVER_REGISTRATION_TYPE_PRIMARY

Deprecated.

The Registration type value used classify Primary server registrations.

See Also:

Constant Field Values

POSITIONAL_NODE_ALIAS_PREFIX

public static final String POSITIONAL_NODE_ALIAS_PREFIX

Deprecated.

Prefix used to identify posiitonal node alias names.

Currently has the value "$$NODE".

See Also:

Constant Field Values

REGISTRATION_TYPE_STRINGS

public static final String[] REGISTRATION_TYPE_STRINGS

Deprecated.

String representations of the enumerated registration types.

Constructor Detail

ClusteringToken

public ClusteringToken()

Deprecated.

Constructs a ClusteringToken.

Method Detail

initialize

public void initialize(String agentId,
                       String nodeId,
                       String serverId,
                       String nodeName,
                       long regPeriod,
                       boolean nonCompete)

Deprecated.

Initializes a ClusteringToken.

Parameters:

agentId - the agent identifier

nodeId - the node identifier

serverId - the running server identifier

nodeName - the node name

regPeriod - the registration period

nonCompete - whether the token is non-competing

isRegistered

public boolean isRegistered()

Deprecated.

Gets indication of whether this token is registered, from the perspective of the caller

Returns:

true if registered; false otherwise

getAgentIdentifier

public String getAgentIdentifier()

Deprecated.

Gets the agent identifier.

Returns:

the agent identifier

getRunningNodeIdentifier

public String getRunningNodeIdentifier()

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

getRunningServerIdentifier

public String getRunningServerIdentifier()

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

getRunningNodeName

public String getRunningNodeName()

Deprecated.

Gets the name of the running node.

Returns:

the running node name

getEffectiveNodeList

public String getEffectiveNodeList()

Deprecated.

Gets the effective node list, used to calculate the registration type (responsibility).

Returns:

the effective node list

getRegistrationTypeString

public String getRegistrationTypeString()

Deprecated.

Gets the string constant that corresponds to the enumerated valued used to classify the type (responsibility) of registration.

Returns:

the Registration type (responsibility)

getRegistrationTypeString

protected String getRegistrationTypeString(int regType)

Deprecated.

Gets the string constant that corresponds to the enumerated valued used to classify the type (responsibility) of registration.

Parameters:

regType - the Registration type

Returns:

the Registration type string

getRegistrationTypeFromString

protected int getRegistrationTypeFromString(String regTypeStr)

Deprecated.

Gets the enumerated int constant that corresponds to the string value used to classify the type (responsibility) of registration.

Parameters:

regTypeStr - the Registration type string

Returns:

the Registration type

getRegistrationType

protected int getRegistrationType()

Deprecated.

Gets the enum used to classify the type (responsibility) of registration.

Returns:

the Registration type

isTokenNonCompeting

public boolean isTokenNonCompeting()

Deprecated.

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

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

Returns:

true if token is non-competing; false otherwise

getRegistrationPeriod

public long getRegistrationPeriod()

Deprecated.

Gets the registration period.

Returns:

the registration period

getClusteringStatus

public String getClusteringStatus()

Deprecated.

Returns the clustering status, used to publish the status of this instance.

Returns:

the clustering status

setRegistrationPeriod

public void setRegistrationPeriod(long regPeriod)

Deprecated.

Sets the registration period.

Parameters:

regPeriod - the registration period

setClusteringStatus

protected void setClusteringStatus(String status)

Deprecated.

Sets the clustering status.

Parameters:

status - the clustering status

refreshRegistrationType

public void refreshRegistrationType(LibrarySession session)
                             throws IfsException

Deprecated.

Refreshes the registration type (responsibility) for this token.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

releaseRegistration

public void releaseRegistration(LibrarySession session)
                         throws IfsException

Deprecated.

Releases the registration for the token.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

releaseToken

protected void releaseToken(LibrarySession session,
                            String agentId,
                            ApplicationToken token)
                     throws IfsException

Deprecated.

Releases the token.

Parameters:

session - the session context

agentId - the agent ID of the token

token - the token to release

Throws:

IfsException - if the operation fails

checkRegistration

public boolean checkRegistration(LibrarySession session,
                                 Long appTokenId)
                          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:

session - the session context

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

challengeNodes

protected void challengeNodes(LibrarySession session,
                              ApplicationToken appToken)
                       throws IfsException

Deprecated.

Challenge one of the nodes holding either registree or standby.

Parameters:

session - the session context

appToken - the ApplicationToken

Throws:

IfsException - if the operation fails

challengeNode

protected boolean challengeNode(LibrarySession session,
                                String nodeId)
                         throws IfsException

Deprecated.

Challenge the node token for the specified Node ID.

Parameters:

session - the session context

nodeId - the node ID to be challenged

Returns:

true if the node token was released; false otherwise

Throws:

IfsException - if the operation fails

performTokenUpdates

protected boolean performTokenUpdates(LibrarySession session,
                                      ApplicationToken appToken)
                               throws IfsException

Deprecated.

Perform any appropriate updates to the ApplicationToken.

Parameters:

session - the session context

appToken - the ApplicationToken

Returns:

indication as to whether this ClusteringToken is the registree

Throws:

IfsException - if the operation fails

updateTokenClearRegistration

protected boolean updateTokenClearRegistration(LibrarySession session,
                                               String agentId,
                                               ApplicationToken appToken,
                                               String nodeId)
                                        throws IfsException

Deprecated.

Updates the specified ApplicationToken, in an attempt to clear its registraton.

Parameters:

session - the session context

agentId - the agent ID of the token

appToken - the ApplicationToken to modify

nodeId - the node ID performing this operation

Returns:

true if the token was updated; false otherwise

Throws:

IfsException - if the operation fails

updateTokenClearNodeRegistration

protected boolean updateTokenClearNodeRegistration(LibrarySession session,
                                                   ApplicationToken token,
                                                   String nodeId,
                                                   long expirePeriod)
                                            throws IfsException

Deprecated.

Updates the specified node token, in an attempt to expire it.

Parameters:

session - the session context

token - the node token to modify

nodeId - the expected node ID

expirePeriod - the expiration period

Returns:

true if the node token was updated; false otherwise

Throws:

IfsException - if the operation fails

initializeDefaultDeclarations

protected static void initializeDefaultDeclarations()

Deprecated.

Initialize the set of tables that define the default agent ID declarations.

getPositionInStringArray

protected int getPositionInStringArray(String value,
                                       String[] array,
                                       boolean ignoreCase)

Deprecated.

Return position of the specified string in the array, or -1 if it is not in the array.

The specified value must not be null. Returns the position of the first match.

Parameters:

value - the string value to check for

array - the string array

ignoreCase - whether to ignore case while checking

Returns:

the position within the array, or -1 if no match