Package com.gigaspaces.internal.client.spaceproxy

Interface ISpaceProxy

All Superinterfaces:

ActionMaker, IDotnetProxyAssociated, IJSpace, IPojoSpace, JavaSpace, SecuredService

All Known Subinterfaces:

IDirectSpaceProxy

All Known Implementing Classes:

AbstractDirectSpaceProxy, AbstractSpaceCacheContainer, AbstractSpaceProxy, LocalCacheContainer, LocalViewContainer, SpaceProxyImpl

public interface ISpaceProxy
extends IJSpace, ActionMaker, SecuredService, IDotnetProxyAssociated, JavaSpace

A space proxy that extends the IJSpace interface. Operations that need to be provided by a space proxy but are not exposed as an API through the IJSpace interface should go here.

Author:

GigaSpaces

Field Summary

Fields inherited from interface com.j_spaces.core.IJSpace

NO_WAIT

Fields inherited from interface net.jini.space.JavaSpace

NO_WAIT

Method Summary

Modifier and Type	Method	Description
AggregationResult	aggregate(Object template, AggregationSet aggregationSet, Transaction txn, int readModifiers)
void	applyNotifyInfoDefaults(NotifyInfo notifyInfo)
AsyncFuture<AddTypeIndexesResult>	asyncAddIndexes(String typeName, SpaceIndex[] indexes, AsyncFutureListener<AddTypeIndexesResult> listener)
<T> Future<ChangeResult<T>>	asyncChange(Object template, ChangeSet changeSet, Transaction txn, long timeout, ChangeModifiers modifiers, AsyncFutureListener<ChangeResult<T>> listener)
AsyncFuture	asyncRead(Object template, Transaction transaction, long timeout, int modifiers, AsyncFutureListener listener)	Internal methods only.
AsyncFuture	asyncTake(Object template, Transaction transaction, long timeout, int modifiers, AsyncFutureListener listener)	Internal methods only.
<T> ChangeResult<T>	change(Object template, ChangeSet changeSet, Transaction txn, long timeout, ChangeModifiers modifiers)	Change entry in space
boolean	checkIfConnected()
void	close()	Close the proxy and execute necessary cleanup logic.
OperationID	createNewOperationID()	Generate a unique operation ID
AsyncFuture	execute(SpaceTask task, Object routing, Transaction tx, AsyncFutureListener listener)	Executes a task on a single space.
AsyncFuture	execute(SpaceTask task, Object routing, Transaction tx, AsyncFutureListener listener, Map<String,byte[]> classes)	Executes a task on a single space.
Transaction.Created	getContextTransaction()	Returns the transaction associated with the current context, if any.
IDirectSpaceProxy	getNotificationsDirectProxy()	returns itself in case of a direct proxy or the real proxy in case of a local cache or a view.
Object	getPrivilegedAdmin()	Deprecated. since 7.0.1.
SpaceHealthStatus	getSpaceHealthStatus()	Gets an object representing the space health status
ITypeDesc	getTypeDescriptor(String typeName)
int	initWriteModifiers(int modifiers)
boolean	isClustered()	returns true if the proxy is Clustered
Class<?>	loadRemoteClass(String className)	Loads a remote class from the space, the class will be loaded locally into a corresponding LRMIClassLoader
Object	read(Object template, Transaction txn, long timeout, int modifiers, boolean ifExists)
Object	readById(ReadTakeProxyActionInfo actionInfo)
Object	readById(String className, Object id, Object routing, Transaction txn, long timeout, int modifiers, boolean ifExists, QueryResultTypeInternal resultType, String[] projections)
Object[]	readByIds(ReadTakeByIdsProxyActionInfo actionInfo, boolean returnPackets)
Object[]	readByIds(String className, Object[] ids, Object[] routings, Transaction txn, int modifiers, QueryResultTypeInternal resultType, boolean returnPackets, String[] projections)
Object[]	readByIds(String className, Object[] ids, Object routing, Transaction txn, int modifiers, QueryResultTypeInternal resultType, boolean returnPackets, String[] projections)
Object	readByUid(String uid, Transaction txn, int modifiers, QueryResultTypeInternal resultType, boolean returnPacket)
ReadTakeEntriesUidsResult	readEntriesUids(ITemplatePacket template, Transaction transaction, int entriesLimit, int modifiers)	Read entries UIDs from space.
Object[]	readMultiple(Object template, Transaction transaction, int limit, int modifiers, boolean returnOnlyUids)
Object[]	readMultiple(Object template, Transaction transaction, long timeout, int limit, int minEntriesToWaitFor, int modifiers, boolean returnOnlyUids, boolean ifExist)
void	registerTypeDescriptor(ITypeDesc typeDesc)
ITypeDesc	registerTypeDescriptor(Class<?> type)
Transaction.Created	replaceContextTransaction(Transaction.Created transaction)
Transaction.Created	replaceContextTransaction(Transaction.Created transaction, ActionListener actionListener, boolean delegatedXa)
Object	take(Object template, Transaction txn, long timeout, int modifiers, boolean ifExists)
Object	takeById(ReadTakeProxyActionInfo actionInfo)
Object	takeById(String className, Object id, Object routing, int version, Transaction txn, long timeout, int modifiers, boolean ifExists, QueryResultTypeInternal resultType, String[] projections)
Object[]	takeByIds(ReadTakeByIdsProxyActionInfo actionInfo, boolean returnPackets)
Object[]	takeByIds(String className, Object[] ids, Object[] routings, Transaction txn, int modifiers, QueryResultTypeInternal resultType, boolean returnPackets, String[] projections)
Object[]	takeByIds(String className, Object[] ids, Object routing, Transaction txn, int modifiers, QueryResultTypeInternal resultType, boolean returnPackets, String[] projections)
Object	takeByUid(String uid, Transaction txn, int modifiers, QueryResultTypeInternal resultType, boolean returnPacket)
Object[]	takeMultiple(Object template, Transaction transaction, int limit, int modifiers, boolean returnOnlyUids)
Object[]	takeMultiple(Object template, Transaction transaction, long timeout, int limit, int minEntriesToWaitFor, int modifiers, boolean returnOnlyUids, boolean ifExist)
void	unregisterTypeDescriptor(String typeName)
LeaseContext[]	writeMultiple(Object[] objects, Transaction txn, long lease, long[] leases, long timeout, int modifiers)

