18.1.5 CacheException class

Organization of this subsection

(1) Description
(2) Inheritance relationship
(3) Format
(4) List of methods
(5) getErrorCode()

(1) Description

This is an exception class that is returned when an operation on the Cache and CacheManager classes fails.

Use getErrorCode() to obtain an error code to determine the nature of the error.

(2) Inheritance relationship

java.lang.Object
java.lang.Throwable
  java.lang.Exception
    com.hitachi.software.xeads.client.api.CacheException

To Page Top

(3) Format

public class CacheException
extends Exception

To Page Top

(4) List of methods

The following table lists and describes the methods provided by the CacheException class:

Method name	Description
`getErrorCode()`	Acquires an error code for an exception that has occurred.

To Page Top

(5) getErrorCode()

(a) Description

This method acquires an error code for an exception that has occurred.

(b) Format

public int getErrorCode()

(c) Return value

This method returns an error code as a return value. The following table lists the error codes and describes the nature and cause of the error:

Error code	Error code literal	Exception class	Nature of error	Cause of error	Processing status of data updating API method^#	Error code when 0300 is specified in the eads.client.compat parameter in the client properties
`1000`	`EAD_ERROR_UNEXPECTED`	`CacheException`	An unexpected error occurred.	An unexpected error occurred within the program.	U	`1000`
`1010`	`EAD_ERROR_INVALID_PARAMETER`	`UserOperationException`	A specified parameter is invalid.	An invalid parameter was specified in the API method argument.	N	`1010`
`1030`	`EAD_ERROR_CLIENT_FINALIZED`	`UserOperationException`	The processing cannot be performed because usage of the EADS client has been terminated.	A method of `CacheManager` class was executed after `destroy()` of the `CacheManager` class was executed.	N	`1030`
`1040`	`EAD_ERROR_CACHE_NOT_STARTED`	`UserOperationException`	The processing cannot be performed because the cache has not been started.	Possible causes are as follows: An attempt was made to manipulate data after the cache was terminated (after `removeCache()` of the `CacheManager` class was executed). An attempt was made to manipulate data after usage of the EADS client was terminated (after `destroy()` of the `CacheManager` class was executed).	N	`1040`
`1050`	`EAD_ERROR_NOT_SERIALIZABLE`	`UserOperationException`	Serialization processing failed on the EADS client.	The object specified in the API method argument cannot be serialized.	N	`1050`
`1060`	`EAD_ERROR_NOT_DESERIALIZABLE`	`UserOperationException`	Deserialization processing failed on the EADS client.	The object acquired from the EADS server could not be deserialized on the EADS client. The object might not be included in the class path of the EADS client.	--	`1060`
`1100`	`EAD_ERROR_CACHE_NOT_NEED_STOP`	`UserOperationException`	An attempt was made to stop a cache that has already stopped.	The following are possible causes of the error: An attempt was made to terminate a cache after the cache had already been terminated (after `removeCache()` of the `CacheManager` class was executed). `removeCache()` of the `CacheManager` class was executed without executing `getCache()` of the `CacheManager` class.	--	`1100`
`1110`	`EAD_ERROR_INVALID_NODE_ADDRESS`	`UserOperationException`	The specified EADS server's address information does not match any EADS server address information maintained by the EADS client.	The address information (IP address and port number) of the EADS server specified in the argument of the API method does not match any EADS server address information maintained by the EADS client.	--	`1110`
`1120`	`EAD_ERROR_EXCEED_MAX_CONNECTION_POOL_SIZE`	`UserOperationException`	The number of connections to be pooled for the same connection target has already reached the maximum value and all of them are in use.	The number of concurrent threads issuing requests to the same EADS server has exceeded the maximum number of connections.	N	`1120`
`2000`	`EAD_ERROR_INIT`	`InitializeException`	EADS client initialization processing resulted in an error.	An unexpected error occurred during execution of `create()` of the `CacheManager` class.	--	`2000`
`2010`	`EAD_ERROR_INIT_PROPERTIES`	`InitializeException`	The client property file could not be imported.	Possible causes are as follows: There was no client property file. The client property file does not have read permissions. The specified storage destination path name is a directory, not a file. There is a problem in the input stream specified in `create()` of the `CacheManager` class.	--	`2010`
`2020`	`EAD_ERROR_INIT_INVALID_PROPERTY`	`InitializeException`	A definition in the client property file was invalid.	A definition in the client property file is invalid.	--	`2020`
`2030`	`EAD_ERROR_INIT_LOGGER`	`InitializeException`	Initialization of logs failed.	Possible causes are as follows: The specified directory or log file at the output destination does not have write permissions. The specified directory contains a file with the same name. The specified path name or file name is invalid. There is a directory that has the same name as the log file name. There is not enough memory to start outputting logs.	--	`2030`
`2040`	`EAD_ERROR_INIT_CLUSTERINFO`	`InitializeException`	Establishment of a connection with the EADS server specified in the client property file failed.	Possible causes are as follows: There is an error in the specification of the connection-target EADS server in the client properties. Communication with the connection-target EADS server failed, or a failure occurred on the connection-target EADS server. The maximum number of simultaneous connections to the EADS server has been exceeded. The connection-target EADS server is not ready to accept requests.	--	`2040`
`3000`	`EAD_ERROR_NET`	`ServerCommunicationException`	An error occurred during communication with the EADS server.	Possible causes are as follows: A network error occurred during communication. A problem occurred on the EADS server with which the client was communicating. A problem occurred on the host with which the client was communicating.	U	`3000`
`3001`	`EAD_ERROR_NET_SEND_REQUEST`	`ServerCommunicationException`	A communication error occurred while a request was being sent to an EADS server.	Possible causes are as follows: A network error occurred during communication. A problem occurred on the EADS server with which the client was communicating. A problem occurred on the host with which the client was communicating.	U	`3000`
`3002`	`EAD_ERROR_NET_RECEIVE_RESPONSE`	`ServerCommunicationException`	A communication error occurred while a response was being received from an EADS server.	Possible causes are as follows: A network error occurred during communication. A problem occurred on the EADS server with which the client was communicating. A problem occurred on the host with which the client was communicating.	U	`3000`
`3010`	`EAD_ERROR_NET_TIMEOUT`	`ServerCommunicationException`	A timeout occurred during communication with the EADS server.	Possible causes are as follows: A problem occurred on the connection-target EADS server. A problem occurred on the connection-target host. A problem occurred on the network. The specified timeout value is invalid.	U	`3010`
`3011`	`EAD_ERROR_NET_SEND_TIMEOUT`	`ServerCommunicationException`	A timeout occurred while a request was being sent to an EADS server.	Possible causes are as follows: A problem occurred on the connection-target EADS server. A problem occurred on the connection-target host. A problem occurred on the network. The specified timeout value is invalid.	U	`3010`
`3012`	`EAD_ERROR_NET_RECEIVE_TIMEOUT`	`ServerCommunicationException`	A timeout occurred while a response was being received from an EADS server.	Possible causes are as follows: A problem occurred on the connection-target EADS server. A problem occurred on the connection-target host. A problem occurred on the network. The specified timeout value is invalid.	U	`3010`
`3020`	`EAD_ERROR_NET_CONNECTION`	`ServerCommunicationException`	Connection establishment with the EADS server failed.	Possible causes are as follows: A problem occurred on the connection-target EADS server. The settings related to the connection-target EADS server are invalid. A problem occurred on the network. The specified timeout value is invalid.	N	`3020`
`3030`	`EAD_ERROR_NET_PROTOCOL`	`ServerCommunicationException`	A protocol error occurred during communication with the EADS server.	The connection-target EADS server might be invalid.	U	`3030`
`3040`	`EAD_ERROR_NET_CLUSTERINFO`	`ServerCommunicationException`	Establishment of a connection with all connectable EADS servers failed.	Possible causes are as follows: A problem occurred on the connection-target EADS server. The settings related to the connection-target EADS server are invalid. A problem occurred on the network. The specified cache does not exist on the connection-target EADS server. The connection-target EADS server has been closed. The cluster information maintained by the EADS client does not match the cluster information maintained by the restarted connection-target EADS server. The maximum number of simultaneous connections to the EADS server has been exceeded.	--	`3040`
`4000`	`EAD_ERROR_SERVER`	`InternalServerException`	An unexpected internal error occurred on the EADS server.	An unexpected problem occurred on the connection-target EADS server.	U	`4000`
`4010`	`EAD_ERROR_SERVER_UNSUPPORTED_REQUEST`	`InternalServerException`	The connection-target EADS server could not process the request sent by the EADS client.	Possible causes are as follows: The connection-target EADS server cannot process the request for a reason such as corrupted data. The API method used is not supported by the connection-target EADS server.	N	`4010`
`4030`	`EAD_ERROR_SERVER_UNAVAILABLE`	`InternalServerException`	The connection-target EADS server process is temporarily unavailable.	The maximum number of simultaneous connections to the EADS server has been exceeded.	N	`4030`
`4040`	`EAD_ERROR_SERVER_INCOMPATIBLE_CLUSTERINFO`	`InternalServerException`	The cluster information maintained by the connection-target EADS server is not compatible with the cluster information maintained by the EADS client.	The cluster information maintained by the restarted connection-target EADS server does not match the cluster information maintained by the EADS client.	N	`4040`
`4060`	`EAD_ERROR_SERVER_REPLACE_METHOD_NOT_MATCHED`	`InternalServerException`	The value could not be stored because the stored value did not match `comparativeValue` during execution of `replace()`.	The value specified for the condition in `replace()` of the `Cache` class did not match the value in cache.	N	`4060`
`4070`	`EAD_ERROR_SERVER_REPLACE_METHOD_KEY_NOT_EXIST`	`InternalServerException`	The value could not be stored because the specified key did not exist during execution of `replace()` (the value associated with the key did not exist).	Values could not be compared because the value associated with the key specified in `replace()` of the `Cache` class did not exist.	N	`4070`
`4080`	`EAD_ERROR_SERVER_CREATE_METHOD_KEY_EXIST`	`InternalServerException`	The value could not be stored because the key had already been stored during execution of `create()`.	The value associated with the key specified in `create()` of the `Cache` class has already been stored.	N	`4080`
`4090`	`EAD_ERROR_SERVER_UPDATE_METHOD_KEY_NOT_EXIST`	`InternalServerException`	The value could not be stored because the key was not stored during execution of `update()`.	The value associated with the key specified in `update()` of the `Cache` class has not been stored.	N	`4090`
`4100`	`EAD_ERROR_SERVER_NOT_RUNNING`	`InternalServerException`	No EADS server is available for processing requests.	Possible causes are as follows: The EADS server that processes requests from the EADS client and the EADS servers to which data is to be copied are all isolated or stopped. The cluster is not available.	N	`4100`
`4110`	`EAD_ERROR_SERVER_STATUS`	`InternalServerException`	The EADS server is in a status in which requests cannot be processed.	The request could not be processed due to the status of the connection-target EADS server.	N	`4000`
`4200`	`EAD_ERROR_SERVER_CACHE`	`InternalServerException`	A cache operation failed.	An operation could not be performed on a cache because a problem occurred on the connection-target EADS server. Stop the operation and check the EADS server's status.	N	`4000`
`4210`	`EAD_ERROR_SERVER_CACHE_NOT_FOUND`	`InternalServerException`	A cache operation failed because the specified cache did not exist.	An operation could not be performed on a cache because the specified cache did not exist. Stop operation on the specified cache and check the EADS server's status.	N	`4000`
`4230`	`EAD_ERROR_SERVER_CACHE_CLUSTER_UPDATE`	`InternalServerException`	A cache operation failed because the cluster configuration was changed during request processing.	An operation could not be performed on a cache because the cluster configuration was changed during request processing. Perform the cache operation again after the cluster configuration change processing has been completed.	N	`4000`
`4300`	`EAD_ERROR_SERVER_CACHE_BEFORE_REPLICATION`	`InternalServerException`	An internal error occurred during a cache operation, but redundant copies of data had not been created.	An internal error occurred during a cache operation on the connection-target EADS server. No other normal EADS servers are affected because redundant copies of data had not been created. You can restart the same operation after the EADS server is isolated and then the connection target is changed to a normal EADS server.	N	`4000`
`4310`	`EAD_ERROR_SERVER_CACHE_AFTER_REPLICATION`	`InternalServerException`	An internal error occurred on the EADS server during cache operation and the data update operation failed.	An internal error occurred on the connection-target EADS server during cache operation. Because redundant copies of data had already been created, once the erroneous connection-target EADS server is isolated and the connection target is changed to a normal server, you can resume the operation from the status in which data had been updated.	U	`4000`
`4700`	`EAD_ERROR_SERVER_FUNCTION_EXECUTE`	`InternalServerException`	An error occurred in the user function on the EADS server.	An error occurred in the user function on the connection-target EADS server. Check the user function's processing.	--	`4000`
`4710`	`EAD_ERROR_SERVER_FUNCTION_RETURN_SERIALIZE`	`InternalServerException`	Serialization processing on the return value of the user function failed on the EADS server.	An object that is not serializable is specified for the return value of the user function executed on the connection-target EADS server.	--	`4000`
`4720`	`EAD_ERROR_SERVER_FUNCTION_ARG_DESERIALIZE`	`InternalServerException`	An object that cannot be deserialized by the EADS server is specified in the argument of the user function.	An object that cannot be deserialized by the connection-target EADS server is specified in the argument of the user function.	--	`4100`
`4730`	`EAD_ERROR_SERVER_FUNCTION_NOT_FOUND`	`InternalServerException`	No user function with the specified user function name exists on the EADS server.	No user function with the specified user function name exists on the connection-target EADS server.	--	`4000`
`4800`	`EAD_ERROR_SERVER_LIMIT_EXTERNAL_MEMORY`	`InternalServerException`	There is a shortage of memory for storing data.	The request could not be processed because the memory for storing data (explicit heap) was insufficient on the connection-target EADS server.	N	`4000`
`4810`	`EAD_ERROR_SERVER_LIMIT_CACHE_FILE`	`InternalServerException`	There is a shortage of capacity in the cache files for storing data.	The request could not be processed because the capacity of cache files for storing data was insufficient on the connection-target EADS server.	N	`4000`
`4820`	`EAD_ERROR_SERVER_LIMIT_KV_COUNT`	`InternalServerException`	The number of keys that can be stored on the EADS server has reached the upper limit.	The request could not be processed because the number of keys that can be specified on the connection-target EADS server had reached the upper limit.	N	`4000`
`4830`	`EAD_ERROR_SERVER_LIMIT_KEY_VALUE_LENGTH`	`InternalServerException`	The size of the specified key, group name, or value is greater than the maximum size permitted in the cluster.	The request could not be processed because the size of the specified key, group name, or value was greater than the maximum size permitted in the cluster.	N	`4000`
`4999`	`EAD_ERROR_SERVER_UNKNOWN`	`InternalServerException`	A nonanalyzable internal error occurred on the EADS server.	An internal error occurred on the connection-target EADS server, but the error could not be analyzed because the version of the connection-target EADS server was later than the version of the EADS client libraries.	U	`4000`
`5000`	`EAD_ERROR_CLIENT`	`InternalClientException`	An internal error occurred on the EADS client.	An unexpected error occurred in client libraries.	U	`5000`
`5010`	`EAD_ERROR_CLIENT_OUT_OF_MEMORY`	`InternalClientException`	Memory allocation in the EADS client failed.	Memory allocation failed in client libraries.	U	`5010`
`5020`	`EAD_ERROR_CLIENT_BATCH_CANCEL`	`InternalClientException`	Batch operation was cancelled.	Unperformed operations were cancelled because batch operation could not be continued.	N	`5020`
`6000`	`EAD_ERROR_BATCH_FAILED_ALL`	`BatchOperationException`	All of the batch operations failed.	An attempt was made to perform a batch operation on data by using an API method, but all operations failed.	--	`6000`
`6010`	`EAD_ERROR_BATCH_FAILED_PART`	`BatchOperationException`	Part of the batch operations failed.	An attempt was made to perform a batch operation on data by using an API method, but some of the operations failed.	--	`6010`

#

Indicates whether data updating had occurred when the error code was issued during execution of an API method for updating data, such as put() or remove().

The meanings of the letters in this column are as follows:

U: Whether the data had been updated is unknown. Check whether the processing was completed.

N: The data has not been updated.

--: This error code is not issued when an API method for updating data, such as put() or remove(), is executed.

To Page Top