com.sun.sgs.impl.service.data.store.net
Class DataStoreClient

java.lang.Object
  com.sun.sgs.impl.service.data.store.AbstractDataStore
      com.sun.sgs.impl.service.data.store.net.DataStoreClient

All Implemented Interfaces:

DataStore, TransactionParticipant

public final class DataStoreClient
extends AbstractDataStore

Provides an implementation of DataStore by communicating over the network to an implementation of DataStoreServer, and optionally runs the server.

The constructor supports the following properties:

Property: com.sun.sgs.impl.service.data.store.net.max.txn.timeout
Default: 600000

The maximum amount of time in milliseconds that a transaction that uses the data store will be permitted to run before it is a candidate for being aborted. This value must be greater than 0.

Whether to run the server by creating an instance of DataStoreServerImpl, using the properties provided to this instance's constructor.

Property: com.sun.sgs.impl.service.data.store.net.server.host
Default the value of the com.sun.sgs.server.host property, if present, or localhost if this node is starting the server.

The name of the host running the DataStoreServer.

Property: com.sun.sgs.impl.service.data.store.net.server.port
Default: 44530

The network port for the DataStoreServer. This value must be no less than 0 and no greater than 65535. The value 0 can only be specified if the com.sun.sgs.node.type property is not appNode, and means that an anonymous port will be chosen for running the server.

This class uses the Logger named com.sun.sgs.impl.service.data.store.net.client to log information at the following levels:

• SEVERE - Problems starting the server
• INFO - Starting the server
• CONFIG - Constructor properties
• FINE - Allocating object IDs
• FINEST - Object operations

Field Summary

Fields inherited from class com.sun.sgs.impl.service.data.store.AbstractDataStore

abortLogger, logger, nameAccesses, objectAccesses

Constructor Summary

DataStoreClient(Properties properties, ComponentRegistry systemRegistry, TransactionProxy txnProxy)
Creates an instance of this class configured with the specified properties and access coordinator.

Method Summary

protected void	abortInternal(Transaction txn) Performs the actual operation for abort.
protected void	commitInternal(Transaction txn) Performs the actual operation for commit.
protected long	createObjectInternal(Transaction txn) Performs the actual operation for createObject.
protected BindingValue	getBindingInternal(Transaction txn, String name) Performs the actual operation for getBinding.
protected int	getClassIdInternal(Transaction txn, byte[] classInfo) Performs the actual operation for getClassId.
protected byte[]	getClassInfoInternal(Transaction txn, int classId) Performs the actual operation for getClassInfo.
protected long	getLocalNodeIdInternal() Performs the actual operation for getLocalNodeId.
protected byte[]	getObjectInternal(Transaction txn, long oid, boolean forUpdate) Performs the actual operation for getObject.
protected RuntimeException	handleException(Transaction txn, Level level, RuntimeException e, String operation) Performs any operations needed when an exception is going to be thrown, as well as allowing the implementation to replace the exception with a different one.
protected void	markForUpdateInternal(Transaction txn, long oid) Performs the actual operation for markForUpdate.
protected String	nextBoundNameInternal(Transaction txn, String name) Performs the actual operation for nextBoundName.
protected long	nextObjectIdInternal(Transaction txn, long oid) Performs the actual operation for nextObjectId.
protected void	prepareAndCommitInternal(Transaction txn) Performs the actual operation for prepareAndCommit.
protected boolean	prepareInternal(Transaction txn) Performs the actual operation for prepare.
protected BindingValue	removeBindingInternal(Transaction txn, String name) Performs the actual operation for removeBinding.
protected void	removeObjectInternal(Transaction txn, long oid) Performs the actual operation for removeObject.
protected BindingValue	setBindingInternal(Transaction txn, String name, long oid) Performs the actual operation for setBinding.
protected void	setObjectInternal(Transaction txn, long oid, byte[] data) Performs the actual operation for setObject.
protected void	setObjectsInternal(Transaction txn, long[] oids, byte[][] dataArray) Performs the actual operation for setObjects.
protected void	shutdownInternal() Performs the actual operation for shutdown.
String	toString() Returns a string representation of this object.

Methods inherited from class com.sun.sgs.impl.service.data.store.AbstractDataStore

abort, checkOid, commit, createObject, getBinding, getClassId, getClassInfo, getLocalNodeId, getNameForAccess, getObject, getTypeName, markForUpdate, nextBoundName, nextObjectId, prepare, prepareAndCommit, ready, removeBinding, removeObject, reportNameAccess, reportObjectAccess, setBinding, setBindingDescription, setObject, setObjectDescription, setObjects, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataStoreClient

public DataStoreClient(Properties properties,
                       ComponentRegistry systemRegistry,
                       TransactionProxy txnProxy)
                throws IOException,
                       NotBoundException

Creates an instance of this class configured with the specified properties and access coordinator. See the class documentation for a list of supported properties.

Parameters:

properties - the properties for configuring this instance

systemRegistry - the registry of available system components

txnProxy - the transaction proxy

Throws:

IllegalArgumentException - if the com.sun.sgs.impl.service.data.store.net.server.host property is not set, or if the value of the com.sun.sgs.impl.service.data.store.net.server.port property is not a valid integer not less than 0 and not greater than 65535

IOException - if a network problem occurs

NotBoundException - if the server is not found in the Java RMI registry

Method Detail

getLocalNodeIdInternal

protected long getLocalNodeIdInternal()

Performs the actual operation for getLocalNodeId.

Specified by:

getLocalNodeIdInternal in class AbstractDataStore

Returns:

the local node ID

createObjectInternal

