Space

Method Summary

Methods
Modifier and Type	Method and Description
`Browser`	`browse(BrowserDef.BrowserType browserType)` Creates a Browser object which can be used to perform operations on multiple entries in a Space.
`Browser`	`browse(BrowserDef.BrowserType browserType, BrowserDef browserDef)` Creates a Browser object which can be used to perform operations on multiple entries in a Space.
`Browser`	`browse(BrowserDef.BrowserType browserType, BrowserDef browserDef, java.lang.String filter)` Creates a Browser object which can be used to perform operations on multiple entries in a Space which match the specified filter.
`EventBrowser`	`browseEvents(EventBrowserDef eventBrowserDef)` Creates an EventBrowser object which can be used to retrieve and iterate over events that occur in a Space.
`EventBrowser`	`browseEvents(EventBrowserDef eventBrowserDef, java.lang.String filter)` Creates an EventBrowser object which can be used to retrieve and iterate over the events that occur in a Space and that match the specified filter.
`void`	`clear()` Deletes all tuples in the Space.
`void`	`clear(java.lang.String filter)` Deletes from the Space the tuples that match the specified filter on a "best effort" basis.
`void`	`close()` Invalidates this Space reference with the distribution role it initialized with.
`void`	`closeAll()` Forcefully leaves the Space and stops and invalidates any existing listeners and browsers created on the Space.
`Tuple`	`compareAndPut(Tuple oldTuple, Tuple newTuple)` Used to replace an the values of an existing entry with new values as long as the existing entry has not been modified and still matches the values in `oldTuple`.
`Tuple`	`compareAndPut(Tuple oldTuple, Tuple newTuple, PutOptions putOptions)` Same as `compareAndPut(com.tibco.as.space.Tuple, com.tibco.as.space.Tuple)` with PutOptions to specify custom lock wait, lock/unlock options.
`SpaceResultList`	`compareAndPutAll(java.util.Collection<Tuple> oldTuples, java.util.Collection<Tuple> newTuples)` Batch compareAndPut operation.
`SpaceResultList`	`compareAndPutAll(java.util.Collection<Tuple> oldTuples, java.util.Collection<Tuple> newTuples, java.util.Collection<PutOptions> optionsCollection)` Batch compareAndPut operation with a collection of PutOptions
`SpaceResultList`	`compareAndPutAll(java.util.Collection<Tuple> oldTuples, java.util.Collection<Tuple> newTuples, PutOptions putOptions)` Batch compareAndPut operation with PutOptions.
`Tuple`	`compareAndTake(Tuple oldTuple)` Removes the entry from the Space which matches the Tuple passed into the method.
`Tuple`	`compareAndTake(Tuple oldTuple, TakeOptions takeOptions)` Removes the entry from the Space which matches the Tuple passed into the method.
`SpaceResultList`	`compareAndTakeAll(java.util.Collection<Tuple> oldTuples)` Batch compareAndTake operation.
`SpaceResultList`	`compareAndTakeAll(java.util.Collection<Tuple> oldTuples, TakeOptions takeOptions)` Batch compareAndTake operation with TakeOptions.
`java.lang.String`	`explainQuery(java.lang.String filter)` Returns A string that describes the cost of the query execution in each seeder
`Tuple`	`get(Tuple tuple)` Retrieve the entry stored in the Space with the key specified in the given Tuple.
`Tuple`	`get(Tuple tuple, GetOptions options)`
`SpaceResultList`	`getAll(java.util.Collection<Tuple> tuples)` Batch get operation.
`java.util.Collection<Member>`	`getLeeches()` Returns the collection of @Member of the space with leech role
`java.util.Collection<Member>`	`getMembers()` Returns the collection of @Member of the space
`Metaspace`	`getMetaspace()` Retrieve the Metaspace object the Space belongs to.
`java.lang.String`	`getMetaspaceName()` Retrieve the name of the Metaspace that the Space belongs to.
`java.lang.String`	`getName()` Returns the name of the Space.
`java.util.Collection<Member>`	`getRemoteMembers()` Returns the collection of @Member of the space connected using remote client
`java.util.Collection<Member>`	`getSeeders()` Returns the collection of @Member of the space with seeder role
`SpaceDef`	`getSpaceDef()` Retrieve the attributes used to create the Space.
`SpaceDef.SpaceState`	`getSpaceState()` Retrieve the state of the Space.
`InvokeResult`	`invoke(Tuple keyTuple, java.lang.Class<? extends Invocable> cls, Tuple contextTuple)` Deprecated.
`InvokeResult`	`invoke(Tuple tuple, InvokeOptions options)` Deprecated. Use `invoke(Tuple, String, InvokeOptions)`
`InvokeResult`	`invoke(Tuple tuple, java.lang.String invocable, InvokeOptions options)` Causes execution of the `invoke` method from the specified class on the Member of the Space where the entry associated with the key specified in `tuple` is stored.
`InvokeResult`	`invoke(Tuple keyTuple, java.lang.String invocable, Tuple contextTuple)` Deprecated.
`InvokeResultList`	`invokeLeeches(InvokeOptions invokeOptions)` Deprecated.
`InvokeResultList`	`invokeLeeches(java.lang.String invocable, InvokeOptions invokeOptions)` Invokes in parallel the appropriate `invoke` method of the specified class on all of the members of the Space which have a distribution role of leech.
`InvokeResult`	`invokeMember(Member member, java.lang.Class<? extends MemberInvocable> cls, Tuple contextTuple)` Deprecated.
`InvokeResult`	`invokeMember(Member member, InvokeOptions options)` Deprecated.
`InvokeResult`	`invokeMember(Member member, java.lang.String invocable, InvokeOptions options)` Causes execution of the `invoke` method of the specified class on the specific Member of the Space passed as an argument.
`InvokeResult`	`invokeMember(Member member, java.lang.String invocable, Tuple contextTuple)` Deprecated.
`InvokeResultList`	`invokeMembers(java.lang.Class<? extends MemberInvocable> cls, Tuple contextTuple)` Deprecated.
`InvokeResultList`	`invokeMembers(java.util.Collection<Member> members, java.lang.Class<? extends MemberInvocable> cls, Tuple contextTuple)` Deprecated.
`InvokeResultList`	`invokeMembers(java.util.Collection<Member> members, InvokeOptions options)` Deprecated.
`InvokeResultList`	`invokeMembers(java.util.Collection<Member> members, java.lang.String invocable, InvokeOptions options)`
`InvokeResultList`	`invokeMembers(java.util.Collection<Member> members, java.lang.String invocable, Tuple contextTuple)` Deprecated.
`InvokeResultList`	`invokeMembers(InvokeOptions invokeOptions)` Deprecated.
`InvokeResultList`	`invokeMembers(java.lang.String invocable, InvokeOptions invokeOptions)` Invokes in parallel the appropriate `invoke` method of the specified class on all of the members of the Space.
`InvokeResultList`	`invokeMembers(java.lang.String invocable, Tuple contextTuple)` Deprecated.
`InvokeResultList`	`invokeRemoteMembers(InvokeOptions invokeOptions)` Deprecated.
`InvokeResultList`	`invokeRemoteMembers(java.lang.String invocable, InvokeOptions invokeOptions)` Invokes in parallel the appropriate `invoke` method of the specified class on all of the remote members of the Space.
`InvokeResultList`	`invokeSeeders(java.lang.Class<? extends MemberInvocable> cls, Tuple contextTuple)` Deprecated.
`InvokeResultList`	`invokeSeeders(InvokeOptions invokeOptions)` Deprecated.
`InvokeResultList`	`invokeSeeders(java.lang.String invocable, InvokeOptions invokeOptions)` Invokes in parallel the appropriate `invoke` method of the specified class on all of the members of the Space which have a distribution role of seeder.
`InvokeResultList`	`invokeSeeders(java.lang.String cls, Tuple contextTuple)` Deprecated.
`boolean`	`isReady()` Check whether the Space is ready for operations.
`boolean`	`isValid()` Deprecated.
`void`	`leave()` Deprecated. This method is deprecated and calls `close()`
`Listener`	`listen(Listener listener)` Attaches a Listener object to a Space for receiving event notifications.
`Listener`	`listen(Listener listener, ListenerDef listenerDef)` Attaches a Listener object to a Space for receiving event notifications.
`Listener`	`listen(Listener listener, ListenerDef listenerDef, java.lang.String filter)` Attaches a Listener object to a Space for receiving event notifications that match the specified filter.
`Listener`	`listen(Listener listener, java.lang.String filter)` Attaches a Listener object to a Space for receiving event notifications that match the specified filter.
`void`	`load(Tuple tuple)` This function is typically used in an implementation of the `Persister.onLoad(com.tibco.as.space.persistence.LoadAction)` function to load the space.
`SpaceResultList`	`loadAll(java.util.Collection<Tuple> tuples)` Batch load operation.
`Tuple`	`lock(Tuple tuple)` Locks the entry stored in the Space which has the key specified in the given Tuple.
`Tuple`	`lock(Tuple tuple, LockOptions lockOptions)` Locks the entry stored in the Space which has the key specified in the given Tuple.
`SpaceResultList`	`lockAll(java.util.Collection<Tuple> tuples)` Batch lock operation.
`SpaceResultList`	`lockAll(java.util.Collection<Tuple> tuples, LockOptions lockOptions)` Batch lock operation with LockOptions.
`Tuple`	`put(Tuple tuple)` Stores a Tuple into the Space and returns any entry already stored in the Space with the same key.
`Tuple`	`put(Tuple tuple, PutOptions putOptions)` Stores a Tuple into the Space and returns any entry already stored in the Space with the same key.
`SpaceResultList`	`putAll(java.util.Collection<Tuple> tuples)` Batch put operation.
`SpaceResultList`	`putAll(java.util.Collection<Tuple> tuples, java.util.Collection<PutOptions> optionsCollection)` Batch put operation with collection of PutOptions.
`SpaceResultList`	`putAll(java.util.Collection<Tuple> tuples, PutOptions putOptions)` Batch put operation with PutOptions.
`void`	`resetStats()` Reset the statistics of all Space Members of the Space.
`void`	`setDistributionRole(Member.DistributionRole distributionRole)` Sets the distribution role of the calling Member of the Space.
`Persister`	`setPersister(Persister persister)` Registers the given Persister object as a persister for the Space.
`Router`	`setRouter(Router router)` Registers the given Router object as a router for the Space.
`long`	`size()` Retrieves the number of entries stored in the Space.
`long`	`size(java.lang.String filter)` Returns number of entries stored in the Space which match the given filter.
`void`	`stopListener(Listener listener)` Stops the specified Listener object, that was previously attached to the Space, and its associated thread.
`void`	`stopPersister(Persister persister)` Stops the given Persister object, that was previously registered, and its associated thread.
`void`	`stopRouter(Router router)` Stops the given Router object, that was previously registered, and its associated thread.
`Tuple`	`take(Tuple tuple)` Returns and atomically removes from the Space the entry (if one exists) whose key field matches the key field of the Tuple provided.
`Tuple`	`take(Tuple tuple, TakeOptions takeOptions)` Returns and atomically removes from the Space the entry (if one exists) whose key field matches the key field of the Tuple provided.
`SpaceResultList`	`takeAll(java.util.Collection<Tuple> tuples)` Batch take operation.
`SpaceResultList`	`takeAll(java.util.Collection<Tuple> tuples, TakeOptions takeOptions)` Batch take operation with TakeOptions.
`void`	`unlock(Tuple tuple)` Unlocks the entry stored in the Space which has the key specified in the given Tuple.
`void`	`unlock(Tuple tuple, UnlockOptions unlockOptions)` Unlocks the entry stored in the Space which has the key specified in the given Tuple.
`SpaceResultList`	`unlockAll(java.util.Collection<Tuple> tuples)` Batch unlock operation.
`SpaceResultList`	`unlockAll(java.util.Collection<Tuple> tuples, UnlockOptions unlockOptions)` Batch unlock operation with UnlockOptions.
`void`	`waitForReady()` Causes the client code to block until the Space is ready for operations.
`boolean`	`waitForReady(long timeout)` Causes the client code to block until the Space is ready for operations or the specified timeout is reached.

