|
IBM WebSphere® DataPower® XC10 Appliance Release 2.0 Client API Specification |
||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
BackingMap | This is the public interface to the BackingMap. |
ClientClusterContext | This interface is a context to represent which cluster/domain the client connected to
using one of the ObjectGridManager.connect methods. |
ClientReplicableMap | This interface represents a replicable client map. |
IObjectGridException | This interface is used to ensure JDK 1.4 Throwable chaining behavior for all exceptions thrown by ObjectGrid even when an earlier JDK is used (e.g. |
JavaMap | This interface is a handle to a named Map. |
ObjectGrid | This object is used for creating sessions to the ObjectGrid. |
ObjectGridManager | ObjectGridManager is responsible for creating or retrieving local ObjectGrid instances and connecting to distributed ObjectGrid servers. |
ObjectMap | This is a handle to a named Map. |
PartitionManager | This interface will be used for calculating the proper partition for a given input key. |
Session | This interface represents a session container for ObjectMap s. |
StateManager | The StateManager can be used to retrieve the availability state of an ObjectGrid. |
TxID | This interface is an opaque identifier for a transaction. |
Class Summary | |
---|---|
AvailabilityState | Each shard in a distributed ObjectGrid has an availability state associated with it. |
ClientReplicableMap.Mode | Client Replication mode |
CopyMode | This class is used to define the "copy" mode when the
setCopyMode method of the BackingMap interface is used. |
LockStrategy | LockStrategy provides an enumerated type idiom for use on the
BackingMap.setLockStrategy(LockStrategy) method. |
ObjectGridManagerFactory | This factory class is a high level helper class to get ObjectGridManager instances. |
TTLType | Every BackingMap in ObjectGrid has a built in timed based evictor that is referred to as "time to live" evictor or TTL evictor. |
Exception Summary | |
---|---|
ClientServerMultipleReplicationGroupMemberWriteTransactionCallbackException | This exception is thrown when a method call to the Client/Server TransactionCallback detects the user is attempting to perform a write against multiple maps in different Map Sets, Partition Sets or Replication groups. |
ConnectException | This exception is used to indicate that the client was unable to connect to the server |
DuplicateKeyException | A DuplicateKeyException exception is thrown if a key cannot be inserted into a BackingMap because an object with the same key already exists. |
KeyNotFoundException | Normally, record not found means a null is returned. |
LockDeadlockException | This exception is used by the lock manager to indicate that it detected a deadlock. |
LockException | A general locking exception indicating something went wrong with locking operations. |
LockInternalFailureException | This exception is used by the lock manager to indicate it detected some internal programming error while processing a lock or unlock request. |
LockTimeoutException | This exception is used by the lock manager to indicate that the maximum wait time for a lock has been exceeded. |
NoActiveTransactionException | An exception indicating there is no active transaction. |
ObjectGridException | Base exception class for all checked exceptions thrown by the ObjectGrid product. |
ObjectGridRuntimeException | This exception is the base class for all runtime exceptions thrown by the cache. |
ReadOnlyException | This exception is thrown when an attempt is made to modifying operations on a read only maps. |
ReplicationVotedToRollbackTransactionException | This exception is thrown when a transaction was rolled back because some/all of the replicas failed to apply the transaction when in synchronous replication mode. |
SessionNotReentrantException | A Session object can only be used by a single thread concurrently to perform map operations. |
TargetNotAvailableException | A TargetNotAvailableException indicates the ObjectGrid target is not available. |
TransactionAffinityException | This exception is thrown for inflight transaction when server fails over. |
TransactionAlreadyActiveException | An exception indicating a transaction is already active for the current session. |
TransactionException | A general transaction exception indicating something went wrong with a transaction. |
TransactionQuiesceException | This exception is thrown when partition/shard/mapset/replication group/ replication group member/server/cluster/objectgrid is entered quiesce process for various reasons such as shard movement, partition relocation, system update, server shutdown, and others. |
TransactionTimeoutException | This exception is thrown when a transaction exceeds the transaction timeout
that was specified on the ObjectGrid or Session . |
UnavailableServiceException | This exception is thrown when all servers are dead or when all services are unavailable even though servers are running. |
UndefinedMapException | This exception indicates that the map which an application tries to access is not defined in the ObjectGrid. |
These are the main application APIs for the ObjectGrid. The main interface here is the ObjectGrid interface. A JVM needs to create at least one instance.
ObjectGrid objectGrid = new ObjectGridImpl();
The instance can then have a Map defined on it using the following snippet:
BackingMap bm = objectGrid.defineMap("TABLE1");
Again, setter methods on BackingMap allow it to be configured once it's defined.
Session session = objectGrid.getSession();
ObjectMap table1 = session.getMap("TABLE1");
session.begin();
MyData d = (MyData)table1.get("key1");
session.commit();
|
IBM WebSphere® DataPower® XC10 Appliance Release 2.0 Client API Specification |
||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |