com.amazon.carbonado.repo.dirmi

Interface RemoteStorage

All Superinterfaces:

java.rmi.Remote

public interface RemoteStorage
extends java.rmi.Remote

Remote storage definition which does not actually extend the Storage interface. Client class is responsible for adapting Storage calls to RemoteStorage calls.

Note: All access to Storable and Query objects is inlined. There is no reason to make them remote objects as that would add unnecessary latency. Most operations on Storables and Queries can be performed locally.

Author:

Brian S O'Neill

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getPropertySupport(java.lang.String... propertyNames)
long	queryCount(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn) Counts storables for this storage.
long	queryCount(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn, com.amazon.carbonado.Query.Controller controller) Counts storables for this storage.
void	queryDeleteAll(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn) Deletes all matching storables.
void	queryDeleteAll(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn, com.amazon.carbonado.Query.Controller controller) Deletes all matching storables.
void	queryDeleteOne(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn) Deletes one storable.
void	queryDeleteOne(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn, com.amazon.carbonado.Query.Controller controller) Deletes one storable.
org.cojen.dirmi.Pipe	queryFetch(com.amazon.carbonado.filter.FilterValues fv, com.amazon.carbonado.qe.OrderingList orderBy, java.lang.Long from, java.lang.Long to, RemoteTransaction txn, org.cojen.dirmi.Pipe pipe) Fetches storables for this storage.
org.cojen.dirmi.Pipe	queryFetch(com.amazon.carbonado.filter.FilterValues fv, com.amazon.carbonado.qe.OrderingList orderBy, java.lang.Long from, java.lang.Long to, RemoteTransaction txn, org.cojen.dirmi.Pipe pipe, com.amazon.carbonado.Query.Controller controller) Fetches storables for this storage.
org.cojen.dirmi.Pipe	queryLoadOne(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn, org.cojen.dirmi.Pipe pipe) Fetches one storable.
org.cojen.dirmi.Pipe	queryLoadOne(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn, org.cojen.dirmi.Pipe pipe, com.amazon.carbonado.Query.Controller controller) Fetches one storable.
java.lang.String	queryPrintNative(com.amazon.carbonado.filter.FilterValues fv, com.amazon.carbonado.qe.OrderingList orderBy, int indentLevel) Prints the native query to a string, returning null if no native query.
java.lang.String	queryPrintPlan(com.amazon.carbonado.filter.FilterValues fv, com.amazon.carbonado.qe.OrderingList orderBy, int indentLevel) Prints the query plan to a string, returning null if plan not known.
boolean	queryTryDeleteOne(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn) Deletes one storable.
boolean	queryTryDeleteOne(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn, com.amazon.carbonado.Query.Controller controller) Deletes one storable.
org.cojen.dirmi.Pipe	queryTryLoadOne(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn, org.cojen.dirmi.Pipe pipe) Fetches one storable.
org.cojen.dirmi.Pipe	queryTryLoadOne(com.amazon.carbonado.filter.FilterValues fv, RemoteTransaction txn, org.cojen.dirmi.Pipe pipe, com.amazon.carbonado.Query.Controller controller) Fetches one storable.
void	truncate(RemoteTransaction txn)
org.cojen.dirmi.Pipe	tryDelete(RemoteTransaction txn, org.cojen.dirmi.Pipe pipe) Deletes the given storable, using the serialized key, returing true if deleted.
org.cojen.dirmi.Pipe	tryInsert(RemoteTransaction txn, org.cojen.dirmi.Pipe pipe) Inserts the given serialized storable, returing the deserialized properties.
org.cojen.dirmi.Pipe	tryLoad(RemoteTransaction txn, org.cojen.dirmi.Pipe pipe) Returns serialized storable properties, using the serialized key.
org.cojen.dirmi.Pipe	tryUpdate(RemoteTransaction txn, org.cojen.dirmi.Pipe pipe) Updates the given serialized storable, returing the deserialized properties.

Method Detail

tryLoad

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
org.cojen.dirmi.Pipe tryLoad(RemoteTransaction txn,
                                                                                               org.cojen.dirmi.Pipe pipe)
                             throws com.amazon.carbonado.FetchException

Returns serialized storable properties, using the serialized key. Returns null if not found.

Parameters:

txn - optional

pipe - send serialized key properties

Returns:

true if loaded

Throws:

com.amazon.carbonado.FetchException

tryInsert

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
org.cojen.dirmi.Pipe tryInsert(RemoteTransaction txn,
                                                                                                   org.cojen.dirmi.Pipe pipe)
                               throws com.amazon.carbonado.PersistException

Inserts the given serialized storable, returing the deserialized properties. Returns false if storable did not change after insert.

Parameters:

txn - optional

pipe - send fully serialized storable

Returns:

true if inserted

Throws:

com.amazon.carbonado.PersistException

tryUpdate

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
org.cojen.dirmi.Pipe tryUpdate(RemoteTransaction txn,
                                                                                                   org.cojen.dirmi.Pipe pipe)
                               throws com.amazon.carbonado.PersistException

Updates the given serialized storable, returing the deserialized properties.

Parameters:

txn - optional

pipe - send fully serialized storable

Returns:

true if updated

Throws:

com.amazon.carbonado.PersistException

tryDelete

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
org.cojen.dirmi.Pipe tryDelete(RemoteTransaction txn,
                                                                                                   org.cojen.dirmi.Pipe pipe)
                               throws com.amazon.carbonado.PersistException

Deletes the given storable, using the serialized key, returing true if deleted.

Parameters:

txn - optional

pipe - send serialized key properties

Returns:

true if deleted

Throws:

com.amazon.carbonado.PersistException

queryCount

@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
long queryCount(com.amazon.carbonado.filter.FilterValues fv,
                                                                     RemoteTransaction txn)
                throws com.amazon.carbonado.FetchException

Counts storables for this storage.

Parameters:

fv - optional

txn - optional

Throws:

com.amazon.carbonado.FetchException

queryCount

@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
long queryCount(com.amazon.carbonado.filter.FilterValues fv,
                                                                     RemoteTransaction txn,
                                                                     com.amazon.carbonado.Query.Controller controller)
                throws com.amazon.carbonado.FetchException

Counts storables for this storage.

Parameters:

fv - optional

txn - optional

controller - optional

Throws:

com.amazon.carbonado.FetchException

queryFetch

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
org.cojen.dirmi.Pipe queryFetch(com.amazon.carbonado.filter.FilterValues fv,
                                                                                                  com.amazon.carbonado.qe.OrderingList orderBy,
                                                                                                  java.lang.Long from,
                                                                                                  java.lang.Long to,
                                                                                                  RemoteTransaction txn,
                                                                                                  org.cojen.dirmi.Pipe pipe)
                                throws com.amazon.carbonado.FetchException

Fetches storables for this storage.

Parameters:

fv - optional

orderBy - optional

from - optional

to - optional

txn - optional

Throws:

com.amazon.carbonado.FetchException

queryFetch

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
org.cojen.dirmi.Pipe queryFetch(com.amazon.carbonado.filter.FilterValues fv,
                                                                                                  com.amazon.carbonado.qe.OrderingList orderBy,
                                                                                                  java.lang.Long from,
                                                                                                  java.lang.Long to,
                                                                                                  RemoteTransaction txn,
                                                                                                  org.cojen.dirmi.Pipe pipe,
                                                                                                  com.amazon.carbonado.Query.Controller controller)
                                throws com.amazon.carbonado.FetchException

Fetches storables for this storage.

Parameters:

fv - optional

orderBy - optional

from - optional

to - optional

txn - optional

controller - optional

Throws:

com.amazon.carbonado.FetchException

queryLoadOne

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
org.cojen.dirmi.Pipe queryLoadOne(com.amazon.carbonado.filter.FilterValues fv,
                                                                                                    RemoteTransaction txn,
                                                                                                    org.cojen.dirmi.Pipe pipe)
                                  throws com.amazon.carbonado.FetchException

Fetches one storable.

Parameters:

fv - optional

txn - optional

Throws:

com.amazon.carbonado.FetchException

queryLoadOne

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
org.cojen.dirmi.Pipe queryLoadOne(com.amazon.carbonado.filter.FilterValues fv,
                                                                                                    RemoteTransaction txn,
                                                                                                    org.cojen.dirmi.Pipe pipe,
                                                                                                    com.amazon.carbonado.Query.Controller controller)
                                  throws com.amazon.carbonado.FetchException

Fetches one storable.

Parameters:

fv - optional

txn - optional

controller - optional

Throws:

com.amazon.carbonado.FetchException

queryTryLoadOne

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
org.cojen.dirmi.Pipe queryTryLoadOne(com.amazon.carbonado.filter.FilterValues fv,
                                                                                                       RemoteTransaction txn,
                                                                                                       org.cojen.dirmi.Pipe pipe)
                                     throws com.amazon.carbonado.FetchException

Fetches one storable.

Parameters:

fv - optional

txn - optional

Throws:

com.amazon.carbonado.FetchException

queryTryLoadOne

@Asynchronous(value=REQUEST_REPLY)
@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
org.cojen.dirmi.Pipe queryTryLoadOne(com.amazon.carbonado.filter.FilterValues fv,
                                                                                                       RemoteTransaction txn,
                                                                                                       org.cojen.dirmi.Pipe pipe,
                                                                                                       com.amazon.carbonado.Query.Controller controller)
                                     throws com.amazon.carbonado.FetchException

Fetches one storable.

Parameters:

fv - optional

txn - optional

controller - optional

Throws:

com.amazon.carbonado.FetchException

queryDeleteOne

@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
void queryDeleteOne(com.amazon.carbonado.filter.FilterValues fv,
                                                                           RemoteTransaction txn)
                    throws com.amazon.carbonado.FetchException,
                           com.amazon.carbonado.PersistException

Deletes one storable.

Parameters:

fv - optional

txn - optional

Throws:

com.amazon.carbonado.FetchException

com.amazon.carbonado.PersistException

queryDeleteOne

@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
void queryDeleteOne(com.amazon.carbonado.filter.FilterValues fv,
                                                                           RemoteTransaction txn,
                                                                           com.amazon.carbonado.Query.Controller controller)
                    throws com.amazon.carbonado.FetchException,
                           com.amazon.carbonado.PersistException

Deletes one storable.

Parameters:

fv - optional

txn - optional

controller - optional

Throws:

com.amazon.carbonado.FetchException

com.amazon.carbonado.PersistException

queryTryDeleteOne

@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
boolean queryTryDeleteOne(com.amazon.carbonado.filter.FilterValues fv,
                                                                                 RemoteTransaction txn)
                          throws com.amazon.carbonado.FetchException,
                                 com.amazon.carbonado.PersistException

Deletes one storable.

Parameters:

fv - optional

txn - optional

Throws:

com.amazon.carbonado.FetchException

com.amazon.carbonado.PersistException

queryTryDeleteOne

@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
boolean queryTryDeleteOne(com.amazon.carbonado.filter.FilterValues fv,
                                                                                 RemoteTransaction txn,
                                                                                 com.amazon.carbonado.Query.Controller controller)
                          throws com.amazon.carbonado.FetchException,
                                 com.amazon.carbonado.PersistException

Deletes one storable.

Parameters:

fv - optional

txn - optional

controller - optional

Throws:

com.amazon.carbonado.FetchException

com.amazon.carbonado.PersistException

queryDeleteAll

@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
void queryDeleteAll(com.amazon.carbonado.filter.FilterValues fv,
                                                                           RemoteTransaction txn)
                    throws com.amazon.carbonado.FetchException,
                           com.amazon.carbonado.PersistException

Deletes all matching storables.

Parameters:

fv - optional

txn - optional

Throws:

com.amazon.carbonado.FetchException

com.amazon.carbonado.PersistException

queryDeleteAll

@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
void queryDeleteAll(com.amazon.carbonado.filter.FilterValues fv,
                                                                           RemoteTransaction txn,
                                                                           com.amazon.carbonado.Query.Controller controller)
                    throws com.amazon.carbonado.FetchException,
                           com.amazon.carbonado.PersistException

Deletes all matching storables.

Parameters:

fv - optional

txn - optional

controller - optional

Throws:

com.amazon.carbonado.FetchException

com.amazon.carbonado.PersistException

queryPrintNative

@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
java.lang.String queryPrintNative(com.amazon.carbonado.filter.FilterValues fv,
                                                                                       com.amazon.carbonado.qe.OrderingList orderBy,
                                                                                       int indentLevel)
                                  throws com.amazon.carbonado.FetchException

Prints the native query to a string, returning null if no native query.

Parameters:

fv - optional

orderBy - optional

indentLevel - amount to indent text, zero for none

Throws:

com.amazon.carbonado.FetchException

queryPrintPlan

@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
java.lang.String queryPrintPlan(com.amazon.carbonado.filter.FilterValues fv,
                                                                                     com.amazon.carbonado.qe.OrderingList orderBy,
                                                                                     int indentLevel)
                                throws com.amazon.carbonado.FetchException

Prints the query plan to a string, returning null if plan not known.

Parameters:

fv - optional

orderBy - optional

indentLevel - amount to indent text, zero for none

Throws:

com.amazon.carbonado.FetchException

truncate

@RemoteFailure(exception=com.amazon.carbonado.PersistException.class)
void truncate(RemoteTransaction txn)
              throws com.amazon.carbonado.PersistException

Throws:

com.amazon.carbonado.PersistException

getPropertySupport

@RemoteFailure(exception=com.amazon.carbonado.FetchException.class)
java.util.Set<java.lang.String> getPropertySupport(java.lang.String... propertyNames)
                                                   throws com.amazon.carbonado.FetchException

Throws:

com.amazon.carbonado.FetchException