- Method Detail
  - getMetaspace
```
Metaspace getMetaspace()
                       throws ASException
```
    Retrieve the Metaspace object the Space belongs to.
    
    Returns:
    The Metaspace.
    
    Throws:
    
    ASException
  - getMetaspaceName
```
java.lang.String getMetaspaceName()
```
    Retrieve the name of the Metaspace that the Space belongs to.
    
    Returns:
    The Metaspace name.
  - leave
```
void leave()
           throws ASException
```
    Deprecated. This method is deprecated and calls close()
    
    Invalidates this Space reference with the distribution role it initialized with. If this is the last reference, current process will leave the space.
    
    Throws:
    
    ASException - An exception if leave fails
  - close
```
void close()
           throws ASException
```
    Invalidates this Space reference with the distribution role it initialized with. If this is the last reference, the current process will leave the Space.
    
    Throws:
    
    ASException - An exception if close fails
  - closeAll
```
void closeAll()
              throws ASException
```
    Forcefully leaves the Space and stops and invalidates any existing listeners and browsers created on the Space.
    
    Throws:
    
    ASException - An exception if close all fails
  - get
```
Tuple get(Tuple tuple)
          throws ASException
```
    Retrieve the entry stored in the Space with the key specified in the given Tuple.
    
    Parameters:
    tuple - Tuple containing the key to search for.
    
    Returns:
    A Tuple containing the values from the entry stored in the Space with the given key, if it exists.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while retrieving the Tuple values.
  - get