Methods inherited from interface com.j_spaces.core.client.ActionMaker

setActionListener

Methods inherited from interface com.gigaspaces.serialization.pbs.IDotnetProxyAssociated

getAppDomainId, getDotnetProxyHandleId, hasAssociatedAppDomain, isTargetOfADotnetProxy, setAppDomainId, setDotnetProxyHandleId

Methods inherited from interface com.j_spaces.core.IJSpace

dropClass, getAdmin, getCacheTypeName, getContainerName, getDirectProxy, getFinderURL, getName, getReadModifiers, getReferentUuid, getUpdateModifiers, getURL, isEmbedded, isFifo, isOptimisticLockingEnabled, isSecured, isStartedWithinGSC, ping, setFifo, setOptimisticLocking, setReadModifiers, setUpdateModifiers

Methods inherited from interface com.gigaspaces.client.IPojoSpace

clear, clear, count, count, read, read, readIfExists, readIfExists, readMultiple, readMultiple, snapshot, take, take, takeIfExists, takeMultiple, takeMultiple, update, update, updateMultiple, updateMultiple, write, write, writeMultiple, writeMultiple, writeMultiple

Methods inherited from interface net.jini.space.JavaSpace

notify, read, readIfExists, snapshot, take, takeIfExists, write

Methods inherited from interface com.gigaspaces.security.service.SecuredService

isServiceSecured, login

Method Details

getContextTransaction

Transaction.Created getContextTransaction()

