18.2.6 ClusterInfo interface
- Organization of this subsection
-
(1) Description
This interface acquires information about the cluster.
(2) Interface name
com.hitachi.software.xeads.common.ClusterInfo
(3) List of methods
The following table lists and describes the methods provided by the ClusterInfo interface:
Method name |
Description |
---|---|
Acquires the data multiplicity. |
|
Acquires a list of cache names of the caches that have been created on the EADS server that is executing the user function. The acquired cache names are listed in ascending order based on their ASCII code values. |
|
Acquires information about a specified cache. |
|
Acquires the position (hash value) that corresponds to a specified key or group name. |
|
Acquires the range ID of the range that corresponds to a specified position. |
|
Acquires the range ID of the range that corresponds to a specified key or group name. |
|
Acquires a list of range IDs of all ranges that are to be processed at the source or target of copy processing by the EADS server that is executing the user function. |
|
Acquires a value indicating whether a specified range is the source or target of copy processing by the EADS server that is executing the user function. |
|
Acquires a value indicating whether a specified range is the source of copy processing by the EADS server that is executing the user function. |
(4) getReplicationFactor()
(a) Description
This method acquires the data multiplicity.
(b) Format
public int getReplicationFactor()
(c) Return value
This method returns the data multiplicity
(5) getCacheNames()
(a) Description
This method acquires a list of cache names of the caches that have been created on the EADS server that is executing the user function.
The cache names are listed in ascending order based on their ASCII code values.
(b) Format
public String[] getCacheNames()
(c) Return value
This method returns a list of cache names of the caches that have been created on the EADS server that is executing the user function.
(6) getCacheInfo()
(a) Description
This method acquires information about a specified cache.
(b) Format
public CacheInfo getCacheInfo(String cacheName) throws EADsStoreException
(c) Parameters
- cacheName
-
Specifies a cache name.
For details about the data that can be specified, see 15.2.2(4) Data types that can be specified as cache names.
(d) Return value
This method returns an instance that contains information about the cache with the specified cache name.
(e) Exceptions
-
UserOperationException (illegal user operation)
(7) getPosition()
(a) Description
This method acquires the position (hash value) that corresponds to a specified key or group name.
(b) Format
public int getPosition(String keyOrGroupName) throws EADsStoreException
(c) Parameters
- keyOrGroupName
-
Specifies a key or a group name.
For details about the data that can be specified, see 15.2.2(1) Data types that can be specified as keys or 15.2.2(2) Data that can be specified as group names.
(d) Return value
This method returns the position (hash value) that corresponds to the specified key or group name.
(e) Exceptions
-
UserOperationException (illegal user operation)
-
InternalServerException (EADS server internal error)
-
EADsStoreException (unexpected error)
(8) getRangeId() (position specification)
(a) Description
This method acquires the range ID of the range that corresponds to a specified position.
(b) Format
public int getRangeId(int position) throws EADsStoreException
(c) Parameters
- position
-
Specifies a position.
(d) Return value
This method returns the range ID of the range that corresponds to the specified position.
(e) Exceptions
-
EADsStoreException (unexpected error)
(9) getRangeId() (key or group name specification)
(a) Description
This method acquires the range ID of the range that corresponds to a specified key or group name.
(b) Format
public int getRangeId(String keyOrGroupName) throws EADsStoreException
(c) Parameters
- keyOrGroupName
-
Specifies a key or a group name.
For details about the data that can be specified, see 15.2.2(1) Data types that can be specified as keys or 15.2.2(2) Data that can be specified as group names.
(d) Return value
This method returns the range ID of the range that corresponds to the specified key or group name.
(e) Exceptions
-
UserOperationException (illegal user operation)
-
InternalServerException (EADS server internal error)
-
EADsStoreException (unexpected error)
(10) getLocalRangeId()
(a) Description
This method acquires a list of range IDs of all ranges that are to be processed as the source or target of copy processing by the EADS server that is executing the user function.
(b) Format
public int[] getLocalRangeId() throws EADsStoreException
(c) Return value
This method returns a list of range IDs of all ranges that are to be processed as the source or target of copy processing by the EADS server that is executing the user function.
(d) Exceptions
-
EADsStoreException (unexpected error)
(11) isLocalRange()
(a) Description
This method acquires a value indicating whether a specified range is the source or target of copy processing by the EADS server that is executing the user function.
(b) Format
public boolean isLocalRange(int rangeId) throws EADsStoreException
(c) Parameters
- rangeId
-
Specifies the range ID of a range.
(d) Return value
- true
-
The specified range is the source or target of copy processing by the EADS server that is executing the user function.
- false
-
The specified range is neither the source nor the target of copy processing by the EADS server that is executing the user function.
(e) Exceptions
-
EADsStoreException (unexpected error)
(12) isLocalMasterRange()
(a) Description
This method acquires a value indicating whether a specified range is the source of copy processing by the EADS server that is executing the user function.
(b) Format
public boolean isLocalMasterRange(int rangeId) throws EADsStoreException
(c) Parameters
- rangeId
-
Specifies the range ID of a range.
(d) Return value
- true
-
The specified range is the source of copy processing by the EADS server that is executing the user function.
- false
-
The specified range is not the source of copy processing by the EADS server that is executing the user function.
(e) Exceptions
-
InternalServerException (EADS server internal error)
-
EADsStoreException (unexpected error)