```
Tuple get(Tuple tuple,
        GetOptions options)
          throws ASException
```
    Throws:
    
    ASException
  - put
```
Tuple put(Tuple tuple)
          throws ASException
```
    Stores a Tuple into the Space and returns any entry already stored in the Space with the same key.
    
    Parameters:
    tuple - Tuple to be stored into the Space.
    
    Returns:
    A Tuple containing the values of the previously existing entry with the same key, if one exists.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while storing the Tuple values into the Space.
  - put
```
Tuple put(Tuple tuple,
        PutOptions putOptions)
          throws ASException
```
    Stores a Tuple into the Space and returns any entry already stored in the Space with the same key. This version of put allows you to specify a lock wait value, lock or unlock value, and a forget value.
    
    Parameters:
    tuple - A Tuple containing values to be stored into the Space.
    putOptions - Specifies custom lock wait/lock/unlock/forget options.
    
    Returns:
    A Tuple containing the values of the previously existing entry with the same key, if one exists.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while storing the Tuple values into the Space.
  - load
```
void load(Tuple tuple)
          throws ASException
```
    This function is typically used in an implementation of the Persister.onLoad(com.tibco.as.space.persistence.LoadAction) function to load the space.
    The load function is the only one that can be invoked on a space that is in the SpaceDef.SpaceState.LOADING phase.
    Load behaves exactly as a put, except that it does not trigger Persister.onWrite(com.tibco.as.space.persistence.WriteAction) method. put(com.tibco.as.space.Tuple) method should not be called to load entries from a Database into a Space.
    
    Parameters:
    tuple - A Tuple containing values to be stored into the Space.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while storing the Tuple values into the Space.
  - take
```
Tuple take(Tuple tuple)
           throws ASException
```
    Returns and atomically removes from the Space the entry (if one exists) whose key field matches the key field of the Tuple provided.
    
    Parameters:
    tuple - A Tuple containing a key field to search for in the Space.
    
    Returns:
    A Tuple containing the values of the entry which was stored in the Space with the given key field.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while removing the Tuple values from the Space.
  - take
```
Tuple take(Tuple tuple,
         TakeOptions takeOptions)
           throws ASException
```
    Returns and atomically removes from the Space the entry (if one exists) whose key field matches the key field of the Tuple provided. This method allows you to specify lock wait, lock/unlock/forget options.
    
    Parameters:
    tuple - Tuple containing a key field to search for in the Space.
    takeOptions - Specifies custom lock wait/lock/unlock/forget options.
    
    Returns:
    A Tuple containing the values of the entry which was stored in the Space with the given key field.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while removing the Tuple values from the Space.
  - compareAndPut
```
Tuple compareAndPut(Tuple oldTuple,
                  Tuple newTuple)
                    throws ASException
```
    Used to replace an the values of an existing entry with new values as long as the existing entry has not been modified and still matches the values in oldTuple. If the existing entry has been modified and doesn't match oldTuple, the values of the modified entry are returned so there is no need to do another get to retrieve the modified values.
    If the operation is successful, the Tuple returned will be same as newTuple. Otherwise, the Tuple returned will contain the values from the entry stored in the Space.
    Example:
```
     Tuple result = space.compareAndPut(oldTuple, newTuple);
     if (result == newTuple) // operation is successful
     else // operation failed due to mismatch
 
```
    Parameters:
    oldTuple - Tuple to use for comparison with the entry in the Space. A null value in oldTuple indicates the user wants the operation to be successful if the entry in the Space doesn't already have a value.
    newTuple - A Tuple containing the new values to store in the existing entry.
    
    Returns:
    Returns newTuple on success, otherwise a Tuple containing the current values from the entry.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while storing the Tuple values into the Space.
  - compareAndPut
```
Tuple compareAndPut(Tuple oldTuple,
                  Tuple newTuple,
                  PutOptions putOptions)
                    throws ASException
```
    Same as compareAndPut(com.tibco.as.space.Tuple, com.tibco.as.space.Tuple) with PutOptions to specify custom lock wait, lock/unlock options.
    
    Parameters:
    oldTuple - Tuple to use for comparison with the entry in the Space. A null value in oldTuple indicates the user wants the operation to be successful if the Tuple in the Space doesn't already have a value.
    newTuple - A Tuple containing the new values to store in the existing entry.
    putOptions - Specified custom lock wait/lock/unlock options. The forget option is ignored since on a mismatch ActiveSpaces needs to return the existing entry's values.
    
    Returns:
    Returns newTuple on success, otherwise a Tuple containing the current values from the entry.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while storing the Tuple values into the Space.
  - compareAndTake
```
Tuple compareAndTake(Tuple oldTuple)
                     throws ASException
```
    Removes the entry from the Space which matches the Tuple passed into the method.
    
    Parameters:
    oldTuple - Tuple to use for comparing against the entries stored in the Space.
    
    Returns:
    On success, the same Java object given as oldTuple is returned. On failure, a Tuple with the same values as the entry in the Space is returned.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while removing the entry from the Space.
  - compareAndTake
```
Tuple compareAndTake(Tuple oldTuple,
                   TakeOptions takeOptions)
                     throws ASException
```
    Removes the entry from the Space which matches the Tuple passed into the method.
    
    Parameters:
    oldTuple - Tuple to use for comparing against the entries stored in the Space.
    takeOptions - Specifies custom lock wait/lock/unlock options. The forget option is ignored since on a mismatch ActiveSpaces needs to return the existing entry's values.
    
    Returns:
    On success, the same Java object given as oldTuple is returned. On failure, a Tuple with the same values as the entry in the Space is returned.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while removing the entry from the Space.
  - lock
```
Tuple lock(Tuple tuple)
           throws ASException
```
    Locks the entry stored in the Space which has the key specified in the given Tuple.
    
    Parameters:
    tuple - Tuple containing the key of the entry to lock.
    
    Returns:
    On success, a Tuple containing the same values as the entry that was just locked is returned. If the entry does not have any values, null is returned.
    
    Throws:
    
    ASException - An exception is thrown if the entry cannot be locked.
  - lock
```
Tuple lock(Tuple tuple,
         LockOptions lockOptions)
           throws ASException
```
    Locks the entry stored in the Space which has the key specified in the given Tuple.
    Parameters:
    tuple - Tuple containing the key of the entry to lock.
    lockOptions - Used to specify the following:
    
    lock wait: amount of time to wait for any lock, blocking the operation, to clear (default setting taken from SpaceDef.getLockWait())
    forget: whether to return the data of the locked entry (true=do not return the data, default=false)
    result handler: called, if specified, when the lock operation is complete
    closure: used to pass data to the result handler
    Returns:
    On success, a Tuple containing the same values as the entry that was just locked is returned. If the entry does not have any values, null is returned. If LockOptions::setForget(true) has been set for the lockOptions parameter, null will be returned upon successful completion whether the entry contains values or not.
    
    Throws:
    
    ASException - An exception is thrown if the entry cannot be locked.
  - unlock
```
void unlock(Tuple tuple)
            throws ASException
```
    Unlocks the entry stored in the Space which has the key specified in the given Tuple.
    
    Parameters:
    tuple - Tuple containing the key of the entry to unlock.
    
    Throws:
    
    ASException - An exception is thrown if the entry cannot be unlocked.
  - unlock
```
void unlock(Tuple tuple,
          UnlockOptions unlockOptions)
            throws ASException
```
    Unlocks the entry stored in the Space which has the key specified in the given Tuple.
    Parameters:
    tuple - Tuple containing the key of the entry to unlock.
    unlockOptions - Used to specify the following:
    
    lock wait: amount of time to wait for any lock, blocking the operation, to clear (default setting taken from SpaceDef.getLockWait())
    result handler: called, if specified, when the unlock operation is complete
    closure: used to pass data to the result handler
    Throws:
    
    ASException - An exception is thrown if the entry cannot be unlocked.
  - getAll
```
SpaceResultList getAll(java.util.Collection<Tuple> tuples)
```
    Batch get operation.
    
    Parameters:
    tuples - A Collection of Tuples which contain the keys to use for searching for the entries in the Space to retrieve.
    
    Returns:
    List containing the result of each get.
  - putAll
```
SpaceResultList putAll(java.util.Collection<Tuple> tuples)
```
    Batch put operation.
    
    Parameters:
    tuples - A Collection of Tuples to be stored in the Space.
    
    Returns:
    List containing the result of each put.
  - putAll
```
SpaceResultList putAll(java.util.Collection<Tuple> tuples,
                     PutOptions putOptions)
```
    Batch put operation with PutOptions.
    
    Parameters:
    tuples - A Collection of Tuples to be stored in the Space.
    putOptions - Specifies custom lock wait/lock/unlock options.
    
    Returns:
    List containing the result of each put.
  - putAll
```
SpaceResultList putAll(java.util.Collection<Tuple> tuples,
                     java.util.Collection<PutOptions> optionsCollection)
```
    Batch put operation with collection of PutOptions.
    
    Parameters:
    tuples - A Collection of Tuples to be stored in the Space.
    optionsCollection - Specifies collection of PutOptions per tuple
    
    Returns:
    List containing the result of each put.
  - loadAll
```
SpaceResultList loadAll(java.util.Collection<Tuple> tuples)
```
    Batch load operation.
    
    Parameters:
    tuples - A Collection of Tuples to be loaded into the Space.
    
    Returns:
    List containing the result of each load.
  - takeAll
```
SpaceResultList takeAll(java.util.Collection<Tuple> tuples)
```
    Batch take operation.
    
    Parameters:
    tuples - A Collection of Tuples which contain the keys to use for searching for the entries to remove from the Space.
    
    Returns:
    List containing the result of each take.
  - takeAll
```
SpaceResultList takeAll(java.util.Collection<Tuple> tuples,
                      TakeOptions takeOptions)
```
    Batch take operation with TakeOptions.
    
    Parameters:
    tuples - A Collection of Tuples which contain the keys to use for searching for the entries to remove from the Space.
    takeOptions - Specifies custom lock wait/lock/unlock options.
    
    Returns:
    List containing the result of each take.
  - compareAndPutAll
```
SpaceResultList compareAndPutAll(java.util.Collection<Tuple> oldTuples,
                               java.util.Collection<Tuple> newTuples)
```
    Batch compareAndPut operation.
    
    Parameters:
    oldTuples - A Collection of Tuples to use for comparison with the existing entries in the Space.
    newTuples - A Collection of Tuples containing new values to store in the existing entries.
    
    Returns:
    List containing the result of each compareAndPut.
  - compareAndPutAll
```
SpaceResultList compareAndPutAll(java.util.Collection<Tuple> oldTuples,
                               java.util.Collection<Tuple> newTuples,
                               PutOptions putOptions)
```
    Batch compareAndPut operation with PutOptions.
    
    Parameters:
    oldTuples - A Collection of Tuples to use for comparison with the existing entries in the Space.
    newTuples - A Collection of Tuples containing new values to store in the existing entries.
    putOptions - Specifies custom lock wait/lock/unlock options.
    
    Returns:
    List containing the result of each compareAndPut.
  - compareAndPutAll
```
SpaceResultList compareAndPutAll(java.util.Collection<Tuple> oldTuples,
                               java.util.Collection<Tuple> newTuples,
                               java.util.Collection<PutOptions> optionsCollection)
```
    Batch compareAndPut operation with a collection of PutOptions
    
    Parameters:
    oldTuples - A Collection of Tuples to use for comparison with the existing entries in the Space.
    newTuples - A Collection of Tuples containing new values to store in the existing entries.
    optionsCollection - Specifies collection of PutOptions per tuple
    
    Returns:
    List containing the result of each compareAndPut.
  - compareAndTakeAll
```
SpaceResultList compareAndTakeAll(java.util.Collection<Tuple> oldTuples)
```
    Batch compareAndTake operation.
    
    Parameters:
    oldTuples - A Collection of Tuples to use for comparing against the entries stored in the Space.
    
    Returns:
    List containing the SpaceResult of each compareAndTake. For each success, SpaceResult will contain the same Java object given for oldTuple. For each failure, SpaceResult will contain a Tuple with the same values as the entry in the Space. Use SpaceResult.getTuple() to retrieve the resulting Tuples.
  - compareAndTakeAll
```
SpaceResultList compareAndTakeAll(java.util.Collection<Tuple> oldTuples,
                                TakeOptions takeOptions)
```
    Batch compareAndTake operation with TakeOptions.
    
    Parameters:
    oldTuples - A Collection of Tuples to use for comparing against the entries stored in the Space.
    takeOptions - Specifies custom lock wait/lock/unlock options.
    
    Returns:
    List containing the SpaceResult of each compareAndTake. For each success, SpaceResult will contain the same Java object given for oldTuple. For each failure, SpaceResult will contain a Tuple with the same values as the entry in the Space. Use SpaceResult.getTuple() to retrieve the resulting Tuples.
  - lockAll
```
SpaceResultList lockAll(java.util.Collection<Tuple> tuples)
```
    Batch lock operation.
    
    Parameters:
    tuples - A Collection of Tuples which contain the keys to use for searching for the entries to lock in the Space.
    
    Returns:
    List containing the result of each lock.
  - lockAll
```
SpaceResultList lockAll(java.util.Collection<Tuple> tuples,
                      LockOptions lockOptions)
```
    Batch lock operation with LockOptions.
    
    Parameters:
    tuples - A Collection of Tuples which contain the keys to use for searching for the entries to lock in the Space.
    lockOptions - Specifies custom lock wait/forget/lock scope options.
    
    Returns:
    List containing the result of each lock.
  - unlockAll
```
SpaceResultList unlockAll(java.util.Collection<Tuple> tuples)
```
    Batch unlock operation.
    
    Parameters:
    tuples - A Collection of Tuples which contain the keys to use for searching for the entries to unlock in the Space.
    
    Returns:
    List containing the result of each unlock.
  - unlockAll
```
SpaceResultList unlockAll(java.util.Collection<Tuple> tuples,
                        UnlockOptions unlockOptions)
```
    Batch unlock operation with UnlockOptions.
    
    Parameters:
    tuples - A Collection of Tuples which contain the keys to use for searching for the entries to unlock in the Space.
    unlockOptions - Specifies custom lock wait options.
    
    Returns:
    List containing the result of each unlock.
  - setPersister
```
Persister setPersister(Persister persister)
                       throws ASException
```
    Registers the given Persister object as a persister for the Space.
    
    Parameters:
    persister - Implementation of the Persister interface to be registered.
    
    Returns:
    The registered Persister object.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while registering the Persister object with the Space.
  - stopPersister
```
void stopPersister(Persister persister)
                   throws ASException
```
    Stops the given Persister object, that was previously registered, and its associated thread.
    
    Parameters:
    persister - The Persister object to be stopped.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while stopping the Persister object or its associated thread.
  - setRouter