Returns the transaction associated with the current context, if any.

replaceContextTransaction

Transaction.Created replaceContextTransaction(Transaction.Created transaction)

replaceContextTransaction

Transaction.Created replaceContextTransaction(Transaction.Created transaction,
 ActionListener actionListener,
 boolean delegatedXa)

isClustered

boolean isClustered()

returns true if the proxy is Clustered

Returns:

true when the proxy is Clustered

getNotificationsDirectProxy

IDirectSpaceProxy getNotificationsDirectProxy()

returns itself in case of a direct proxy or the real proxy in case of a local cache or a view.

getPrivilegedAdmin

@Deprecated
Object getPrivilegedAdmin()
                   throws RemoteException

Deprecated.

since 7.0.1. Is not part of current security model.

Throws:

RemoteException

See Also:

• IJSpace.getAdmin()

execute

AsyncFuture execute(SpaceTask task,
 Object routing,
 Transaction tx,
 AsyncFutureListener listener)
             throws TransactionException,
RemoteException

Executes a task on a single space.

Parameters:

task - task (non-null) to execute on single space, according to the routing field.

tx - transaction (if any) under which to work.

listener - event listener to execute result.

Returns:

future to retrieve the result in an asynchronous way

Throws:

TransactionException - if a transaction error occurs

RemoteException - if a communication error occurs

execute

AsyncFuture execute(SpaceTask task,
 Object routing,
 Transaction tx,
 AsyncFutureListener listener,
 Map<String,byte[]> classes)
             throws TransactionException,
RemoteException

Executes a task on a single space.

Parameters:

task - task (non-null) to execute on single space, according to the routing field.

tx - transaction (if any) under which to work.

listener - event listener to execute result.

Returns:

future to retrieve the result in an asynchronous way

Throws:

TransactionException - if a transaction error occurs

RemoteException - if a communication error occurs

close

void close()

Close the proxy and execute necessary cleanup logic.

asyncTake

AsyncFuture asyncTake(Object template,
 Transaction transaction,
 long timeout,
 int modifiers,
 AsyncFutureListener listener)
               throws RemoteException

Internal methods only. Take any matching entry from the space, unblocking. Returns an AsyncFuture which returns null if the timeout expires.

Parameters:

template - The template used for matching. Matching is done against template with null fields being wildcards ("match anything") other fields being values ("match exactly on the serialized form").

transaction - The template used for matching. Matching is done against template with null fields being wildcards ("match anything") other fields being values ("match exactly on the serialized form").

timeout - How long the client is willing to wait for a transactionally proper matching entry. A timeout of NO_WAIT means to wait no time at all; this is equivalent to a wait of zero.

modifiers - one or a union of ReadModifiers.

listener - event listener to execute result.

Returns:

object from the space

Throws:

UnusableEntryException - - if any serialized field of the entry being read cannot be deserialized for any reason TransactionException - if a transaction error occurs InterruptedException - if the thread in which the read occurs is interrupted RemoteException - if a communication error occurs IllegalArgumentException - if a negative timeout value is used

RemoteException

Since:

6.6

asyncRead

AsyncFuture asyncRead(Object template,
 Transaction transaction,
 long timeout,
 int modifiers,
 AsyncFutureListener listener)
               throws RemoteException

Internal methods only. Read any matching entry from the space, unblocking. Returns an AsyncFuture which returns null if the timeout expires.

Parameters:

template - The template used for matching. Matching is done against template with null fields being wildcards ("match anything") other fields being values ("match exactly on the serialized form").

transaction - The template used for matching. Matching is done against template with null fields being wildcards ("match anything") other fields being values ("match exactly on the serialized form").

timeout - How long the client is willing to wait for a transactionally proper matching entry. A timeout of NO_WAIT means to wait no time at all; this is equivalent to a wait of zero.

modifiers - one or a union of ReadModifiers.

listener - event listener to execute result.

Returns:

object from the space

Throws:

UnusableEntryException - - if any serialized field of the entry being read cannot be deserialized for any reason TransactionException - if a transaction error occurs InterruptedException - if the thread in which the read occurs is interrupted RemoteException - if a communication error occurs IllegalArgumentException - if a negative timeout value is used

RemoteException

Since:

6.6

read

Object read(Object template,
 Transaction txn,
 long timeout,
 int modifiers,
 boolean ifExists)
     throws UnusableEntryException,
TransactionException,
InterruptedException,
RemoteException

Throws:

UnusableEntryException

TransactionException

InterruptedException

RemoteException

take

Object take(Object template,
 Transaction txn,
 long timeout,
 int modifiers,
 boolean ifExists)
     throws UnusableEntryException,
TransactionException,
InterruptedException,
RemoteException

Throws:

UnusableEntryException

TransactionException

InterruptedException

RemoteException

readMultiple

Object[] readMultiple(Object template,
 Transaction transaction,
 int limit,
 int modifiers,
 boolean returnOnlyUids)
               throws TransactionException,
UnusableEntryException,
RemoteException

Throws:

TransactionException

UnusableEntryException

RemoteException

readMultiple

Object[] readMultiple(Object template,
 Transaction transaction,
 long timeout,
 int limit,
 int minEntriesToWaitFor,
 int modifiers,
 boolean returnOnlyUids,
 boolean ifExist)
               throws TransactionException,
UnusableEntryException,
RemoteException

Throws:

TransactionException

UnusableEntryException

RemoteException

takeMultiple

Object[] takeMultiple(Object template,
 Transaction transaction,
 int limit,
 int modifiers,
 boolean returnOnlyUids)
               throws TransactionException,
UnusableEntryException,
RemoteException

Throws:

TransactionException

UnusableEntryException

RemoteException

takeMultiple

Object[] takeMultiple(Object template,
 Transaction transaction,
 long timeout,
 int limit,
 int minEntriesToWaitFor,
 int modifiers,
 boolean returnOnlyUids,
 boolean ifExist)
               throws TransactionException,
UnusableEntryException,
RemoteException

Throws:

TransactionException

UnusableEntryException

RemoteException

readById

Object readById(ReadTakeProxyActionInfo actionInfo)
         throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

takeById

Object takeById(ReadTakeProxyActionInfo actionInfo)
         throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

readById

Object readById(String className,
 Object id,
 Object routing,
 Transaction txn,
 long timeout,
 int modifiers,
 boolean ifExists,
 QueryResultTypeInternal resultType,
 String[] projections)
         throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

takeById

Object takeById(String className,
 Object id,
 Object routing,
 int version,
 Transaction txn,
 long timeout,
 int modifiers,
 boolean ifExists,
 QueryResultTypeInternal resultType,
 String[] projections)
         throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

readByUid

Object readByUid(String uid,
 Transaction txn,
 int modifiers,
 QueryResultTypeInternal resultType,
 boolean returnPacket)
          throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

takeByUid

Object takeByUid(String uid,
 Transaction txn,
 int modifiers,
 QueryResultTypeInternal resultType,
 boolean returnPacket)
          throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

readByIds

Object[] readByIds(String className,
 Object[] ids,
 Object routing,
 Transaction txn,
 int modifiers,
 QueryResultTypeInternal resultType,
 boolean returnPackets,
 String[] projections)
            throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

readByIds

Object[] readByIds(String className,
 Object[] ids,
 Object[] routings,
 Transaction txn,
 int modifiers,
 QueryResultTypeInternal resultType,
 boolean returnPackets,
 String[] projections)
            throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

readByIds

Object[] readByIds(ReadTakeByIdsProxyActionInfo actionInfo,
 boolean returnPackets)
            throws RemoteException,
TransactionException,
InterruptedException,
UnusableEntryException

Throws:

RemoteException

TransactionException

InterruptedException

UnusableEntryException

takeByIds

Object[] takeByIds(String className,
 Object[] ids,
 Object routing,
 Transaction txn,
 int modifiers,
 QueryResultTypeInternal resultType,
 boolean returnPackets,
 String[] projections)
            throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

takeByIds

Object[] takeByIds(String className,
 Object[] ids,
 Object[] routings,
 Transaction txn,
 int modifiers,
 QueryResultTypeInternal resultType,
 boolean returnPackets,
 String[] projections)
            throws RemoteException,
UnusableEntryException,
TransactionException,
InterruptedException

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

takeByIds

Object[] takeByIds(ReadTakeByIdsProxyActionInfo actionInfo,
 boolean returnPackets)
            throws RemoteException,
TransactionException,
InterruptedException,
UnusableEntryException

Throws:

RemoteException

TransactionException

InterruptedException

UnusableEntryException

writeMultiple

LeaseContext[] writeMultiple(Object[] objects,
 Transaction txn,
 long lease,
 long[] leases,
 long timeout,
 int modifiers)
                      throws TransactionException,
RemoteException

Throws:

TransactionException

RemoteException

getSpaceHealthStatus

SpaceHealthStatus getSpaceHealthStatus()
                                throws RemoteException

Gets an object representing the space health status

Returns:

object representing the space health status

Throws:

RemoteException

getTypeDescriptor

ITypeDesc getTypeDescriptor(String typeName)
                     throws RemoteException

Throws:

RemoteException

registerTypeDescriptor

void registerTypeDescriptor(ITypeDesc typeDesc)
                     throws RemoteException

Throws:

RemoteException

registerTypeDescriptor

ITypeDesc registerTypeDescriptor(Class<?> type)
                          throws RemoteException

Throws:

RemoteException

unregisterTypeDescriptor

void unregisterTypeDescriptor(String typeName)
                       throws RemoteException

Throws:

RemoteException

asyncAddIndexes

AsyncFuture<AddTypeIndexesResult> asyncAddIndexes(String typeName,
 SpaceIndex[] indexes,
 AsyncFutureListener<AddTypeIndexesResult> listener)
                                           throws RemoteException

Throws:

RemoteException

loadRemoteClass

Class<?> loadRemoteClass(String className)
                  throws ClassNotFoundException

Loads a remote class from the space, the class will be loaded locally into a corresponding LRMIClassLoader

Throws:

ClassNotFoundException

Since:

8.0.1

applyNotifyInfoDefaults

void applyNotifyInfoDefaults(NotifyInfo notifyInfo)

checkIfConnected

boolean checkIfConnected()

createNewOperationID

OperationID createNewOperationID()

Generate a unique operation ID

Returns:

Unique operation ID

initWriteModifiers

int initWriteModifiers(int modifiers)

readEntriesUids

ReadTakeEntriesUidsResult readEntriesUids(ITemplatePacket template,
 Transaction transaction,
 int entriesLimit,
 int modifiers)
                                   throws RemoteException,
TransactionException,
UnusableEntryException

Read entries UIDs from space.

Throws:

RemoteException

TransactionException

UnusableEntryException

Since:

9.0

change

<T> ChangeResult<T> change(Object template,
 ChangeSet changeSet,
 Transaction txn,
 long timeout,
 ChangeModifiers modifiers)
                    throws RemoteException,
TransactionException

Change entry in space

Throws:

RemoteException

TransactionException

Since:

9.1

asyncChange

<T> Future<ChangeResult<T>> asyncChange(Object template,
 ChangeSet changeSet,
 Transaction txn,
 long timeout,
 ChangeModifiers modifiers,
 AsyncFutureListener<ChangeResult<T>> listener)
                                 throws RemoteException

Throws:

RemoteException

aggregate

AggregationResult aggregate(Object template,
 AggregationSet aggregationSet,
 Transaction txn,
 int readModifiers)
                     throws RemoteException,
TransactionException,
InterruptedException

Throws:

RemoteException

TransactionException

InterruptedException