protected long createObjectInternal(Transaction txn)

Performs the actual operation for createObject.

Specified by:

createObjectInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

Returns:

the new object ID

markForUpdateInternal

protected void markForUpdateInternal(Transaction txn,
                                     long oid)

Performs the actual operation for markForUpdate.

Specified by:

markForUpdateInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

oid - the object ID

getObjectInternal

protected byte[] getObjectInternal(Transaction txn,
                                   long oid,
                                   boolean forUpdate)

Performs the actual operation for getObject.

Specified by:

getObjectInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

oid - the object ID

forUpdate - whether the caller intends to modify the object

Returns:

the data associated with the object ID

setObjectInternal

protected void setObjectInternal(Transaction txn,
                                 long oid,
                                 byte[] data)

Performs the actual operation for setObject.

Specified by:

setObjectInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

oid - the object ID

data - the data

setObjectsInternal

protected void setObjectsInternal(Transaction txn,
                                  long[] oids,
                                  byte[][] dataArray)

Performs the actual operation for setObjects.

Specified by:

setObjectsInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

oids - the object IDs

dataArray - the associated data values

removeObjectInternal

protected void removeObjectInternal(Transaction txn,
                                    long oid)

Performs the actual operation for removeObject.

Specified by:

removeObjectInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

oid - the object ID

getBindingInternal

protected BindingValue getBindingInternal(Transaction txn,
                                          String name)

Performs the actual operation for getBinding. If the name is bound, the return value contains the object ID that the name is bound to and a next name of null. If the name is not bound, the return value contains an object ID of -1 and the next name found, which may be null.

Specified by:

getBindingInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

name - the name

Returns:

information about the object ID and the next name

setBindingInternal

protected BindingValue setBindingInternal(Transaction txn,
                                          String name,
                                          long oid)

Performs the actual operation for setBinding. If the name is bound, the return value contains an arbitrary non-negative object ID and a next name of null. If the name is not bound, the return value contains an object ID of -1 and the next name found, which may be null.

Specified by:

setBindingInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

name - the name

oid - the object ID

Returns:

information about the old object ID and the next name

removeBindingInternal

protected BindingValue removeBindingInternal(Transaction txn,
                                             String name)

Performs the actual operation for removeBinding. If the name is bound, the return value contains an arbitrary non-negative object ID, otherwise it contains -1. In all cases, the return value contains the next name found, which may be null.

Specified by:

removeBindingInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

name - the name

Returns:

information about the object ID and the next name

nextBoundNameInternal

protected String nextBoundNameInternal(Transaction txn,
                                       String name)

Performs the actual operation for nextBoundName.

Specified by:

nextBoundNameInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

name - the name to search after, or null to start at the beginning

Returns:

the next name with a binding following name, or null if there are no more bound names

shutdownInternal

protected void shutdownInternal()

Performs the actual operation for shutdown.

Specified by:

shutdownInternal in class AbstractDataStore

getClassIdInternal

protected int getClassIdInternal(Transaction txn,
                                 byte[] classInfo)

Performs the actual operation for getClassId.

Specified by:

getClassIdInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

classInfo - the class information

Returns:

the associated class ID

getClassInfoInternal

protected byte[] getClassInfoInternal(Transaction txn,
                                      int classId)
                               throws ClassInfoNotFoundException

Performs the actual operation for getClassInfo.

Specified by:

getClassInfoInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

classId - the class ID

Returns:

the associated class information

Throws:

ClassInfoNotFoundException - if the ID is not found

nextObjectIdInternal

protected long nextObjectIdInternal(Transaction txn,
                                    long oid)

Performs the actual operation for nextObjectId.

Specified by:

nextObjectIdInternal in class AbstractDataStore

Parameters:

txn - the transaction under which the operation should take place

oid - the identifier of the object to search after, or -1 to request the first object

Returns:

the identifier of the next object following the object with identifier oid, or -1 if there are no more objects

prepareInternal

protected boolean prepareInternal(Transaction txn)

Performs the actual operation for prepare.

Specified by:

prepareInternal in class AbstractDataStore

Parameters:

txn - the transaction

Returns:

true if this participant is read-only, otherwise false

commitInternal

protected void commitInternal(Transaction txn)

Performs the actual operation for commit.

Specified by:

commitInternal in class AbstractDataStore

Parameters:

txn - the transaction

prepareAndCommitInternal

protected void prepareAndCommitInternal(Transaction txn)

Performs the actual operation for prepareAndCommit.

Specified by:

prepareAndCommitInternal in class AbstractDataStore

Parameters:

txn - the transaction

abortInternal

protected void abortInternal(Transaction txn)

Performs the actual operation for abort.

Specified by:

abortInternal in class AbstractDataStore

Parameters:

txn - the transaction

handleException

protected RuntimeException handleException(Transaction txn,
                                           Level level,
                                           RuntimeException e,
                                           String operation)

Performs any operations needed when an exception is going to be thrown, as well as allowing the implementation to replace the exception with a different one.

This implementation does logging, and aborts the transaction if it is not null and the exception is a TransactionAbortedException.

In addition to the operations performed by the superclass, this implementation includes the operation in the exception message for NetworkExceptions, converts TransactionNotActiveException to TransactionTimeoutException if the transaction timeout has passed, and notes in the information for the transaction if the transaction has been aborted on the server side.

Overrides:

handleException in class AbstractDataStore

Parameters:

txn - the transaction or null

level - the logging level

e - the exception

operation - a description of the operation being performed

Returns:

the exception to throw

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

Returns:

a string representation of this object