```
Router setRouter(Router router)
                 throws ASException
```
    Registers the given Router object as a router for the Space.
    
    Parameters:
    router - Implementation of the Router interface to be registered.
    
    Returns:
    The registered Router object.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while registering the Router object with the Space.
  - stopRouter
```
void stopRouter(Router router)
                throws ASException
```
    Stops the given Router object, that was previously registered, and its associated thread.
    
    Parameters:
    router - The Router object to be stopped.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while stopping the Router object or its associated thread.
  - listen
```
Listener listen(Listener listener)
                throws ASException
```
    Attaches a Listener object to a Space for receiving event notifications.
    
    Parameters:
    listener - The Listener object which needs to be attached to the Space.
    
    Returns:
    The attached Listener object.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while attaching the Listener object to the Space.
  - listen
```
Listener listen(Listener listener,
              ListenerDef listenerDef)
                throws ASException
```
    Attaches a Listener object to a Space for receiving event notifications.
    
    Parameters:
    listener - The Listener object which needs to be attached to the Space.
    listenerDef - Used to specify custom distribution and time scopes.
    
    Returns:
    The attached Listener object.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while attaching the Listener object to the Space.
  - listen
```
Listener listen(Listener listener,
              java.lang.String filter)
                throws ASException
```
    Attaches a Listener object to a Space for receiving event notifications that match the specified filter.
    
    Parameters:
    listener - The Listener object which needs to be attached to the Space.
    filter - A String that can be used to create a Filter
    
    Returns:
    The attached Listener object.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while attaching the Listener object to the Space.
  - listen
```
Listener listen(Listener listener,
              ListenerDef listenerDef,
              java.lang.String filter)
                throws ASException
```
    Attaches a Listener object to a Space for receiving event notifications that match the specified filter.
    
    Parameters:
    listener - The Listener object which needs to be attached to the Space.
    listenerDef - Used to specify custom distribution and time scopes.
    filter - A String that can be used to create a Filter
    
    Returns:
    The attached Listener object.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while attaching the Listener object to the Space.
  - stopListener
```
void stopListener(Listener listener)
                  throws ASException
```
    Stops the specified Listener object, that was previously attached to the Space, and its associated thread.
    
    Parameters:
    listener - The Listener object to be stopped.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while stopping the Listener object or its associated thread.
  - browse
```
Browser browse(BrowserDef.BrowserType browserType)
               throws ASException
```
    Creates a Browser object which can be used to perform operations on multiple entries in a Space.
    
    Parameters:
    browserType - Indicates the type of Browser object to be created. The browserType can be one of GET, TAKE or LOCK as defined in BrowserDef.BrowserType.
    
    Returns:
    The Browser object that was created.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while creating the Browser object or its associated thread.
  - browse
```
Browser browse(BrowserDef.BrowserType browserType,
             BrowserDef browserDef)
               throws ASException
```
    Creates a Browser object which can be used to perform operations on multiple entries in a Space.
    
    Parameters:
    browserType - Indicates the type of Browser object to be created. The browserType can be one of GET, TAKE or LOCK as defined in BrowserDef.BrowserType.
    browserDef - Used to specify custom timeout values and distribution or time scopes.
    
    Returns:
    The Browser object that was created.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while creating the Browser object or its associated thread.
  - browse
```
Browser browse(BrowserDef.BrowserType browserType,
             BrowserDef browserDef,
             java.lang.String filter)
               throws ASException
```
    Creates a Browser object which can be used to perform operations on multiple entries in a Space which match the specified filter.
    
    Parameters:
    browserType - Indicates the type of Browser object to be created. The browserType can be one of GET, TAKE or LOCK as defined in BrowserDef.BrowserType.
    browserDef - Used to specify custom timeout values and distribution or time scopes.
    filter - A String that can be used to create a Filter
    
    Returns:
    The Browser object that was created.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while creating the Browser object or its associated thread.
  - browseEvents
```
EventBrowser browseEvents(EventBrowserDef eventBrowserDef)
                          throws ASException
```
    Creates an EventBrowser object which can be used to retrieve and iterate over events that occur in a Space.
    
    Parameters:
    eventBrowserDef - Used to specify custom timeout values and distribution or time scopes.
    
    Returns:
    The EventBrowser object that was created.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs creating the EventBrowser object or its associated thread.
  - browseEvents
```
EventBrowser browseEvents(EventBrowserDef eventBrowserDef,
                        java.lang.String filter)
                          throws ASException
```
    Creates an EventBrowser object which can be used to retrieve and iterate over the events that occur in a Space and that match the specified filter.
    
    Parameters:
    eventBrowserDef - Used to specify custom timeout values and distribution or time scopes.
    filter - A String that can be used to create a Filter
    
    Returns:
    The EventBrowser object that was created.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs creating the EventBrowser object or its associated thread.
  - clear
```
void clear(java.lang.String filter)
           throws ASException
```
    Deletes from the Space the tuples that match the specified filter on a "best effort" basis. If no filter is specified, all tuples are deleted.
    This operation does not block other space operations while it is ongoing, so if other clients perform write operations on entries already removed but before the clear finishes, it might be the case that the space contains tuples that match the filter after the clear completes. Thus, it is up to the application to synchronize its clients to guarantee that no write operations happen while the clear is ongoing if the intent is to clear all entries present in the space at the time clear is invoked. Internally, this operation, among other tasks, executes a series of small queries with the provided filter. Depending on the filter string and the indexing of the space, there is the possibility that one of these queries results in a linear scan that takes a significant amount of time. If that were to happen, one or more of the space seeders will log a message warning that a long query was executed some seconds after the user executes this call. To fix this problem, the user should update the filter string or add extra secondary indices in order to avoid long linear scans.
    
    Persistence behaviour
    When share-all persistence is used, this method does not trigger onWrite callbacks. It is user's responsibility to perform clear on the back-end database.
    When share-nothing persistence is used, the in memory space data is kept synchronized with the persistence files and entries are removed from file as well.
    
    Listener behaviour
    Listeners do not get callbacks for takes performed along with clear execution.
    
    Parameters:
    filter - A String that can be used to create a Filter
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while deleting entries
  - clear
```
void clear()
           throws ASException
```
    Deletes all tuples in the Space. Equivalent to clear(null).
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while deleting entries
  - getSpaceDef
```
SpaceDef getSpaceDef()
                     throws ASException
```
    Retrieve the attributes used to create the Space.
    
    Returns:
    Object containing the defined characteristics of the Space.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs retrieving the attributes of the Space.
  - getName
```
java.lang.String getName()
```
    Returns the name of the Space.
    
    Returns:
    The Space name.
  - setDistributionRole
```
void setDistributionRole(Member.DistributionRole distributionRole)
                         throws ASException
```
    Sets the distribution role of the calling Member of the Space.
    
    Parameters:
    distributionRole - Specifies whether the calling Member is a LEECH or SEEDER for the Space.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while setting the distribution role of the calling Member of the Space.
  - size
```
long size()
          throws ASException
```
    Retrieves the number of entries stored in the Space.
    
    Returns:
    The number of entries in the Space.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while retrieving the size of the Space.
  - resetStats
```
void resetStats()
                throws ASException
```
    Reset the statistics of all Space Members of the Space.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while resetting the statistics of all Space members.
  - size
```
long size(java.lang.String filter)
          throws ASException
```
    Returns number of entries stored in the Space which match the given filter.
    
    Parameters:
    filter - A String that can be used to create a Filter.
    
    Returns:
    The number of entries in the Space which match the specified filter.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while retrieving the size of the Space.
  - explainQuery
```
java.lang.String explainQuery(java.lang.String filter)
                              throws ASException
```
    Returns A string that describes the cost of the query execution in each seeder
    
    Parameters:
    filter - A string that can be used to create a Filter.
    
    Returns:
    A string that describes the cost of the query execution in each seeder
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while retrieving the cost of the query execution
  - invoke
```
InvokeResult invoke(Tuple tuple,
                  java.lang.String invocable,
                  InvokeOptions options)
                    throws ASException
```
    Causes execution of the invoke method from the specified class on the Member of the Space where the entry associated with the key specified in tuple is stored. If an entry for the key does not exist in the Space, the invoke method is executed on the Member of the Space where the entry would have been stored.
    The Member of the Space where the invoke method is executed must have the invoked class present in its CLASSPATH for the invocation to succeed!
    
    Parameters:
    tuple - Contains the key used to direct invocation to the Member of the Space storing the entry associated with the key.
    invocable - The class that implements the Invocable interface.
    
    Returns:
    Result of the invocation.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs during the invocation.
  - invoke
```
@Deprecated
InvokeResult invoke(Tuple tuple,
                             InvokeOptions options)
                    throws ASException
```
    Deprecated. Use invoke(Tuple, String, InvokeOptions)
    
    Throws:
    
    ASException
  - invokeMember
```
InvokeResult invokeMember(Member member,
                        java.lang.String invocable,
                        InvokeOptions options)
                          throws ASException
```
    Causes execution of the invoke method of the specified class on the specific Member of the Space passed as an argument.
    The Member of the Space where the invoke method is executed must have the invoked class present in its CLASSPATH for the invocation to succeed!
    
    Parameters:
    member - Member to execute the invoke method on.
    invocable - The class that implements the MemberInvocable interface.
    
    Returns:
    Result of the invocation.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs during the invocation.
  - invokeMember
```
@Deprecated
InvokeResult invokeMember(Member member,
                                   InvokeOptions options)
                          throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeMembers
```
InvokeResultList invokeMembers(java.util.Collection<Member> members,
                             java.lang.String invocable,
                             InvokeOptions options)
                               throws ASException
```
    Parameters:
    members - Collection of Members to issue invocation
    invocable - The class that implements the MemberInvocable interface.
    
    Returns:
    Result of the invocation
    
    Throws:
    
    ASException - An exception is thrown if an error occurs during the invocation.
  - invokeMembers
```
@Deprecated
InvokeResultList invokeMembers(java.util.Collection<Member> members,
                                        InvokeOptions options)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeMembers
```
InvokeResultList invokeMembers(java.lang.String invocable,
                             InvokeOptions invokeOptions)
                               throws ASException
```
    Invokes in parallel the appropriate invoke method of the specified class on all of the members of the Space.
    All members of the Space must have the specified class present in their CLASSPATH for the invocation to succeed!
    
    Parameters:
    invocable - The class that implements the MemberInvocable interface.
    invokeOptions - InvokeOptions
    
    Returns:
    Result of the invocation.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs during the invocation.
  - invokeMembers
```
@Deprecated
InvokeResultList invokeMembers(InvokeOptions invokeOptions)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeRemoteMembers
```
InvokeResultList invokeRemoteMembers(java.lang.String invocable,
                                   InvokeOptions invokeOptions)
                                     throws ASException
```
    Invokes in parallel the appropriate invoke method of the specified class on all of the remote members of the Space.
    All remote members of the Space must have the specified class present in their CLASSPATH for the invocation to succeed!
    
    Parameters:
    invocable - The class that implements the MemberInvocable interface.
    invokeOptions - InvokeOptions
    
    Returns:
    Result of the invocation.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs during the invocation.
  - invokeRemoteMembers
```
@Deprecated
InvokeResultList invokeRemoteMembers(InvokeOptions invokeOptions)
                                     throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeSeeders
```
InvokeResultList invokeSeeders(java.lang.String invocable,
                             InvokeOptions invokeOptions)
                               throws ASException
```
    Invokes in parallel the appropriate invoke method of the specified class on all of the members of the Space which have a distribution role of seeder.
    All seeder members of the Space must have the specified class present in their CLASSPATH for the invocation to succeed!
    
    Parameters:
    invocable - The class that implements the MemberInvocable interface.
    invokeOptions - InvokeOptions
    
    Returns:
    Result of the invocation.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs during the invocation.
  - invokeSeeders
```
@Deprecated
InvokeResultList invokeSeeders(InvokeOptions invokeOptions)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeLeeches
```
InvokeResultList invokeLeeches(java.lang.String invocable,
                             InvokeOptions invokeOptions)
                               throws ASException
```
    Invokes in parallel the appropriate invoke method of the specified class on all of the members of the Space which have a distribution role of leech.
    All leech members of the Space must have the specified class present in their CLASSPATH for the invocation to succeed!
    
    Parameters:
    invocable - The class that implements the MemberInvocable interface.
    invokeOptions - InvokeOptions
    
    Returns:
    Result of the invocation.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs during the invocation.
  - invokeLeeches
```
@Deprecated
InvokeResultList invokeLeeches(InvokeOptions invokeOptions)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - isReady
```
boolean isReady()
                throws ASException
```
    Check whether the Space is ready for operations.
    
    Returns:
    True indicates the Space is ready for operations. False is returned otherwise.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while checking the state of the Space.
  - waitForReady
```
void waitForReady()
                  throws ASException
```
    Causes the client code to block until the Space is ready for operations.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while checking the state of the Space.
  - waitForReady
```
boolean waitForReady(long timeout)
                     throws ASException
```
    Causes the client code to block until the Space is ready for operations or the specified timeout is reached.
    
    Parameters:
    timeout - Timeout in milliseconds.
    
    Returns:
    True indicates the Space is ready for operations. False is returned otherwise.
    
    Throws:
    
    ASException - An exception is thrown if an error occurs while checking the state of the Space.
  - getSpaceState
```
SpaceDef.SpaceState getSpaceState()
```
    Retrieve the state of the Space.
    
    Returns:
    An Enum for the current state of the Space.
  - getMembers
```
java.util.Collection<Member> getMembers()
                                        throws ASException
```
    Returns the collection of @Member of the space
    
    Returns:
    collection of @Member of the space
    
    Throws:
    
    ASException
  - getSeeders
```
java.util.Collection<Member> getSeeders()
                                        throws ASException
```
    Returns the collection of @Member of the space with seeder role
    
    Returns:
    collection of @Member of the space
    
    Throws:
    
    ASException
  - getLeeches
```
java.util.Collection<Member> getLeeches()
                                        throws ASException
```
    Returns the collection of @Member of the space with leech role
    
    Returns:
    collection of @Member of the space
    
    Throws:
    
    ASException
  - getRemoteMembers
```
java.util.Collection<Member> getRemoteMembers()
                                              throws ASException
```
    Returns the collection of @Member of the space connected using remote client
    
    Returns:
    collection of @Member of the space
    
    Throws:
    
    ASException
  - invoke
```
@Deprecated
InvokeResult invoke(Tuple keyTuple,
                             java.lang.String invocable,
                             Tuple contextTuple)
                    throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invoke
```
@Deprecated
InvokeResult invoke(Tuple keyTuple,
                             java.lang.Class<? extends Invocable> cls,
                             Tuple contextTuple)
                    throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeMember
```
@Deprecated
InvokeResult invokeMember(Member member,
                                   java.lang.String invocable,
                                   Tuple contextTuple)
                          throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeMember
```
@Deprecated
InvokeResult invokeMember(Member member,
                                   java.lang.Class<? extends MemberInvocable> cls,
                                   Tuple contextTuple)
                          throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeMembers
```
@Deprecated
InvokeResultList invokeMembers(java.util.Collection<Member> members,
                                        java.lang.String invocable,
                                        Tuple contextTuple)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeMembers
```
@Deprecated
InvokeResultList invokeMembers(java.util.Collection<Member> members,
                                        java.lang.Class<? extends MemberInvocable> cls,
                                        Tuple contextTuple)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeMembers
```
@Deprecated
InvokeResultList invokeMembers(java.lang.String invocable,
                                        Tuple contextTuple)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeMembers
```
@Deprecated
InvokeResultList invokeMembers(java.lang.Class<? extends MemberInvocable> cls,
                                        Tuple contextTuple)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeSeeders
```
@Deprecated
InvokeResultList invokeSeeders(java.lang.String cls,
                                        Tuple contextTuple)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - invokeSeeders
```
@Deprecated
InvokeResultList invokeSeeders(java.lang.Class<? extends MemberInvocable> cls,
                                        Tuple contextTuple)
                               throws ASException
```
    Deprecated.
    
    Throws:
    
    ASException
  - isValid
```
@Deprecated
boolean isValid()
```
    Deprecated.

Interface Space

Method Summary

Method Detail

getMetaspace

getMetaspaceName

leave

close

closeAll

get

get

put

put

load

take

take

compareAndPut

compareAndPut

compareAndTake

compareAndTake

lock

lock

unlock

unlock

getAll

putAll

putAll

putAll

loadAll

takeAll

takeAll

compareAndPutAll

compareAndPutAll

compareAndPutAll

compareAndTakeAll

compareAndTakeAll

lockAll

lockAll

unlockAll

unlockAll

setPersister

stopPersister

setRouter

stopRouter

listen

listen

listen

listen

stopListener

browse

browse

browse

browseEvents

browseEvents

clear

clear

getSpaceDef

getName

setDistributionRole

size

resetStats

size

explainQuery

invoke

invoke

invokeMember

invokeMember

invokeMembers

invokeMembers

invokeMembers

invokeMembers

invokeRemoteMembers

invokeRemoteMembers

invokeSeeders

invokeSeeders

invokeLeeches

invokeLeeches

isReady

waitForReady

waitForReady

getSpaceState