public interface GigaSpace
IJSpace
extension utilizing GigaSpaces extended and
simplified programming model. Most operations revolve around the use of Objects allowing to use
GigaSpaces support for POJOs. Though this interface has a single implementation it is still important to work against the interface as it allows for simpler testing and mocking.
Transaction management is implicit and works in a declarative manner. Operations do not accept
a transaction object, and will automatically use the TransactionProvider
in order to
acquire the current running transaction. If there is no current running transaction the operation
will be executed without a transaction.
Operations throw a DataAccessException
allowing for simplified development model as it is a
runtime exception. The cause of the exception can be acquired from the GigaSpace exception.
ISpaceQuery
,
SQLQuery
,
TransactionProvider
,
DefaultGigaSpace
,
DataAccessException
Modifier and Type | Method and Description |
---|---|
<T> AggregationResult |
aggregate(ISpaceQuery<T> query,
AggregationSet aggregationSet)
Executes the specified query along with the specified aggregations collocated at the space.
|
<T> Future<ChangeResult<T>> |
asyncChange(ISpaceQuery<T> query,
ChangeSet changeSet)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(ISpaceQuery<T> query,
ChangeSet changeSet,
AsyncFutureListener<ChangeResult<T>> listener)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(ISpaceQuery<T> query,
ChangeSet changeSet,
ChangeModifiers modifiers)
Changes an existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(ISpaceQuery<T> query,
ChangeSet changeSet,
ChangeModifiers modifiers,
AsyncFutureListener<ChangeResult<T>> listener)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(ISpaceQuery<T> query,
ChangeSet changeSet,
ChangeModifiers modifiers,
long timeout)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(ISpaceQuery<T> query,
ChangeSet changeSet,
ChangeModifiers modifiers,
long timeout,
AsyncFutureListener<ChangeResult<T>> listener)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(ISpaceQuery<T> query,
ChangeSet changeSet,
long timeout)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(ISpaceQuery<T> query,
ChangeSet changeSet,
long timeout,
AsyncFutureListener<ChangeResult<T>> listener)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(T template,
ChangeSet changeSet)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(T template,
ChangeSet changeSet,
AsyncFutureListener<ChangeResult<T>> listener)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(T template,
ChangeSet changeSet,
ChangeModifiers modifiers)
Changes an existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(T template,
ChangeSet changeSet,
ChangeModifiers modifiers,
AsyncFutureListener<ChangeResult<T>> listener)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(T template,
ChangeSet changeSet,
ChangeModifiers modifiers,
long timeout)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(T template,
ChangeSet changeSet,
ChangeModifiers modifiers,
long timeout,
AsyncFutureListener<ChangeResult<T>> listener)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(T template,
ChangeSet changeSet,
long timeout)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
<T> Future<ChangeResult<T>> |
asyncChange(T template,
ChangeSet changeSet,
long timeout,
AsyncFutureListener<ChangeResult<T>> listener)
Changes existing objects in space in an asynchronous manner, returning immidiately with a
future.
|
AsyncFuture<SpaceDataSourceLoadResult> |
asyncLoad(SpaceDataSourceLoadRequest spaceDataSourceLoadRequest)
Loads data from a
SpaceDataSource on demand
The Space data source is created with SpaceDataSourceFactory
Loaded data can be adapted using the SpaceTypeSchemaAdapter |
<T> AsyncFuture<T> |
asyncRead(ISpaceQuery<T> template)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(ISpaceQuery<T> template,
AsyncFutureListener<T> listener)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(ISpaceQuery<T> template,
long timeout)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(ISpaceQuery<T> template,
long timeout,
AsyncFutureListener<T> listener)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(ISpaceQuery<T> template,
long timeout,
ReadModifiers modifiers)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(ISpaceQuery<T> template,
long timeout,
ReadModifiers modifiers,
AsyncFutureListener<T> listener)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(T template)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(T template,
AsyncFutureListener<T> listener)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(T template,
long timeout)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(T template,
long timeout,
AsyncFutureListener<T> listener)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(T template,
long timeout,
ReadModifiers modifiers)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncRead(T template,
long timeout,
ReadModifiers modifiers,
AsyncFutureListener<T> listener)
Reads any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(ISpaceQuery<T> template)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(ISpaceQuery<T> template,
AsyncFutureListener<T> listener)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(ISpaceQuery<T> template,
long timeout)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(ISpaceQuery<T> template,
long timeout,
AsyncFutureListener<T> listener)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(ISpaceQuery<T> template,
long timeout,
TakeModifiers modifiers)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(ISpaceQuery<T> template,
long timeout,
TakeModifiers modifiers,
AsyncFutureListener<T> listener)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(T template)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(T template,
AsyncFutureListener<T> listener)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(T template,
long timeout)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(T template,
long timeout,
AsyncFutureListener<T> listener)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(T template,
long timeout,
TakeModifiers modifiers)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> AsyncFuture<T> |
asyncTake(T template,
long timeout,
TakeModifiers modifiers,
AsyncFutureListener<T> listener)
Take (remove) any matching entry from the space in an asynchronous manner.
|
<T> ChangeResult<T> |
change(ISpaceQuery<T> query,
ChangeSet changeSet)
Changes existing objects in space, returning a change result which provides details of the
operation affect.
|
<T> ChangeResult<T> |
change(ISpaceQuery<T> query,
ChangeSet changeSet,
ChangeModifiers modifiers)
Changes existing objects in space, returning a change result which provides details of the
operation affect.
|
<T> ChangeResult<T> |
change(ISpaceQuery<T> query,
ChangeSet changeSet,
ChangeModifiers modifiers,
long timeout)
Changes existing objects in space, returning a change result which provides details of the
operation affect.
|
<T> ChangeResult<T> |
change(ISpaceQuery<T> query,
ChangeSet changeSet,
long timeout)
Changes existing objects in space, returning a change result which provides details of the
operation affect.
|
<T> ChangeResult<T> |
change(T template,
ChangeSet changeSet)
Changes existing objects in space, returning a change result which provides details of the
operation affect.
|
<T> ChangeResult<T> |
change(T template,
ChangeSet changeSet,
ChangeModifiers modifiers)
Changes existing objects in space, returning a change result which provides details of the
operation affect.
|
<T> ChangeResult<T> |
change(T template,
ChangeSet changeSet,
ChangeModifiers modifiers,
long timeout)
Changes existing objects in space, returning a change result which provides details of the
operation affect.
|
<T> ChangeResult<T> |
change(T template,
ChangeSet changeSet,
long timeout)
Changes existing objects in space, returning a change result which provides details of the
operation affect.
|
void |
clear(Object template)
Removes the entries that match the specified template and the specified transaction from this
space.
|
int |
clear(Object template,
ClearModifiers modifiers)
Removes the entries that match the specified template and the specified transaction from this
space.
|
int |
count(Object template)
Count any matching entry from the space.
|
int |
count(Object template,
CountModifiers modifiers)
Count any matching entries from the space.
|
<T extends Serializable,R> |
execute(DistributedTask<T,R> task)
Executes the task on all the primary space nodes within the cluster (broadcast).
|
<T extends Serializable,R> |
execute(DistributedTask<T,R> task,
Object... routing)
Executes a task on all the nodes that correspond to the list of routing values.
|
<T extends Serializable> |
execute(Task<T> task)
Executes a task on a specific space node.
|
<T extends Serializable> |
execute(Task<T> task,
AsyncFutureListener<T> listener)
Executes a task on a specific space node.
|
<T extends Serializable> |
execute(Task<T> task,
Object routing)
Executes a task on a specific space node.
|
<T extends Serializable> |
execute(Task<T> task,
Object routing,
AsyncFutureListener<T> listener)
Executes a task on a specific space node.
|
<T extends Serializable,R> |
executorBuilder(AsyncResultsReducer<T,R> reducer)
Constructs an executor builder allowing to accumulate different tasks required to be executed
into a single execute mechanism with all the results reduced by the reducer provided.
|
GigaSpace |
getClustered()
Returns a clustered view of this
GigaSpace instance. |
Transaction |
getCurrentTransaction()
Returns the current running transaction.
|
ChangeModifiers |
getDefaultChangeModifiers()
Gets the default
ChangeModifiers set during this GigaSpace configuration. |
ClearModifiers |
getDefaultClearModifiers()
Gets the default
ClearModifiers set during this GigaSpace configuration. |
CountModifiers |
getDefaultCountModifiers()
Gets the default
CountModifiers set during this GigaSpace configuration. |
ReadModifiers |
getDefaultReadModifiers()
Gets the default
ReadModifiers set during this GigaSpace configuration. |
TakeModifiers |
getDefaultTakeModifiers()
Gets the default
TakeModifiers set during this GigaSpace configuration. |
WriteModifiers |
getDefaultWriteModifiers()
Gets the default
WriteModifiers set during this GigaSpace configuration. |
ExceptionTranslator |
getExceptionTranslator()
Returns the exception translator associated with this GigaSpace instance.
|
String |
getName()
Returns the name of the GigaSpace.
|
IJSpace |
getSpace()
Returns the
IJSpace used by this GigaSpace implementation to delegate different
space operations. |
String |
getSpaceName()
Returns the space name.
|
TransactionProvider |
getTxProvider()
Returns the transaction provider allowing to access the current running transaction.
|
GigaSpaceTypeManager |
getTypeManager()
Gets the type manager of this GigaSpace instance.
|
boolean |
isSecured()
Returns wether or not this space is secured.
|
<T> SpaceIterator<T> |
iterator(ISpaceQuery<T> template)
Returns an iterator over the entries in the space which match the specified template.
|
<T> SpaceIterator<T> |
iterator(ISpaceQuery<T> template,
int batchSize)
Returns an iterator over the entries in the space which match the specified template.
|
<T> SpaceIterator<T> |
iterator(ISpaceQuery<T> template,
int batchSize,
ReadModifiers modifiers)
Returns an iterator over the entries in the space which match the specified template.
|
<T> SpaceIterator<T> |
iterator(ISpaceQuery<T> template,
SpaceIteratorConfiguration spaceIteratorConfiguration)
Returns an iterator over the entries in the space which match the specified template.
|
<T> SpaceIterator<T> |
iterator(T template)
Returns an iterator over the entries in the space which match the specified template.
|
<T> SpaceIterator<T> |
iterator(T template,
int batchSize)
Returns an iterator over the entries in the space which match the specified template.
|
<T> SpaceIterator<T> |
iterator(T template,
int batchSize,
ReadModifiers modifiers)
Returns an iterator over the entries in the space which match the specified template.
|
<T> SpaceIterator<T> |
iterator(T template,
SpaceIteratorConfiguration spaceIteratorConfiguration)
Returns an iterator over the entries in the space which match the specified template.
|
DataEventSession |
newDataEventSession()
Creates a new DataEventSession with the default configuration.
|
DataEventSession |
newDataEventSession(EventSessionConfig config)
Creates a new DataEventSession with the specified configuration.
|
<T> ISpaceQuery<T> |
prepareTemplate(Object template)
Translates the template object into pre-processed packet which will be sent to the space.
|
<T> T |
read(ISpaceQuery<T> template)
Read any matching object from the space, blocking until one exists.
|
<T> T |
read(ISpaceQuery<T> template,
long timeout)
Read any matching object from the space, blocking until one exists.
|
<T> T |
read(ISpaceQuery<T> template,
long timeout,
ReadModifiers modifiers)
Read any matching object from the space, blocking until one exists.
|
<T> T |
read(T template)
Read any matching object from the space, blocking until one exists.
|
<T> T |
read(T template,
long timeout)
Read any matching object from the space, blocking until one exists.
|
<T> T |
read(T template,
long timeout,
ReadModifiers modifiers)
Read any matching object from the space, blocking until one exists.
|
<T> T |
readById(Class<T> clazz,
Object id)
Read an object from the space matching its id and the class.
|
<T> T |
readById(Class<T> clazz,
Object id,
Object routing)
Read an object from the space matching its id, the class and the routing value.
|
<T> T |
readById(Class<T> clazz,
Object id,
Object routing,
long timeout)
Read an object from the space matching its id, the class and the routing value.
|
<T> T |
readById(Class<T> clazz,
Object id,
Object routing,
long timeout,
ReadModifiers modifiers)
Read an object from the space matching its id, the class and the routing value.
|
<T> T |
readById(IdQuery<T> query)
Read an object from the space matching the specified id query.
|
<T> T |
readById(IdQuery<T> query,
long timeout)
Read an object from the space matching the specified id query.
|
<T> T |
readById(IdQuery<T> query,
long timeout,
ReadModifiers modifiers)
Read an object from the space matching the specified id query.
|
<T> ReadByIdsResult<T> |
readByIds(Class<T> clazz,
Object[] ids)
Read objects from the space matching their IDs and the specified class.
|
<T> ReadByIdsResult<T> |
readByIds(Class<T> clazz,
Object[] ids,
Object routingKey)
Read objects from the space matching their IDs, the specified class and routing key.
|
<T> ReadByIdsResult<T> |
readByIds(Class<T> clazz,
Object[] ids,
Object[] routingKeys)
Read objects from the space matching their IDs, the specified class and the routing keys.
|
<T> ReadByIdsResult<T> |
readByIds(Class<T> clazz,
Object[] ids,
Object[] routingKeys,
ReadModifiers modifiers)
Read objects from the space matching their IDs, the specified class and the routing keys,
with the provided
ReadModifiers . |
<T> ReadByIdsResult<T> |
readByIds(Class<T> clazz,
Object[] ids,
Object routingKey,
ReadModifiers modifiers)
Read objects from the space matching their IDs, the specified class type and routing key,
with the provided
ReadModifiers . |
<T> ReadByIdsResult<T> |
readByIds(IdsQuery<T> query)
Read objects from the space matching the specified IDs query.
|
<T> ReadByIdsResult<T> |
readByIds(IdsQuery<T> query,
ReadModifiers modifiers)
Read objects from the space matching the specified IDs query, with the provided
ReadModifiers . |
<T> T |
readIfExists(ISpaceQuery<T> template)
Read any matching object from the space, returning
null if there currently is
none. |
<T> T |
readIfExists(ISpaceQuery<T> template,
long timeout)
Read any matching object from the space, returning
null if there currently is
none. |
<T> T |
readIfExists(ISpaceQuery<T> template,
long timeout,
ReadModifiers modifiers)
Read any matching object from the space, returning
null if there currently is
none. |
<T> T |
readIfExists(T template)
Read any matching object from the space, returning
null if there currently is
none. |
<T> T |
readIfExists(T template,
long timeout)
Read any matching object from the space, returning
null if there currently is
none. |
<T> T |
readIfExists(T template,
long timeout,
ReadModifiers modifiers)
Read any matching object from the space, returning
null if there currently is
none. |
<T> T |
readIfExistsById(Class<T> clazz,
Object id)
Read an object from the space matching its id and the class.
|
<T> T |
readIfExistsById(Class<T> clazz,
Object id,
Object routing)
Read an object from the space matching its id, the class and the routing value.
|
<T> T |
readIfExistsById(Class<T> clazz,
Object id,
Object routing,
long timeout)
Read an object from the space matching its id, the class and the routing value.
|
<T> T |
readIfExistsById(Class<T> clazz,
Object id,
Object routing,
long timeout,
ReadModifiers modifiers)
Read an object from the space matching its id, the class and the routing value.
|
<T> T |
readIfExistsById(IdQuery<T> query)
Read an object from the space matching the specified id query.
|
<T> T |
readIfExistsById(IdQuery<T> query,
long timeout)
Read an object from the space matching the specified id query.
|
<T> T |
readIfExistsById(IdQuery<T> query,
long timeout,
ReadModifiers modifiers)
Read an object from the space matching the specified id query.
|
<T> T[] |
readMultiple(ISpaceQuery<T> template)
Read any matching entries from the space.
|
<T> T[] |
readMultiple(ISpaceQuery<T> template,
int maxEntries)
Read any matching entries from the space.
|
<T> T[] |
readMultiple(ISpaceQuery<T> template,
int maxEntries,
ReadModifiers modifiers)
Read any matching entries from the space.
|
<T> T[] |
readMultiple(T template)
Read any matching entries from the space.
|
<T> T[] |
readMultiple(T template,
int maxEntries)
Read any matching entries from the space.
|
<T> T[] |
readMultiple(T template,
int maxEntries,
ReadModifiers modifiers)
Read any matching entries from the space.
|
void |
setQuiesceToken(QuiesceToken token) |
<T> ISpaceQuery<T> |
snapshot(Object entry)
Deprecated.
since 10.1.0 - usage alternatives: 1.
prepareTemplate(Object) if one
needs to prepare and cache the template as pre-processed packet without accessing the server.
2. GigaSpaceTypeManager.registerTypeDescriptor(Class) or GigaSpaceTypeManager.registerTypeDescriptor(com.gigaspaces.metadata.SpaceTypeDescriptor) if
one wants to introduce (register) a new type to the space. 3. It's possible to combine (1)
and (2) to achieve full snapshot functionality |
<T> T |
take(ISpaceQuery<T> template)
Take (remove) any matching entry from the space, blocking until one exists.
|
<T> T |
take(ISpaceQuery<T> template,
long timeout)
Take (remove) any matching entry from the space, blocking until one exists.
|
<T> T |
take(ISpaceQuery<T> template,
long timeout,
TakeModifiers modifiers)
Take (remove) any matching entry from the space, blocking until one exists.
|
<T> T |
take(T template)
Take (remove) any matching entry from the space, blocking until one exists.
|
<T> T |
take(T template,
long timeout)
Take (remove) any matching entry from the space, blocking until one exists.
|
<T> T |
take(T template,
long timeout,
TakeModifiers modifiers)
Take (remove) any matching entry from the space, blocking until one exists.
|
<T> T |
takeById(Class<T> clazz,
Object id)
Take (remove) an object from the space matching its id and the class.
|
<T> T |
takeById(Class<T> clazz,
Object id,
Object routing)
Take (remove) an object from the space matching its id, the class and the routing value.
|
<T> T |
takeById(Class<T> clazz,
Object id,
Object routing,
long timeout)
Take (remove) an object from the space matching its id, the class and the routing value.
|
<T> T |
takeById(Class<T> clazz,
Object id,
Object routing,
long timeout,
TakeModifiers modifiers)
Take (remove) an object from the space matching its id, the class and the routing value.
|
<T> T |
takeById(IdQuery<T> query)
Take (remove) an object from the space matching the specified id query.
|
<T> T |
takeById(IdQuery<T> query,
long timeout)
Take (remove) an object from the space matching the specified id query.
|
<T> T |
takeById(IdQuery<T> query,
long timeout,
TakeModifiers modifiers)
Take (remove) an object from the space matching the specified id query.
|
<T> TakeByIdsResult<T> |
takeByIds(Class<T> clazz,
Object[] ids)
Take (remove) objects from the space matching their IDs and the specified class.
|
<T> TakeByIdsResult<T> |
takeByIds(Class<T> clazz,
Object[] ids,
Object routingKey)
Take (remove) objects from the space matching their IDs, the specified class and routing key.
|
<T> TakeByIdsResult<T> |
takeByIds(Class<T> clazz,
Object[] ids,
Object[] routingKeys)
Take (remove) objects from the space matching their IDs, the specified class and the routing
keys.
|
<T> TakeByIdsResult<T> |
takeByIds(Class<T> clazz,
Object[] ids,
Object[] routingKeys,
TakeModifiers modifiers)
Take (remove) objects from the space matching their IDs, the specified class and the routing
keys, with the provided
ReadModifiers . |
<T> TakeByIdsResult<T> |
takeByIds(Class<T> clazz,
Object[] ids,
Object routingKey,
TakeModifiers modifiers)
Take (remove) objects from the space matching their IDs, the specified class type and routing
key, with the provided
ReadModifiers . |
<T> TakeByIdsResult<T> |
takeByIds(IdsQuery<T> query)
Take (remove) objects from the space matching the specified IDs query.
|
<T> TakeByIdsResult<T> |
takeByIds(IdsQuery<T> query,
TakeModifiers modifiers)
Take (remove) objects from the space matching the specified IDs query, with the provided
ReadModifiers . |
<T> T |
takeIfExists(ISpaceQuery<T> template)
Take (remove) any matching entry from the space, returning
null if there
currently is none. |
<T> T |
takeIfExists(ISpaceQuery<T> template,
long timeout)
Take (remove) any matching entry from the space, returning
null if there
currently is none. |
<T> T |
takeIfExists(ISpaceQuery<T> template,
long timeout,
TakeModifiers modifiers)
Take (remove) any matching entry from the space, returning
null if there
currently is none. |
<T> T |
takeIfExists(T template)
Take (remove) any matching entry from the space, returning
null if there
currently is none. |
<T> T |
takeIfExists(T template,
long timeout)
Take (remove) any matching entry from the space, returning
null if there
currently is none. |
<T> T |
takeIfExists(T template,
long timeout,
TakeModifiers modifiers)
Take (remove) any matching entry from the space, returning
null if there
currently is none. |
<T> T |
takeIfExistsById(Class<T> clazz,
Object id)
Take (remove) an object from the space matching its id and the class.
|
<T> T |
takeIfExistsById(Class<T> clazz,
Object id,
Object routing)
Take (remove) an object from the space matching its id, the class and the routing value.
|
<T> T |
takeIfExistsById(Class<T> clazz,
Object id,
Object routing,
long timeout)
Take (remove) an object from the space matching its id, the class and the routing value.
|
<T> T |
takeIfExistsById(Class<T> clazz,
Object id,
Object routing,
long timeout,
TakeModifiers modifiers)
Take (remove) an object from the space matching its id, the class and the routing value.
|
<T> T |
takeIfExistsById(IdQuery<T> query)
Take (remove) an object from the space matching the specified id query.
|
<T> T |
takeIfExistsById(IdQuery<T> query,
long timeout)
Take (remove) an object from the space matching the specified id query.
|
<T> T |
takeIfExistsById(IdQuery<T> query,
long timeout,
TakeModifiers modifiers)
Take (remove) an object from the space matching the specified id query.
|
<T> T[] |
takeMultiple(ISpaceQuery<T> template)
Takes (removes) all the entries matching the specified template from this space.
|
<T> T[] |
takeMultiple(ISpaceQuery<T> template,
int maxEntries)
Takes (removes) all the entries matching the specified template from this space.
|
<T> T[] |
takeMultiple(ISpaceQuery<T> template,
int maxEntries,
TakeModifiers modifiers)
Takes (removes) all the entries matching the specified template from this space.
|
<T> T[] |
takeMultiple(T template)
Takes (removes) all the entries matching the specified template from this space.
|
<T> T[] |
takeMultiple(T template,
int maxEntries)
Takes (removes) all the entries matching the specified template from this space.
|
<T> T[] |
takeMultiple(T template,
int maxEntries,
TakeModifiers modifiers)
Takes (removes) all the entries matching the specified template from this space.
|
<T> LeaseContext<T> |
write(T entry)
Writes a new object to the space, returning its
LeaseContext . |
<T> LeaseContext<T> |
write(T entry,
long lease)
Writes a new object to the space, returning its
LeaseContext . |
<T> LeaseContext<T> |
write(T entry,
long lease,
long timeout,
WriteModifiers modifiers)
Writes a new object to the space, returning its
LeaseContext . |
<T> LeaseContext<T> |
write(T entry,
WriteModifiers modifiers)
Writes a new object to the space, returning its
LeaseContext . |
<T> LeaseContext<T>[] |
writeMultiple(T[] entries)
Writes the specified entries to this space.
|
<T> LeaseContext<T>[] |
writeMultiple(T[] entries,
long lease)
Writes the specified entries to this space.
|
<T> LeaseContext<T>[] |
writeMultiple(T[] entries,
long[] leases,
long timeout,
WriteModifiers modifiers)
Writes the specified entries to this space.
|
<T> LeaseContext<T>[] |
writeMultiple(T[] entries,
long[] leases,
WriteModifiers modifiers)
Writes the specified entries to this space.
|
<T> LeaseContext<T>[] |
writeMultiple(T[] entries,
long lease,
long timeout,
WriteModifiers modifiers)
Writes the specified entries to this space.
|
<T> LeaseContext<T>[] |
writeMultiple(T[] entries,
long lease,
WriteModifiers modifiers)
Writes the specified entries to this space.
|
<T> LeaseContext<T>[] |
writeMultiple(T[] entries,
WriteModifiers modifiers)
Writes the specified entries to this space.
|
String getName()
String getSpaceName()
boolean isSecured()
IJSpace getSpace()
IJSpace
used by this GigaSpace implementation to delegate different
space operations. Allows the use of space operations that are not exposed by this interface, as well as use as a parameter to other low level GigaSpace components.
If
a transaction object is required for low level operations (as low level operations do not
have declarative transaction ex) the getTxProvider()
should be used to acquire the
current running transaction.
GigaSpace getClustered()
GigaSpace
instance.
GigaSpace gigaSpace = new GigaSpaceConfigurer(space).clustered(true).gigaSpace();If this instance is already a clustered view (was initially constructed using the clustered flag), will return the same instance being used to issue the call. If this is a GigaSpace that works directly with a cluster member, will return a clustered view (as if it was constructed with the clustered flag set). Note that this method might return different instances when being called by different threads.
GigaSpace nonClusteredViewOfGigaSpace= ... // acquire non-clustered view of a clustered space GigaSpace space=nonClusteredViewofGigaSpace.getClustered(); // space != nonClusteredViewOfSpace
GigaSpace clusteredViewOfGigaSpace= ... // acquire clustered view of a clustered space GigaSpace space=clusteredViewofGigaSpace.getClustered(); // space == clusteredViewOfSpace
GigaSpaceConfigurer.clustered(boolean)
TransactionProvider getTxProvider()
Transaction getCurrentTransaction()
null
if no transaction is in
progress.ExceptionTranslator getExceptionTranslator()
WriteModifiers getDefaultWriteModifiers()
WriteModifiers
set during this GigaSpace
configuration. This
value is configured either by using a GigaSpaceConfigurer
or through the pu.xml.ClearModifiers getDefaultClearModifiers()
ClearModifiers
set during this GigaSpace
configuration. This
value is configured either by using a GigaSpaceConfigurer
or through the pu.xml.CountModifiers getDefaultCountModifiers()
CountModifiers
set during this GigaSpace
configuration. This
value is configured either by using a GigaSpaceConfigurer
or through the pu.xml. If
there is an active transaction and that transaction has any isolation level set on it, that
isolation level will be merged into the returned modifiers with any previously set isolation
level on the modifiers overriden.ReadModifiers getDefaultReadModifiers()
ReadModifiers
set during this GigaSpace
configuration. This
value is configured either by using a GigaSpaceConfigurer
or through the pu.xml. If
there is an active transaction and that transaction has any isolation level set on it, that
isolation level will be merged into the returned modifiers with any previously set isolation
level on the modifiers overriden.TakeModifiers getDefaultTakeModifiers()
TakeModifiers
set during this GigaSpace
configuration. This
value is configured either by using a GigaSpaceConfigurer
or through the pu.xml.ChangeModifiers getDefaultChangeModifiers()
ChangeModifiers
set during this GigaSpace
configuration.
This value is configured either by using a GigaSpaceConfigurer
or through the
pu.xml.void clear(Object template) throws org.springframework.dao.DataAccessException
If the clear operation conducted without transaction (null as value) it will clear all entries that are not under transaction. Therefore entries under transaction would not be removed from the space.
The clear operation supports inheritance, therefore
template class matching objects and its sub classes matching objects are part of the
candidates population to be removed from the space. You can in fact clean all space objects
(that are not under transaction) by calling: gigaSpace.clear(null)
.
Notice: The clear operation does not remove notify templates, i.e. registration for notifications.
template
- the template to use for matchingorg.springframework.dao.DataAccessException
- In the event of an error, DataAccessException will wrap a
ClearException, accessible via DataAccessException.getRootCause().int clear(Object template, ClearModifiers modifiers)
If the clear operation conducted without transaction (null as value) it will clear all entries that are not under transaction. Therefore entries under transaction would not be removed from the space.
The clear operation supports inheritance, therefore
template class matching objects and its sub classes matching objects are part of the
candidates population to be removed from the space. You can in fact remove all space objects
(that are not under transaction) by calling: gigaSpace.clear(null)
.
Notice: The clear operation does not remove notify templates i.e. registration for notifications.
template
- the template to use for matchingmodifiers
- one or a union of ClearModifiers
.org.springframework.dao.DataAccessException
- In the event of an error, DataAccessException will wrap a
ClearException, accessible via DataAccessException.getRootCause().int count(Object template) throws org.springframework.dao.DataAccessException
template
- The template used for matching. Matching is done against the template with
null
fields being wildcards ("match anything") other fields
being values ("match exactly on the serialized form").org.springframework.dao.DataAccessException
int count(Object template, CountModifiers modifiers) throws org.springframework.dao.DataAccessException
Allows to specify modifiers using
ReadModifiers
which allows to programmatically control the isolation level this count
operation will be performed under.
template
- The template used for matching. Matching is done against the template with
null
fields being wildcards ("match anything") other fields
being values ("match exactly on the serialized form").modifiers
- one or a union of CountModifiers
.org.springframework.dao.DataAccessException
@Deprecated <T> ISpaceQuery<T> snapshot(Object entry) throws org.springframework.dao.DataAccessException
prepareTemplate(Object)
if one
needs to prepare and cache the template as pre-processed packet without accessing the server.
2. GigaSpaceTypeManager.registerTypeDescriptor(Class)
or GigaSpaceTypeManager.registerTypeDescriptor(com.gigaspaces.metadata.SpaceTypeDescriptor)
if
one wants to introduce (register) a new type to the space. 3. It's possible to combine (1)
and (2) to achieve full snapshot functionalityThe process of serializing an entry for transmission to a JavaSpaces service will be identical if the same entry is used twice. This is most likely to be an issue with templates that are used repeatedly to search for entries with read or take.
The client-side implementations of read and take cannot reasonably avoid this duplicated effort, since they have no efficient way of checking whether the same template is being used without intervening modification.
The snapshot method gives the JavaSpaces service implementor a way to reduce the impact of repeated use of the same entry. Invoking snapshot with an Entry will return another Entry object that contains a snapshot of the original entry. Using the returned snapshot entry is equivalent to using the unmodified original entry in all operations on the same JavaSpaces service.
Modifications to the original entry will
not affect the snapshot. You can snapshot a null template; snapshot may or may not return
null given a null template. The entry returned from snapshot will be guaranteed equivalent to
the original unmodified object only when used with the space. Using the snapshot with any
other JavaSpaces service will generate an IllegalArgumentException
unless the
other space can use it because of knowledge about the JavaSpaces service that generated the
snapshot.
The snapshot will be a different object from the original, may or may not
have the same hash code, and equals may or may not return true when invoked with the original
object, even if the original object is unmodified. A snapshot is guaranteed to work only
within the virtual machine in which it was generated. If a snapshot is passed to another
virtual machine (for example, in a parameter of an RMI call), using it--even with the same
JavaSpaces service--may generate an IllegalArgumentException
.
entry
- The entry to snapshotorg.springframework.dao.DataAccessException
<T> T readById(Class<T> clazz, Object id) throws org.springframework.dao.DataAccessException
null
if
there is no match. The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
Note, if the space is partitioned, and
the Entry has a specific property for its routing value, the operation will broadcast to all
partitions. The readById(Class, Object, Object)
can be used to specify the routing.
clazz
- The class of the entryid
- The id of the entrynull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readById(Class<T> clazz, Object id, Object routing) throws org.springframework.dao.DataAccessException
null
if there is no match. The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readById(Class<T> clazz, Object id, Object routing, long timeout) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout.clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuetimeout
- The timeout value to wait for a matching entry if it does not exists within
the spacenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readById(Class<T> clazz, Object id, Object routing, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout.clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuetimeout
- The timeout value to wait for a matching entry if it does not exists within
the spacemodifiers
- one or a union of ReadModifiers
.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readById(IdQuery<T> query) throws org.springframework.dao.DataAccessException
null
if
there is no match. The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
Note, if the space is partitioned, and
the Entry has a specific property for its routing value, the operation will broadcast to all
partitions. The readById(Class, Object, Object)
can be used to specify the routing.
query
- Query to search by.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readById(IdQuery<T> query, long timeout) throws org.springframework.dao.DataAccessException
null
if
there is no match within the specified timeout.query
- Query to search by.timeout
- The timeout value to wait for a matching entry if it does not exists within
the spacenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readById(IdQuery<T> query, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if
there is no match within the specified timeout.query
- Query to search by.timeout
- The timeout value to wait for a matching entry if it does not exists within
the spacemodifiers
- one or a union of ReadModifiers
.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T read(T template) throws org.springframework.dao.DataAccessException
null
if the timeout expires. Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
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").org.springframework.dao.DataAccessException
<T> T read(T template, long timeout) throws org.springframework.dao.DataAccessException
null
if the timeout expires.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").timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> T read(T template, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if the timeout expires. Overloads read(Object, long)
by adding a
modifiers
parameter. Equivalent when called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used to define the behavior of a read
operation.
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").timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.modifiers
- one or a union of ReadModifiers
.org.springframework.dao.DataAccessException
<T> T read(ISpaceQuery<T> template) throws org.springframework.dao.DataAccessException
null
if the timeout expires. Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- A query to be executed against the space. Most common one is SQLQuery
.org.springframework.dao.DataAccessException
<T> T read(ISpaceQuery<T> template, long timeout) throws org.springframework.dao.DataAccessException
null
if the timeout expires.template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> T read(ISpaceQuery<T> template, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if the timeout expires. Overloads read(Object, long)
by adding a
modifiers
parameter. Equivalent when called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used to define the behavior of a read
operation.
template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.modifiers
- one or a union of ReadModifiers
.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(T template) throws org.springframework.dao.DataAccessException
null
in case
there was no match). Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
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").org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(T template, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case
there was no match). Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
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").listener
- A listener to be notified when a result arrivesorg.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(T template, long timeout) throws org.springframework.dao.DataAccessException
null
in case
there was no match).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").timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(T template, long timeout, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case
there was no match).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").timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.listener
- A listener to be notified when a result arrivesorg.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(T template, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
in case
there was no match). Overloads asyncRead(Object, long)
by adding a
modifiers
parameter. Equivalent when called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used to define the behavior of a read
operation.
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").timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.modifiers
- one or a union of ReadModifiers
.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(T template, long timeout, ReadModifiers modifiers, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case
there was no match). Overloads asyncRead(Object, long)
by adding a
modifiers
parameter. Equivalent when called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used to define the behavior of a read
operation.
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").timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.modifiers
- one or a union of ReadModifiers
.listener
- A listener to be notified when a result arrivesorg.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(ISpaceQuery<T> template) throws org.springframework.dao.DataAccessException
null
in case
there was no match). Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- A query to be executed against the space. Most common one is SQLQuery
.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(ISpaceQuery<T> template, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case
there was no match). Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- A query to be executed against the space. Most common one is SQLQuery
.listener
- A listener to be notified when a result arrivesorg.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(ISpaceQuery<T> template, long timeout) throws org.springframework.dao.DataAccessException
null
in case
there was no match).template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(ISpaceQuery<T> template, long timeout, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case
there was no match).template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.listener
- A listener to be notified when a result arrivesorg.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(ISpaceQuery<T> template, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
in case
there was no match). Overloads asyncRead(Object, long)
by adding a
modifiers
parameter. Equivalent when called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used to define the behavior of a read
operation.
template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.modifiers
- one or a union of ReadModifiers
.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncRead(ISpaceQuery<T> template, long timeout, ReadModifiers modifiers, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case
there was no match). Overloads asyncRead(Object, long)
by adding a
modifiers
parameter. Equivalent when called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used to define the behavior of a read
operation.
template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.modifiers
- one or a union of ReadModifiers
.listener
- A listener to be notified when a result arrivesorg.springframework.dao.DataAccessException
<T> T readIfExistsById(Class<T> clazz, Object id) throws org.springframework.dao.DataAccessException
null
if
there is no match. Matching and timeouts are done as in readById
, except
that blocking in this call is done only if necessary to wait for transactional state to
settle.
The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
Note, if the space is partitioned, and the Entry has
a specific property for its routing value, the operation will broadcast to all partitions.
The readById(Class, Object, Object)
can be used to specify the routing.
clazz
- The class of the entryid
- The id of the entrynull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readIfExistsById(Class<T> clazz, Object id, Object routing) throws org.springframework.dao.DataAccessException
null
if there is no match. Matching and timeouts are done as in
readById
, except that blocking in this call is done only if necessary to wait
for transactional state to settle.
The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readIfExistsById(Class<T> clazz, Object id, Object routing, long timeout) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout. Matching and
timeouts are done as in readById
, except that blocking in this call is done only
if necessary to wait for transactional state to settle.
clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuetimeout
- The timeout value to wait for a matching entry if it does not exists within
the spacenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readIfExistsById(Class<T> clazz, Object id, Object routing, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout. Matching and
timeouts are done as in readById
, except that blocking in this call is done only
if necessary to wait for transactional state to settle.
clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuetimeout
- The timeout value to wait for a matching entry if it does not exists within
the spacemodifiers
- one or a union of ReadModifiers
.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readIfExistsById(IdQuery<T> query) throws org.springframework.dao.DataAccessException
null
if
there is no match. The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
Note, if the space is partitioned, and
the Entry has a specific property for its routing value, the operation will broadcast to all
partitions. The readById(Class, Object, Object)
can be used to specify the routing.
Matching and timeouts are done as in readById
, except that blocking in
this call is done only if necessary to wait for transactional state to settle.
query
- Query to search by.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readIfExistsById(IdQuery<T> query, long timeout) throws org.springframework.dao.DataAccessException
null
if
there is no match within the specified timeout. Matching and timeouts are done as in
readById
, except that blocking in this call is done only if necessary to wait
for transactional state to settle.
query
- Query to search by.timeout
- The timeout value to wait for a matching entry if it does not exists within
the spacenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readIfExistsById(IdQuery<T> query, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if
there is no match within the specified timeout. Matching and timeouts are done as in
readById
, except that blocking in this call is done only if necessary to wait
for transactional state to settle.
query
- Query to search by.timeout
- The timeout value to wait for a matching entry if it does not exists within
the spacemodifiers
- one or a union of ReadModifiers
.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T readIfExists(T template) throws org.springframework.dao.DataAccessException
null
if there currently is
none. Matching and timeouts are done as in read
, except that blocking in this
call is done only if necessary to wait for transactional state to settle. Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- The template used for matching. Matching is done against the template with
null
fields being wildcards ("match anything") other fields
being values ("match exactly on the serialized form").org.springframework.dao.DataAccessException
<T> T readIfExists(T template, long timeout) throws org.springframework.dao.DataAccessException
null
if there currently is
none. Matching and timeouts are done as in read
, except that blocking in this
call is done only if necessary to wait for transactional state to settle.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").timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> T readIfExists(T template, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there currently is
none. Matching and timeouts are done as in read
, except that blocking in this
call is done only if necessary to wait for transactional state to settle. Overloads
read(Object, long)
by adding a modifiers
parameter. Equivalent when
called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used
to define the behavior of a read operation.
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").timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.modifiers
- one or a union of ReadModifiers
.org.springframework.dao.DataAccessException
<T> T readIfExists(ISpaceQuery<T> template) throws org.springframework.dao.DataAccessException
null
if there currently is
none. Matching and timeouts are done as in read
, except that blocking in this
call is done only if necessary to wait for transactional state to settle. Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- A query to be executed against the space. Most common one is SQLQuery
.org.springframework.dao.DataAccessException
<T> T readIfExists(ISpaceQuery<T> template, long timeout) throws org.springframework.dao.DataAccessException
null
if there currently is
none. Matching and timeouts are done as in read
, except that blocking in this
call is done only if necessary to wait for transactional state to settle.template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> T readIfExists(ISpaceQuery<T> template, long timeout, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there currently is
none. Matching and timeouts are done as in read
, except that blocking in this
call is done only if necessary to wait for transactional state to settle. Overloads
read(Object, long)
by adding a modifiers
parameter. Equivalent when
called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used
to define the behavior of a read operation.
template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
object. A timeout of 0 means to wait no time at all.modifiers
- one or a union of ReadModifiers
.org.springframework.dao.DataAccessException
<T> T[] readMultiple(T template) throws org.springframework.dao.DataAccessException
read
without
timeout (0). Returns an unbounded array of matches. Returns an empty array if no match was
found. Same as calling readMultiple(template,
Integer.MAX_VALUE)
.template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classesorg.springframework.dao.DataAccessException
- In the event of a read error, DataAccessException will wrap a
ReadMultipleException, accessible via DataAccessException.getRootCause().<T> T[] readMultiple(T template, int maxEntries) throws org.springframework.dao.DataAccessException
read
without
timeout (0). Returns an array with matches bound by maxEntries
. Returns an empty
array if no match was found.template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can
also be one of the different ISpaceQuery
classesmaxEntries
- A limit on the number of entries to be returned. Use Integer.MAX_VALUE
for the uppermost limit.org.springframework.dao.DataAccessException
- In the event of a read error, DataAccessException will wrap a
ReadMultipleException, accessible via DataAccessException.getRootCause().<T> T[] readMultiple(T template, int maxEntries, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
read
without
timeout (0). Returns an array with matches bound by maxEntries
. Returns an empty
array if no match was found. Overloads readMultiple(Object, int)
by adding a
modifiers
parameter. Equivalent when called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used to define the behavior of a read
operation.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can
also be one of the different ISpaceQuery
classesmaxEntries
- A limit on the number of entries to be returned. Use Integer.MAX_VALUE
for the uppermost limit.modifiers
- one or a union of ReadModifiers
.org.springframework.dao.DataAccessException
- In the event of a read error, DataAccessException will wrap a
ReadMultipleException, accessible via DataAccessException.getRootCause().<T> T[] readMultiple(ISpaceQuery<T> template) throws org.springframework.dao.DataAccessException
read
without
timeout (0). Returns an unbounded array of matches. Returns an empty array if no match was
found.template
- A query to be executed against the space. Most common one is SQLQuery
.org.springframework.dao.DataAccessException
- In the event of a read error, DataAccessException will wrap a
ReadMultipleException, accessible via DataAccessException.getRootCause().<T> T[] readMultiple(ISpaceQuery<T> template, int maxEntries) throws org.springframework.dao.DataAccessException
read
without
timeout (0). Returns an array with matches bound by maxEntries
. Returns an empty
array if no match was found.template
- A query to be executed against the space. Most common one is SQLQuery
.maxEntries
- A limit on the number of entries to be returned. Use Integer.MAX_VALUE
for the uppermost limit.org.springframework.dao.DataAccessException
- In the event of a read error, DataAccessException will wrap a
ReadMultipleException, accessible via DataAccessException.getRootCause().<T> T[] readMultiple(ISpaceQuery<T> template, int maxEntries, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
read
without
timeout (0). Returns an array with matches bound by maxEntries
. Returns an empty
array if no match was found. Overloads readMultiple(Object, int)
by adding a
modifiers
parameter. Equivalent when called with the default modifier - ReadModifiers.REPEATABLE_READ
. Modifiers are used to define the behavior of a read
operation.
template
- A query to be executed against the space. Most common one is SQLQuery
.maxEntries
- A limit on the number of entries to be returned. Use Integer.MAX_VALUE
for the uppermost limit.modifiers
- one or a union of ReadModifiers
.org.springframework.dao.DataAccessException
- In the event of a read error, DataAccessException will wrap a
ReadMultipleException, accessible via DataAccessException.getRootCause().<T> ReadByIdsResult<T> readByIds(Class<T> clazz, Object[] ids) throws org.springframework.dao.DataAccessException
Note, if the
space is partitioned and the Class defines that routing is not done via the Id property, the
operation will broadcast to all partitions. Use readByIds(Class, Object[], Object)
to specify the routing explicitly and avoid broadcast if needed.
clazz
- The class.ids
- The object IDs array.org.springframework.dao.DataAccessException
<T> ReadByIdsResult<T> readByIds(Class<T> clazz, Object[] ids, Object routingKey) throws org.springframework.dao.DataAccessException
Note, if the space is partitioned and the Class defines that routing is not done via the
Id property, the operation will be routed according to routingKey
. If it is
null, the operation will broadcast to all partitions.
clazz
- The class.ids
- The object IDs array.routingKey
- The routing of the provided object IDs.org.springframework.dao.DataAccessException
<T> ReadByIdsResult<T> readByIds(Class<T> clazz, Object[] ids, Object routingKey, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
ReadModifiers
. Note, if the space is partitioned and the
Class defines that routing is not done via the Id property, the operation will be routed
according to routingKey
. If it is null, the operation will broadcast to all
partitions.
ReadModifiers.FIFO
is not supported by this operation - the
results are always ordered in correlation with the input IDs array.
clazz
- The class.ids
- The object IDs array.routingKey
- The routing of the provided object IDs.modifiers
- The read modifier to use (One or several of ReadModifiers
).org.springframework.dao.DataAccessException
<T> ReadByIdsResult<T> readByIds(Class<T> clazz, Object[] ids, Object[] routingKeys) throws org.springframework.dao.DataAccessException
Note, if the space is partitioned and the Class defines that routing is not done via
the Id property, the operation will be routed according to routingKeys
. If it is
null, the operation will broadcast to all partitions. routingKeys
should be
correlated with ids
, i.e. their length should be the same, and the routing key
of ID i in the IDs array is the element at position i in the routing keys array.
clazz
- The class.ids
- The object IDs array.routingKeys
- The object routing keys array.org.springframework.dao.DataAccessException
<T> ReadByIdsResult<T> readByIds(Class<T> clazz, Object[] ids, Object[] routingKeys, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
ReadModifiers
. Note, if the space is partitioned and the
Class defines that routing is not done via the Id property, the operation will be routed
according to routingKeys
. If it is null, the operation will broadcast to all
partitions. routingKeys
should be correlated with ids
, i.e. their
length should be the same, and the routing key of ID i in the IDs array is the element at
position i in the routing keys array.
ReadModifiers.FIFO
is not supported by
this operation - the results are always ordered in correlation with the input IDs array.
clazz
- The class type.ids
- The objects\ IDs array.routingKeys
- The object routing keys array.modifiers
- The read modifier to use (One or several of ReadModifiers
).org.springframework.dao.DataAccessException
<T> ReadByIdsResult<T> readByIds(IdsQuery<T> query) throws org.springframework.dao.DataAccessException
query
- Query to search by.org.springframework.dao.DataAccessException
<T> ReadByIdsResult<T> readByIds(IdsQuery<T> query, ReadModifiers modifiers) throws org.springframework.dao.DataAccessException
ReadModifiers
.query
- Query to search by.modifiers
- The read modifier to use (One or several of ReadModifiers
).org.springframework.dao.DataAccessException
<T> TakeByIdsResult<T> takeByIds(Class<T> clazz, Object[] ids) throws org.springframework.dao.DataAccessException
Note, if the space is partitioned and the Class defines that routing is not done via the
Id property, the operation will broadcast to all partitions. Use readByIds(Class,
Object[], Object)
to specify the routing explicitly and avoid broadcast if needed.
clazz
- The class.ids
- The object IDs array.org.springframework.dao.DataAccessException
<T> TakeByIdsResult<T> takeByIds(Class<T> clazz, Object[] ids, Object routingKey) throws org.springframework.dao.DataAccessException
Note, if the space is partitioned and the Class defines that routing is not done via
the Id property, the operation will be routed according to routingKey
. If it is
null, the operation will broadcast to all partitions.
clazz
- The class.ids
- The object IDs array.routingKey
- The routing of the provided object IDs.org.springframework.dao.DataAccessException
<T> TakeByIdsResult<T> takeByIds(Class<T> clazz, Object[] ids, Object routingKey, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
ReadModifiers
. Note, if the space is partitioned and
the Class defines that routing is not done via the Id property, the operation will be routed
according to routingKey
. If it is null, the operation will broadcast to all
partitions.
ReadModifiers.FIFO
is not supported by this operation - the
results are always ordered in correlation with the input IDs array.
clazz
- The class.ids
- The object IDs array.routingKey
- The routing of the provided object IDs.modifiers
- The read modifier to use (One or several of ReadModifiers
).org.springframework.dao.DataAccessException
<T> TakeByIdsResult<T> takeByIds(Class<T> clazz, Object[] ids, Object[] routingKeys) throws org.springframework.dao.DataAccessException
Note, if the space is partitioned and the Class defines that routing is not
done via the Id property, the operation will be routed according to routingKeys
.
If it is null, the operation will broadcast to all partitions. routingKeys
should be correlated with ids
, i.e. their length should be the same, and the
routing key of ID i in the IDs array is the element at position i in the routing keys array.
clazz
- The class.ids
- The object IDs array.routingKeys
- The object routing keys array.org.springframework.dao.DataAccessException
<T> TakeByIdsResult<T> takeByIds(Class<T> clazz, Object[] ids, Object[] routingKeys, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
ReadModifiers
. Note, if the space is partitioned and
the Class defines that routing is not done via the Id property, the operation will be routed
according to routingKeys
. If it is null, the operation will broadcast to all
partitions. routingKeys
should be correlated with ids
, i.e. their
length should be the same, and the routing key of ID i in the IDs array is the element at
position i in the routing keys array.
ReadModifiers.FIFO
is not supported by
this operation - the results are always ordered in correlation with the input IDs array.
clazz
- The class type.ids
- The objects\ IDs array.routingKeys
- The object routing keys array.modifiers
- The read modifier to use (One or several of ReadModifiers
).org.springframework.dao.DataAccessException
<T> TakeByIdsResult<T> takeByIds(IdsQuery<T> query) throws org.springframework.dao.DataAccessException
query
- Query to search by.org.springframework.dao.DataAccessException
<T> TakeByIdsResult<T> takeByIds(IdsQuery<T> query, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
ReadModifiers
.query
- Query to search by.modifiers
- The read modifier to use (One or several of ReadModifiers
).org.springframework.dao.DataAccessException
<T> T takeById(Class<T> clazz, Object id) throws org.springframework.dao.DataAccessException
null
if there is no match. The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
Note, if the
space is partitioned, and the Entry has a specific property for its routing value, the
operation will broadcast to all partitions. The takeById(Class, Object, Object)
can
be used to specify the routing.
clazz
- The class of the entryid
- The id of the entrynull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeById(Class<T> clazz, Object id, Object routing) throws org.springframework.dao.DataAccessException
null
if there is no match. The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeById(Class<T> clazz, Object id, Object routing, long timeout) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout.clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuetimeout
- The timeout value to wait for a matching entry if it does not exists within
the spacenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeById(Class<T> clazz, Object id, Object routing, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout.clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuetimeout
- The timeout value to wait for a matching entry if it does not exists within
the spacemodifiers
- one or a union of TakeModifiers
.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeById(IdQuery<T> query) throws org.springframework.dao.DataAccessException
null
if there is no match. The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
Note, if the
space is partitioned, and the Entry has a specific property for its routing value, the
operation will broadcast to all partitions. The readById(Class, Object, Object)
can
be used to specify the routing.
query
- Query to search by.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeById(IdQuery<T> query, long timeout) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout.query
- Query to search by.timeout
- The timeout value to wait for a matching entry if it does not exists within
the spacenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeById(IdQuery<T> query, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout.query
- Query to search by.timeout
- The timeout value to wait for a matching entry if it does not exists within
the spacemodifiers
- one or a union of TakeModifiers
.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T take(T template) throws org.springframework.dao.DataAccessException
null
if the timeout expires. Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- The template used for matching. Matching is done against the template with
null
fields being wildcards ( "match anything") other fields
being values ("match exactly on the serialized form").org.springframework.dao.DataAccessException
<T> T take(T template, long timeout) throws org.springframework.dao.DataAccessException
null
if the timeout expires.template
- The template used for matching. Matching is done against the 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 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> T take(T template, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if the timeout expires.template
- The template used for matching. Matching is done against the 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 0 means to wait no time at all.modifiers
- one or a union of TakeModifiers
.org.springframework.dao.DataAccessException
<T> T take(ISpaceQuery<T> template) throws org.springframework.dao.DataAccessException
null
if the timeout expires. Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- A query to be executed against the space. Most common one is SQLQuery
.org.springframework.dao.DataAccessException
<T> T take(ISpaceQuery<T> template, long timeout) throws org.springframework.dao.DataAccessException
null
if the timeout expires.template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
entry. A timeout of 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> T take(ISpaceQuery<T> template, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if the timeout expires.template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
entry. A timeout of 0 means to wait no time at all.modifiers
- one or a union of TakeModifiers
.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(T template) throws org.springframework.dao.DataAccessException
null
in case there was no match). Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- The template used for matching. Matching is done against the template with
null
fields being wildcards ( "match anything") other fields
being values ("match exactly on the serialized form").org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(T template, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case there was no match). Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- The template used for matching. Matching is done against the template with
null
fields being wildcards ( "match anything") other fields
being values ("match exactly on the serialized form").listener
- A listener to be notified when a result arrivesorg.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(T template, long timeout) throws org.springframework.dao.DataAccessException
null
in case there was no match).template
- The template used for matching. Matching is done against the 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 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(T template, long timeout, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case there was no match).template
- The template used for matching. Matching is done against the 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 0 means to wait no time at all.listener
- A listener to be notified when a result arrivesorg.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(T template, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
in case there was no match).template
- The template used for matching. Matching is done against the 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 0 means to wait no time at all.modifiers
- one or a union of TakeModifiers
.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(T template, long timeout, TakeModifiers modifiers, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case there was no match).template
- The template used for matching. Matching is done against the 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 0 means to wait no time at all.modifiers
- one or a union of TakeModifiers
.listener
- A listener to be notified when a result arrivesorg.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(ISpaceQuery<T> template) throws org.springframework.dao.DataAccessException
null
in case there was no match). Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- A query to be executed against the space. Most common one is SQLQuery
.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(ISpaceQuery<T> template, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case there was no match). Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- A query to be executed against the space. Most common one is SQLQuery
.listener
- A listener to be notified when a result arrives.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(ISpaceQuery<T> template, long timeout) throws org.springframework.dao.DataAccessException
null
in case there was no match).template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
entry. A timeout of 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(ISpaceQuery<T> template, long timeout, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case there was no match).template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
entry. A timeout of 0 means to wait no time at all.listener
- A listener to be notified when a result arrives.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(ISpaceQuery<T> template, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
in case there was no match).template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
entry. A timeout of 0 means to wait no time at all.modifiers
- one or a union of TakeModifiers
.org.springframework.dao.DataAccessException
<T> AsyncFuture<T> asyncTake(ISpaceQuery<T> template, long timeout, TakeModifiers modifiers, AsyncFutureListener<T> listener) throws org.springframework.dao.DataAccessException
null
in case there was no match).template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
entry. A timeout of 0 means to wait no time at all.modifiers
- one or a union of TakeModifiers
.listener
- A listener to be notified when a result arrives.org.springframework.dao.DataAccessException
<T> T takeIfExistsById(Class<T> clazz, Object id) throws org.springframework.dao.DataAccessException
null
if there is no match. Matching and timeouts are done as in
takeById
, except that blocking in this call is done only if necessary to wait
for transactional state to settle.
The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
Note, if the space is
partitioned, and the Entry has a specific property for its routing value, the operation will
broadcast to all partitions. The takeById(Class, Object, Object)
can be used to
specify the routing.
clazz
- The class of the entryid
- The id of the entrynull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeIfExistsById(Class<T> clazz, Object id, Object routing) throws org.springframework.dao.DataAccessException
null
if there is no match. Matching and timeouts are done as in
takeById
, except that blocking in this call is done only if necessary to wait
for transactional state to settle.
The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeIfExistsById(Class<T> clazz, Object id, Object routing, long timeout) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout. Matching
and timeouts are done as in takeById
, except that blocking in this call is done
only if necessary to wait for transactional state to settle.
clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuetimeout
- The timeout value to wait for a matching entry if it does not exists within
the spacenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeIfExistsById(Class<T> clazz, Object id, Object routing, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout. Matching
and timeouts are done as in takeById
, except that blocking in this call is done
only if necessary to wait for transactional state to settle.
clazz
- The class of the entryid
- The id of the entryrouting
- The routing valuetimeout
- The timeout value to wait for a matching entry if it does not exists within
the spacemodifiers
- one or a union of TakeModifiers
.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeIfExistsById(IdQuery<T> query) throws org.springframework.dao.DataAccessException
null
if there is no match. The timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
Note, if the
space is partitioned, and the Entry has a specific property for its routing value, the
operation will broadcast to all partitions. The readById(Class, Object, Object)
can
be used to specify the routing.
Matching and timeouts are done as in
readById
, except that blocking in this call is done only if necessary to wait
for transactional state to settle.
query
- Query to search by.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeIfExistsById(IdQuery<T> query, long timeout) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout. Matching and
timeouts are done as in readById
, except that blocking in this call is done only
if necessary to wait for transactional state to settle.
query
- Query to search by.timeout
- The timeout value to wait for a matching entry if it does not exists within
the spacenull
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeIfExistsById(IdQuery<T> query, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there is no match within the specified timeout. Matching and
timeouts are done as in readById
, except that blocking in this call is done only
if necessary to wait for transactional state to settle.
query
- Query to search by.timeout
- The timeout value to wait for a matching entry if it does not exists within
the spacemodifiers
- one or a union of TakeModifiers
.null
if no matching is found within the timeout
value.org.springframework.dao.DataAccessException
<T> T takeIfExists(T template) throws org.springframework.dao.DataAccessException
null
if there
currently is none. Matching and timeouts are done as in take
, except that
blocking in this call is done only if necessary to wait for transactional state to settle.
Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- The template used for matching. Matching is done against the template with
null
fields being wildcards ( "match anything") other fields
being values ("match exactly on the serialized form").org.springframework.dao.DataAccessException
<T> T takeIfExists(T template, long timeout) throws org.springframework.dao.DataAccessException
null
if there
currently is none. Matching and timeouts are done as in take
, except that
blocking in this call is done only if necessary to wait for transactional state to settle.template
- The template used for matching. Matching is done against the 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 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> T takeIfExists(T template, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there
currently is none. Matching and timeouts are done as in take
, except that
blocking in this call is done only if necessary to wait for transactional state to settle.template
- The template used for matching. Matching is done against the 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 0 means to wait no time at all.modifiers
- one or a union of TakeModifiers
.org.springframework.dao.DataAccessException
<T> T takeIfExists(ISpaceQuery<T> template) throws org.springframework.dao.DataAccessException
null
if there
currently is none. Matching and timeouts are done as in take
, except that
blocking in this call is done only if necessary to wait for transactional state to settle.
Note, the timeout is the default timeout this interface is configured with (using its factory) and defaults to 0.
template
- A query to be executed against the space. Most common one is SQLQuery
.org.springframework.dao.DataAccessException
<T> T takeIfExists(ISpaceQuery<T> template, long timeout) throws org.springframework.dao.DataAccessException
null
if there
currently is none. Matching and timeouts are done as in take
, except that
blocking in this call is done only if necessary to wait for transactional state to settle.template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
entry. A timeout of 0 means to wait no time at all.org.springframework.dao.DataAccessException
<T> T takeIfExists(ISpaceQuery<T> template, long timeout, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
null
if there
currently is none. Matching and timeouts are done as in take
, except that
blocking in this call is done only if necessary to wait for transactional state to settle.template
- A query to be executed against the space. Most common one is SQLQuery
.timeout
- How long the client is willing to wait for a transactionally proper matching
entry. A timeout of 0 means to wait no time at all.modifiers
- one or a union of TakeModifiers
.org.springframework.dao.DataAccessException
<T> T[] takeMultiple(T template) throws org.springframework.dao.DataAccessException
takeMultiple(template, Integer.MAX_VALUE)
.template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classesorg.springframework.dao.DataAccessException
- In the event of a take error, DataAccessException will wrap a
TakeMultipleException, accessible via DataAccessException.getRootCause().<T> T[] takeMultiple(T template, int maxEntries) throws org.springframework.dao.DataAccessException
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can
also be one of the different ISpaceQuery
classesmaxEntries
- A limit on the number of entries to be returned. Use Integer.MAX_VALUE
for the uppermost limit.org.springframework.dao.DataAccessException
- In the event of a take error, DataAccessException will wrap a
TakeMultipleException, accessible via DataAccessException.getRootCause().<T> T[] takeMultiple(T template, int maxEntries, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can
also be one of the different ISpaceQuery
classesmaxEntries
- A limit on the number of entries to be returned. Use Integer.MAX_VALUE
for the uppermost limit.modifiers
- one or a union of TakeModifiers
.org.springframework.dao.DataAccessException
- In the event of a take error, DataAccessException will wrap a
TakeMultipleException, accessible via DataAccessException.getRootCause().<T> T[] takeMultiple(ISpaceQuery<T> template) throws org.springframework.dao.DataAccessException
template
- A query to be executed against the space. Most common one is SQLQuery
.org.springframework.dao.DataAccessException
- In the event of a take error, DataAccessException will wrap a
TakeMultipleException, accessible via DataAccessException.getRootCause().<T> T[] takeMultiple(ISpaceQuery<T> template, int maxEntries) throws org.springframework.dao.DataAccessException
template
- A query to be executed against the space. Most common one is SQLQuery
.maxEntries
- A limit on the number of entries to be returned. Use Integer.MAX_VALUE
for the uppermost limit.org.springframework.dao.DataAccessException
- In the event of a take error, DataAccessException will wrap a
TakeMultipleException, accessible via DataAccessException.getRootCause().<T> T[] takeMultiple(ISpaceQuery<T> template, int maxEntries, TakeModifiers modifiers) throws org.springframework.dao.DataAccessException
template
- A query to be executed against the space. Most common one is SQLQuery
.maxEntries
- A limit on the number of entries to be returned. Use Integer.MAX_VALUE
for the uppermost limit.modifiers
- one or a union of TakeModifiers
.org.springframework.dao.DataAccessException
- In the event of a take error, DataAccessException will wrap a
TakeMultipleException, accessible via DataAccessException.getRootCause().<T> LeaseContext<T> write(T entry) throws org.springframework.dao.DataAccessException
LeaseContext
.
By default uses the WriteModifiers.UPDATE_OR_WRITE
modifier (see write(Object, long, long, WriteModifiers)
. In order to force the operation to perform "write" only (a
bit more performant), the WriteModifiers.WRITE_ONLY
modifier can be used resulting in
an EntryAlreadyInSpaceException
if the entry already exists in
the space (it must have an id for this exception to be raised).
If the object has a
primary key that isn't auto - generated, and the modifiers value is one of WriteModifiers.UPDATE_OR_WRITE
, WriteModifiers.UPDATE_ONLY
or WriteModifiers.PARTIAL_UPDATE
, it will call to the update method, returning a LeaseContext
holder. This lease is unknown to the grantor, unless an actual 'write' was performed.
The entry will be written using the default lease this interface is configured with (using
the its factory). In order to explicitly define the lease, please use write(Object,
long)
.
entry
- The entry to write to the spaceLease
on a successful write, or null
if performed
with the proxy configured with NoWriteLease flag. when WriteModifiers.UPDATE_OR_WRITE
modifier is applied, LeaseContext.getObject()
returns
null
on a successful write or the previous value - on successful update (Only if
WriteModifiers.RETURN_PREV_ON_UPDATE
is used, otherwise null). UpdateOperationTimeoutException
is thrown if timeout occurred while
trying to update the object.
org.springframework.dao.DataAccessException
<T> LeaseContext<T> write(T entry, long lease) throws org.springframework.dao.DataAccessException
LeaseContext
.
By default uses the WriteModifiers.UPDATE_OR_WRITE
modifier (see write(Object, long, long, WriteModifiers)
. In order to force the operation to perform "write" only (a
bit more performant), the WriteModifiers.WRITE_ONLY
modifier can be used resulting in
an EntryAlreadyInSpaceException
if the entry already exists in
the space (it must have an id for this exception to be raised).
If the object has a
primary key that isn't auto - generated, and the modifiers value is one of WriteModifiers.UPDATE_OR_WRITE
, WriteModifiers.UPDATE_ONLY
or WriteModifiers.PARTIAL_UPDATE
, it will call to the update method, returning a LeaseContext
holder. This lease is unknown to the grantor, unless an actual 'write' was performed.
entry
- The entry to write to the spacelease
- The lease the entry will be written with, in milliseconds.Lease
on a successful write, or null
if performed
with the proxy configured with NoWriteLease flag. when WriteModifiers.UPDATE_OR_WRITE
modifier is applied, LeaseContext.getObject()
returns
null
on a successful write or the previous value - on successful update (Only if
WriteModifiers.RETURN_PREV_ON_UPDATE
is used, otherwise null). UpdateOperationTimeoutException
is thrown if timeout occurred while
trying to update the object.
org.springframework.dao.DataAccessException
<T> LeaseContext<T> write(T entry, WriteModifiers modifiers) throws org.springframework.dao.DataAccessException
LeaseContext
.
By default uses the WriteModifiers.UPDATE_OR_WRITE
modifier (see write(Object, long, long, WriteModifiers)
. In order to force the operation to perform "write" only (a
bit more performant), the WriteModifiers.WRITE_ONLY
modifier can be used resulting in
an EntryAlreadyInSpaceException
if the entry already exists in
the space (it must have an id for this exception to be raised).
If the object has a
primary key that isn't auto - generated, and the modifiers value is one of WriteModifiers.UPDATE_OR_WRITE
, WriteModifiers.UPDATE_ONLY
or WriteModifiers.PARTIAL_UPDATE
, it will call to the update method, returning a LeaseContext
holder. This lease is unknown to the grantor, unless an actual 'write' was performed.
The entry will be written using the default lease this interface is configured with (using
the its factory). In order to explicitly define the lease, please use write(Object,
long)
.
entry
- The entry to write to the spacemodifiers
- one or a union of WriteModifiers
.Lease
on a successful write, or null
if performed
with the proxy configured with NoWriteLease flag. when WriteModifiers.UPDATE_OR_WRITE
modifier is applied, LeaseContext.getObject()
returns
null
on a successful write or the previous value - on successful update (Only if
WriteModifiers.RETURN_PREV_ON_UPDATE
is used, otherwise null). UpdateOperationTimeoutException
is thrown if timeout occurred while
trying to update the object.
org.springframework.dao.DataAccessException
<T> LeaseContext<T> write(T entry, long lease, long timeout, WriteModifiers modifiers) throws org.springframework.dao.DataAccessException
LeaseContext
.
By default uses the WriteModifiers.UPDATE_OR_WRITE
modifier.
In order to force the operation to perform "write" only (a bit more performant), the WriteModifiers.WRITE_ONLY
modifier can be used resulting in an EntryAlreadyInSpaceException
if the entry already exists in the space
(it must have an id for this exception to be raised).
If the object has a primary key
that isn't auto - generated, and the modifiers value is one of WriteModifiers.UPDATE_OR_WRITE
, WriteModifiers.UPDATE_ONLY
or WriteModifiers.PARTIAL_UPDATE
, it will call to the update method, returning a LeaseContext
holder. This lease is unknown to the grantor, unless an actual 'write' was performed.
entry
- The entry to write to the spacelease
- The lease the entry will be written with, in milliseconds.timeout
- The timeout of an update operation, in milliseconds. If the entry is
locked by another transaction wait for the specified number of milliseconds
for it to be released.modifiers
- one or a union of WriteModifiers
.Lease
on a successful write, or null
if performed
with the proxy configured with NoWriteLease flag. when WriteModifiers.UPDATE_OR_WRITE
modifier is applied, LeaseContext.getObject()
returns
null
on a successful write or the previous value - on successful update (Only if
WriteModifiers.RETURN_PREV_ON_UPDATE
is used, otherwise null). UpdateOperationTimeoutException
is thrown if timeout occurred while
trying to update the object.
org.springframework.dao.DataAccessException
<T> LeaseContext<T>[] writeMultiple(T[] entries) throws org.springframework.dao.DataAccessException
The entry will be written using the
default lease this interface is configured with (using the its factory). In order to
explicitly define the lease, please use writeMultiple(Object[], long)
.
entries
- The entries to write to the space.org.springframework.dao.DataAccessException
- In the event of a write error, DataAccessException will wrap a
WriteMultipleException, accessible via DataAccessException.getRootCause().<T> LeaseContext<T>[] writeMultiple(T[] entries, long lease) throws org.springframework.dao.DataAccessException
entries
- The entries to write to the space.lease
- The lease the entry will be written with, in milliseconds.org.springframework.dao.DataAccessException
- In the event of a write error, DataAccessException will wrap a
WriteMultipleException, accessible via DataAccessException.getRootCause().<T> LeaseContext<T>[] writeMultiple(T[] entries, WriteModifiers modifiers) throws org.springframework.dao.DataAccessException
entries
- The entries to write to the space.modifiers
- one or a union of WriteModifiers
.org.springframework.dao.DataAccessException
- In the event of a write error, DataAccessException will wrap a
WriteMultipleException, accessible via DataAccessException.getRootCause().<T> LeaseContext<T>[] writeMultiple(T[] entries, long lease, WriteModifiers modifiers) throws org.springframework.dao.DataAccessException
'returns'
for
possible return values.entries
- the entries to write.lease
- the requested lease time, in millisecondsmodifiers
- one or a union of WriteModifiers
.Lease
on a successful write, or
null
if performed with NoWriteLease attribute. when WriteModifiers.UPDATE_OR_WRITE
modifier is applied,
LeaseContext.getObject()
returns: WriteModifiers.RETURN_PREV_ON_UPDATE
is used, otherwise
null) org.springframework.dao.DataAccessException
- In the event of a write error, DataAccessException will wrap a
WriteMultipleException, accessible via DataAccessException.getRootCause().<T> LeaseContext<T>[] writeMultiple(T[] entries, long lease, long timeout, WriteModifiers modifiers) throws org.springframework.dao.DataAccessException
'returns'
for
possible return values.entries
- the entries to write.lease
- the requested lease time, in millisecondstimeout
- The timeout of the update operations, in milliseconds. If entries are
locked by another transactionmodifiers
- one or a union of WriteModifiers
.Lease
on a successful write, or
null
if performed with NoWriteLease attribute. when WriteModifiers.UPDATE_OR_WRITE
modifier is applied,
LeaseContext.getObject()
returns: WriteModifiers.RETURN_PREV_ON_UPDATE
is used, otherwise
null) org.springframework.dao.DataAccessException
- In the event of a write error, DataAccessException will wrap a
WriteMultipleException, accessible via DataAccessException.getRootCause().<T> LeaseContext<T>[] writeMultiple(T[] entries, long[] leases, WriteModifiers modifiers) throws org.springframework.dao.DataAccessException
'returns'
for
possible return values.entries
- the entries to write.leases
- the requested lease time per entry, in millisecondsmodifiers
- one or a union of WriteModifiers
.Lease
on a successful write, or
null
if performed with NoWriteLease attribute. when WriteModifiers.UPDATE_OR_WRITE
modifier is applied,
LeaseContext.getObject()
returns: WriteModifiers.RETURN_PREV_ON_UPDATE
is used, otherwise
null) org.springframework.dao.DataAccessException
- In the event of a write error, DataAccessException will wrap a
WriteMultipleException, accessible via DataAccessException.getRootCause().<T> LeaseContext<T>[] writeMultiple(T[] entries, long[] leases, long timeout, WriteModifiers modifiers) throws org.springframework.dao.DataAccessException
'returns'
for
possible return values.entries
- the entries to write.leases
- the requested lease time per entry, in millisecondstimeout
- The timeout of the update operations, in milliseconds. If entries are
locked by another transactionmodifiers
- one or a union of WriteModifiers
.Lease
on a successful write, or
null
if performed with NoWriteLease attribute. when WriteModifiers.UPDATE_OR_WRITE
modifier is applied,
LeaseContext.getObject()
returns: WriteModifiers.RETURN_PREV_ON_UPDATE
is used, otherwise
null) org.springframework.dao.DataAccessException
- In the event of a write error, DataAccessException will wrap a
WriteMultipleException, accessible via DataAccessException.getRootCause().<T> SpaceIterator<T> iterator(T template)
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classes<T> SpaceIterator<T> iterator(T template, int batchSize)
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classesbatchSize
- Maximum number of entries to fetch on each batch.<T> SpaceIterator<T> iterator(T template, int batchSize, ReadModifiers modifiers)
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classesbatchSize
- Maximum number of entries to fetch on each batch.modifiers
- one or a union of ReadModifiers
.<T> SpaceIterator<T> iterator(T template, SpaceIteratorConfiguration spaceIteratorConfiguration)
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classesspaceIteratorConfiguration
- SpaceIteratorConfiguration
.<T> SpaceIterator<T> iterator(ISpaceQuery<T> template)
template
- A query to be executed against the space. Most common one is SQLQuery
.<T> SpaceIterator<T> iterator(ISpaceQuery<T> template, int batchSize)
template
- A query to be executed against the space. Most common one is SQLQuery
.batchSize
- Maximum number of entries to fetch on each batch.<T> SpaceIterator<T> iterator(ISpaceQuery<T> template, int batchSize, ReadModifiers modifiers)
template
- A query to be executed against the space. Most common one is SQLQuery
.batchSize
- Maximum number of entries to fetch on each batch.modifiers
- one or a union of ReadModifiers
.<T> SpaceIterator<T> iterator(ISpaceQuery<T> template, SpaceIteratorConfiguration spaceIteratorConfiguration)
template
- A query to be executed against the space. Most common one is SQLQuery
.spaceIteratorConfiguration
- SpaceIteratorConfiguration
.<T extends Serializable> AsyncFuture<T> execute(Task<T> task)
SpaceRouting
. In order to control the routing
externally, use execute(org.openspaces.core.executor.Task, Object)
.
The
space that the task is executed within can be accessible by marking a field with type GigaSpace
using the TaskGigaSpace
annotation. Another option is by implementing the TaskGigaSpaceAware
interface.
Resource injection can be enabled by marking the task with AutowireTask
or with AutowireTaskMarker
.
Resources defined within processing unit (space node) the task is executed on are accessible
by using either the Autowired
or
javax.annotation.Resource annotations (assuming they are enabled using
context:annotation-config
). Bean life cycle methods, such as ClusterInfoAware
and ApplicationContextAware
are also available.
task
- The task to executeget()
method will return the task value upon completion.<T extends Serializable> AsyncFuture<T> execute(Task<T> task, AsyncFutureListener<T> listener)
SpaceRouting
. In order to control the routing
externally, use execute(org.openspaces.core.executor.Task, Object)
.
The
space that the task is executed within can be accessible by marking a field with type GigaSpace
using the TaskGigaSpace
annotation. Another option is by implementing the TaskGigaSpaceAware
interface.
Resource injection can be enabled by marking the task with AutowireTask
or with AutowireTaskMarker
.
Resources defined within processing unit (space node) the task is executed on are accessible
by using either the Autowired
or
javax.annotation.Resource annotations (assuming they are enabled using
context:annotation-config
). Bean life cycle methods, such as ClusterInfoAware
and ApplicationContextAware
are also available.
task
- The task to executelistener
- A listener to be notified when execution completesget()
method will return the task value upon completion.<T extends Serializable> AsyncFuture<T> execute(Task<T> task, Object routing)
The routing object
itself does not have to be the actual routing value, but can be a POJO that defined a method
annotated with @SpaceRouting
annotation (this works well when wanting to use
entries as the routing parameters).
In order to control the using the Task itself,
use execute(org.openspaces.core.executor.Task)
.
The space that the task is
executed within can be accessible by marking a field with type GigaSpace
using the TaskGigaSpace
annotation. Another option is by implementing the TaskGigaSpaceAware
interface.
Resource injection can be enabled by marking the task with AutowireTask
or with AutowireTaskMarker
.
Resources defined within processing unit (space node) the task is executed on are accessible
by using either the Autowired
or
javax.annotation.Resource annotations (assuming they are enabled using
context:annotation-config
). Bean life cycle methods, such as ClusterInfoAware
and ApplicationContextAware
are also available.
task
- The task to executerouting
- The routing value that will control on which node the task will be executed
onget()
method will return the task value upon completion.<T extends Serializable> AsyncFuture<T> execute(Task<T> task, Object routing, AsyncFutureListener<T> listener)
The routing object
itself does not have to be the actual routing value, but can be a POJO that defined a method
annotated with @SpaceRouting
annotation (this works well when wanting to use
entries as the routing parameters).
In order to control the using the Task itself,
use execute(org.openspaces.core.executor.Task)
.
The space that the task is
executed within can be accessible by marking a field with type GigaSpace
using the TaskGigaSpace
annotation. Another option is by implementing the TaskGigaSpaceAware
interface.
Resource injection can be enabled by marking the task with AutowireTask
or with AutowireTaskMarker
.
Resources defined within processing unit (space node) the task is executed on are accessible
by using either the Autowired
or
javax.annotation.Resource annotations (assuming they are enabled using
context:annotation-config
). Bean life cycle methods, such as ClusterInfoAware
and ApplicationContextAware
are also available.
task
- The task to executerouting
- The routing value that will control on which node the task will be executed
onlistener
- A listener to be notified when execution completesget()
method will return the task value upon completion.<T extends Serializable,R> AsyncFuture<R> execute(DistributedTask<T,R> task, Object... routing)
AsyncResultsReducer.reduce(java.util.List)
operation. The
routing object itself does not have to be the actual routing value, but can be a POJO that
defined a method annotated with @SpaceRouting
annotation (this works well when
wanting to use entries as the routing parameters).
The task can optionally implement
AsyncResultFilter
that can control if tasks should continue to
accumulate or it should break and execute the reduce operation on the results received so
far.
The future actual result will be the reduced result of the execution, or the exception thrown during during the reduce operation. The moderator can be used as a mechanism to listen for results as they arrive.
The last parameter can be of type AsyncFutureListener
which, this case, it will be used to register a
listener to be notified of the result.
The space that the task is executed within can
be accessible by marking a field with type GigaSpace
using the
TaskGigaSpace
annotation. Another option is by
implementing the TaskGigaSpaceAware
interface.
Resource injection can be enabled by marking the task with AutowireTask
or with AutowireTaskMarker
.
Resources defined within processing unit (space node) the task is executed on are accessible
by using either the Autowired
or
javax.annotation.Resource annotations (assuming they are enabled using
context:annotation-config
). Bean life cycle methods, such as ClusterInfoAware
and ApplicationContextAware
are also available.
task
- The task to executerouting
- A list of routing values, each resulting in an execution of the task on the
space node it corresponds toget()
method will return the task value upon completion.<T extends Serializable,R> AsyncFuture<R> execute(DistributedTask<T,R> task)
AsyncResultsReducer.reduce(java.util.List)
operation. The
task can optionally implement AsyncResultFilter
that can control
if tasks should continue to accumulate or it should break and execute the reduce operation on
the results received so far.
The future actual result will be the reduced result of the execution, or the exception thrown during during the reduce operation. The moderator can be used as a mechanism to listen for results as they arrive.
The space that the task
is executed within can be accessible by marking a field with type GigaSpace
using the TaskGigaSpace
annotation. Another option is by implementing the TaskGigaSpaceAware
interface.
Resource injection can be enabled by marking the task with AutowireTask
or with AutowireTaskMarker
.
Resources defined within processing unit (space node) the task is executed on are accessible
by using either the Autowired
or
javax.annotation.Resource annotations (assuming they are enabled using
context:annotation-config
). Bean life cycle methods, such as ClusterInfoAware
and ApplicationContextAware
are also available.
task
- The task to executeget()
method will return the task value upon completion.<T extends Serializable,R> ExecutorBuilder<T,R> executorBuilder(AsyncResultsReducer<T,R> reducer)
The reducer can optionally implement AsyncResultFilter
that
can control if tasks should continue to accumulate or it should break and execute the reduce
operation on the results received so far.
The space that the task is executed within
can be accessible by marking a field with type GigaSpace
using
the TaskGigaSpace
annotation. Another option is by
implementing the TaskGigaSpaceAware
interface.
Resource injection can be enabled by marking the task with AutowireTask
or with AutowireTaskMarker
.
Resources defined within processing unit (space node) the task is executed on are accessible
by using either the Autowired
or
javax.annotation.Resource annotations (assuming they are enabled using
context:annotation-config
). Bean life cycle methods, such as ClusterInfoAware
and ApplicationContextAware
are also available.
reducer
- The reducer to reduce the results of all the different tasks added.GigaSpaceTypeManager getTypeManager()
GigaSpaceTypeManager
<T> AggregationResult aggregate(ISpaceQuery<T> query, AggregationSet aggregationSet)
query
- Query to search byaggregationSet
- aggregations to executeQueryExtension
<T> ChangeResult<T> change(ISpaceQuery<T> query, ChangeSet changeSet)
Modifiers can be used to specify behavior of the change operation, by default uses the
ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.ChangeResult
containing the details of the change operation affect.ChangeException
- In event of a change error.ChangeExtension
<T> ChangeResult<T> change(ISpaceQuery<T> query, ChangeSet changeSet, long timeout)
Modifiers can be used to specify behavior of the change operation, by default uses the
ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.ChangeResult
containing the details of the change operation affect.ChangeException
- In event of a change error.ChangeExtension
<T> ChangeResult<T> change(ISpaceQuery<T> query, ChangeSet changeSet, ChangeModifiers modifiers)
Modifiers can be used to specify behavior of the change operation, by default uses the
ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
ChangeResult
containing the details of the change operation affect.ChangeException
- In event of a change error.ChangeExtension
<T> ChangeResult<T> change(ISpaceQuery<T> query, ChangeSet changeSet, ChangeModifiers modifiers, long timeout)
Modifiers can be used to specify behavior of the change operation, by default uses the
ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.ChangeResult
containing the details of the change operation affect.ChangeException
- In event of a change error.ChangeExtension
<T> Future<ChangeResult<T>> asyncChange(ISpaceQuery<T> query, ChangeSet changeSet)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.ChangeException
- In event of a change error.ChangeExtension
<T> Future<ChangeResult<T>> asyncChange(ISpaceQuery<T> query, ChangeSet changeSet, AsyncFutureListener<ChangeResult<T>> listener)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.listener
- A listener to be notified when a result arrives.ChangeException
- In event of a change error.ChangeExtension
<T> Future<ChangeResult<T>> asyncChange(ISpaceQuery<T> query, ChangeSet changeSet, long timeout)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.ChangeException
- In event of a change error.ChangeExtension
<T> Future<ChangeResult<T>> asyncChange(ISpaceQuery<T> query, ChangeSet changeSet, long timeout, AsyncFutureListener<ChangeResult<T>> listener)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.listener
- A listener to be notified when a result arrives.ChangeException
- In event of a change error.ChangeExtension
<T> Future<ChangeResult<T>> asyncChange(ISpaceQuery<T> query, ChangeSet changeSet, ChangeModifiers modifiers)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
ChangeException
- In event of a change error.ChangeExtension
<T> Future<ChangeResult<T>> asyncChange(ISpaceQuery<T> query, ChangeSet changeSet, ChangeModifiers modifiers, AsyncFutureListener<ChangeResult<T>> listener)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
listener
- A listener to be notified when a result arrives.ChangeException
- In event of a change error.ChangeExtension
<T> Future<ChangeResult<T>> asyncChange(ISpaceQuery<T> query, ChangeSet changeSet, ChangeModifiers modifiers, long timeout)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.ChangeException
- In event of a change error.ChangeExtension
<T> Future<ChangeResult<T>> asyncChange(ISpaceQuery<T> query, ChangeSet changeSet, ChangeModifiers modifiers, long timeout, AsyncFutureListener<ChangeResult<T>> listener)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
query
- Query to search by.changeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.listener
- A listener to be notified when a result arrives.ChangeException
- In event of a change error.ChangeExtension
<T> ChangeResult<T> change(T template, ChangeSet changeSet)
Modifiers can be used to specify behavior of the change operation, by default uses the
ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.ChangeResult
containing the details of the change operation affect.ChangeException
- In event of a change error.<T> ChangeResult<T> change(T template, ChangeSet changeSet, long timeout)
Modifiers can be used to specify behavior of the change operation, by default uses the
ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.ChangeResult
containing the details of the change operation affect.ChangeException
- In event of a change error.<T> ChangeResult<T> change(T template, ChangeSet changeSet, ChangeModifiers modifiers)
Modifiers can be used to specify behavior of the change operation, by default uses the
ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
ChangeResult
containing the details of the change operation affect.ChangeException
- In event of a change error.<T> ChangeResult<T> change(T template, ChangeSet changeSet, ChangeModifiers modifiers, long timeout)
Modifiers can be used to specify behavior of the change operation, by default uses the
ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.ChangeResult
containing the details of the change operation affect.ChangeException
- In event of a change error.<T> Future<ChangeResult<T>> asyncChange(T template, ChangeSet changeSet)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.ChangeException
- Arrived asynchronously in event of a change error, via future or
listener.<T> Future<ChangeResult<T>> asyncChange(T template, ChangeSet changeSet, AsyncFutureListener<ChangeResult<T>> listener)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.listener
- A listener to be notified when a result arrives.ChangeException
- Arrived asynchronously in event of a change error, via future or
listener.<T> Future<ChangeResult<T>> asyncChange(T template, ChangeSet changeSet, long timeout)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.ChangeException
- Arrived asynchronously in event of a change error, via future or
listener.<T> Future<ChangeResult<T>> asyncChange(T template, ChangeSet changeSet, long timeout, AsyncFutureListener<ChangeResult<T>> listener)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.listener
- A listener to be notified when a result arrives.ChangeException
- Arrived asynchronously in event of a change error, via future or
listener.<T> Future<ChangeResult<T>> asyncChange(T template, ChangeSet changeSet, ChangeModifiers modifiers)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
ChangeException
- Arrived asynchronously in event of a change error, via future or
listener.<T> Future<ChangeResult<T>> asyncChange(T template, ChangeSet changeSet, ChangeModifiers modifiers, AsyncFutureListener<ChangeResult<T>> listener)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
listener
- A listener to be notified when a result arrives.ChangeException
- Arrived asynchronously in event of a change error, via future or
listener.<T> Future<ChangeResult<T>> asyncChange(T template, ChangeSet changeSet, ChangeModifiers modifiers, long timeout)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.ChangeException
- Arrived asynchronously in event of a change error, via future or
listener.<T> Future<ChangeResult<T>> asyncChange(T template, ChangeSet changeSet, ChangeModifiers modifiers, long timeout, AsyncFutureListener<ChangeResult<T>> listener)
Modifiers can be used to specify behavior of the change operation, by default
uses the ChangeModifiers.NONE
modifier.
template
- The template used for matching. Matching is done against the template with
null
fields being. wildcards ("match anything") other fields
being values ("match exactly on the serialized form"). The template can also
be one of the different ISpaceQuery
classeschangeSet
- Changes to apply to the matched entry.modifiers
- one or a union of ChangeModifiers
timeout
- The timeout of the operation, in milliseconds. If the entry is locked
by another transaction wait for the specified number of milliseconds for it
to be released.listener
- A listener to be notified when a result arrives.ChangeException
- Arrived asynchronously in event of a change error, via future or
listener.DataEventSession newDataEventSession()
DataEventSession newDataEventSession(EventSessionConfig config)
config
- The configuration settings for the new data event session.void setQuiesceToken(QuiesceToken token)
<T> ISpaceQuery<T> prepareTemplate(Object template)
template
- to be translated into ISpaceQuery
ISpaceQuery
which represents the
translated templatesnapshot(Object)
AsyncFuture<SpaceDataSourceLoadResult> asyncLoad(SpaceDataSourceLoadRequest spaceDataSourceLoadRequest)
SpaceDataSource
on demand
The Space data source is created with SpaceDataSourceFactory
Loaded data can be adapted using the SpaceTypeSchemaAdapter
spaceDataSourceLoadRequest
- SpaceDataSourceLoadRequest
Copyright © GigaSpaces.