Interface CorrelationIdPoolLocal
-
- All Superinterfaces:
ProfileLocalObject
public interface CorrelationIdPoolLocal extends ProfileLocalObject
SBB view of the configuration parameters for a Correlation Id Pool
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String[]
getAddressPrefixes()
int
getCorrelationIDNumberOfDigits()
int[]
getCorrelationIDRangePerNode()
Defines the range of values used in each node in conjunction with theNodeIds
attribute in the following way:boolean
getIsPreconfiguredCorrelationIdSetUsed()
long
getMaxCorrelationIDInCluster()
long
getMinCorrelationIDInCluster()
int[]
getNodeIds()
This array of nodeIds is used in conjunction with the attributeCorrelationIDRangePerNode
because each position of both arrays are related.String[]
getPreconfiguredCorrelationIdSet()
-
Methods inherited from interface javax.slee.profile.ProfileLocalObject
getProfileName, getProfileTable, getProfileTableName, isIdentical, remove
-
-
-
-
Method Detail
-
getAddressPrefixes
String[] getAddressPrefixes()
- Returns:
- address prefixes that identify this correlation id pool (or null for the default id pool)
-
getCorrelationIDNumberOfDigits
int getCorrelationIDNumberOfDigits()
- Returns:
- the number of digits the Correlation ID should have
-
getCorrelationIDRangePerNode
int[] getCorrelationIDRangePerNode()
Defines the range of values used in each node in conjunction with theNodeIds
attribute in the following way:The node whose identifier is NodeIds[i] has a range of values of CorrelationIDRangePerNode[i]. Each cluster has a range of CorrelationIDs defined by the attributes: [MinCorrelationIDInCluster,MaxCorrelationIDInCluster]
These values must be split between the different nodes following the next rule:
NodeIds[0]: [MinCorrelationIDInCluster ... MinCorrelationIDInCluster + CorrelationIDRangePerNode[0]
NodeIds[1]: [MinCorrelationIDInCluster + CorrelationIDRangePerNode[0] + 1 ... MinCorrelationIDInCluster + CorrelationIDRangePerNode[0] + 1 + CorrelationIDRangePerNode[1]]
etc.- Returns:
- the number of values that each node in the cluster that can be used for the Correlation ID.
-
getIsPreconfiguredCorrelationIdSetUsed
boolean getIsPreconfiguredCorrelationIdSetUsed()
- Returns:
- true if the preconfigured set of Correlation IDs is to be used
-
getMaxCorrelationIDInCluster
long getMaxCorrelationIDInCluster()
- Returns:
- the maximum Correlation ID value used in the cluster
-
getMinCorrelationIDInCluster
long getMinCorrelationIDInCluster()
- Returns:
- the minimum Correlation ID value used in the cluster
-
getNodeIds
int[] getNodeIds()
This array of nodeIds is used in conjunction with the attributeCorrelationIDRangePerNode
because each position of both arrays are related. So the node in the position x has the range defined in the same position of the other array.- Returns:
- an array with the nodeIds
-
getPreconfiguredCorrelationIdSet
String[] getPreconfiguredCorrelationIdSet()
- Returns:
- the preconfigured set of Correlation IDs per node (delimited with ":")
-
-