public class ClusteringToken extends Object
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.
|
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 and Description |
---|
ClusteringToken()
Deprecated.
Constructs a ClusteringToken.
|
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.
|
public static final int SERVER_REGISTRATION_TYPE_UNKNOWN
public static final int SERVER_REGISTRATION_TYPE_NONE
public static final int SERVER_REGISTRATION_TYPE_BACKUP
public static final int SERVER_REGISTRATION_TYPE_SECONDARY
public static final int SERVER_REGISTRATION_TYPE_PRIMARY
public static final String POSITIONAL_NODE_ALIAS_PREFIX
Currently has the value "$$NODE".
public static final String[] REGISTRATION_TYPE_STRINGS
public ClusteringToken()
public void initialize(String agentId, String nodeId, String serverId, String nodeName, long regPeriod, boolean nonCompete)
agentId
- the agent identifiernodeId
- the node identifierserverId
- the running server identifiernodeName
- the node nameregPeriod
- the registration periodnonCompete
- whether the token is non-competingpublic boolean isRegistered()
public String getAgentIdentifier()
public String getRunningNodeIdentifier()
Is a composite of the running node name and the service ID, e.g. "stadc35_node1:9461928".
public String getRunningServerIdentifier()
Is a composite of the agent identifier and the running node identifer, e.g. "IFS.AGENT.INTERNAL.CleanupAgent:stadc35_node1:9461928".
public String getRunningNodeName()
public String getEffectiveNodeList()
public String getRegistrationTypeString()
protected String getRegistrationTypeString(int regType)
regType
- the Registration typeprotected int getRegistrationTypeFromString(String regTypeStr)
regTypeStr
- the Registration type stringprotected int getRegistrationType()
public boolean isTokenNonCompeting()
A non-competing token is one that always assumes a Primary registration type (responsibility), and always attempts to free the ApplicationToken upon unregistration.
public long getRegistrationPeriod()
public String getClusteringStatus()
public void setRegistrationPeriod(long regPeriod)
regPeriod
- the registration periodprotected void setClusteringStatus(String status)
status
- the clustering statuspublic void refreshRegistrationType(LibrarySession session) throws IfsException
session
- the session contextIfsException
- if the operation failspublic void releaseRegistration(LibrarySession session) throws IfsException
session
- the session contextIfsException
- if the operation failsprotected void releaseToken(LibrarySession session, String agentId, ApplicationToken token) throws IfsException
session
- the session contextagentId
- the agent ID of the tokentoken
- the token to releaseIfsException
- if the operation failspublic boolean checkRegistration(LibrarySession session, Long appTokenId) throws IfsException
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.
session
- the session contextappTokenId
- the token Id context; null indicates that
the registration check should unequivocallyIfsException
- if the operation failsprotected void challengeNodes(LibrarySession session, ApplicationToken appToken) throws IfsException
session
- the session contextappToken
- the ApplicationTokenIfsException
- if the operation failsprotected boolean challengeNode(LibrarySession session, String nodeId) throws IfsException
session
- the session contextnodeId
- the node ID to be challengedIfsException
- if the operation failsprotected boolean performTokenUpdates(LibrarySession session, ApplicationToken appToken) throws IfsException
session
- the session contextappToken
- the ApplicationTokenIfsException
- if the operation failsprotected boolean updateTokenClearRegistration(LibrarySession session, String agentId, ApplicationToken appToken, String nodeId) throws IfsException
session
- the session contextagentId
- the agent ID of the tokenappToken
- the ApplicationToken to modifynodeId
- the node ID performing this operationIfsException
- if the operation failsprotected boolean updateTokenClearNodeRegistration(LibrarySession session, ApplicationToken token, String nodeId, long expirePeriod) throws IfsException
session
- the session contexttoken
- the node token to modifynodeId
- the expected node IDexpirePeriod
- the expiration periodIfsException
- if the operation failsprotected static void initializeDefaultDeclarations()
protected int getPositionInStringArray(String value, String[] array, boolean ignoreCase)
The specified value must not be null. Returns the position of the first match.
value
- the string value to check forarray
- the string arrayignoreCase
- whether to ignore case while checkingCopyright © 2023. All rights reserved.