Metaspace.Space

Categories

NameDescription
Options
Result

Functions

NameSignature and Synopsis
closevoid close (String spaceName)
close the Space. The space name specified must be prefixed with the Metaspace name as ms.S1
closeAllvoid closeAll (String spaceName)
close the Space. The space name specified must be prefixed with the Metaspace name as ms.S1
compareAndPutObject compareAndPut (String spaceName, Tuple tuple2Compare, Tuple tuple2Set, Object... varargs)
Compare the tuple in the space with the tuple passed as the compareTuple, if True, set the tuple in the space with the specified tuple. Return the tuple that is currently in the space. The varargs can be PutOptions object, or individually specified value
compareAndPutAllObject compareAndPutAll (String spaceName, Object compareTuples, Object updateTuples, Object ... varags)
compareAndTakeObject compareAndTake (String spaceName, Object compareTuple, Object ... varargs)
Compare the entry with the entry passed, and if equals, then take (atomic remove) it.
compareAndTakeAllObject compareAndTakeAll (String spaceName, Object compareTuples, Object ... varargs)
Batch compareAndTake operation.
getObject get (String spaceName, Object keyTuple)
Get the value from the Space for the specified key.
getAllObject getAll (String spaceName, Object tupleList)
Batch get operation.
getCachePolicyString getCachePolicy (Object spaceDef)
Gets cache policy for provided space definition.
getCapacitylong getCapacity (Object spaceDef)
Gets cache capacity for provided space definition.
getMetaspaceNameString getMetaspaceName (String spaceName)
Retrieve the name of the Metaspace that the Space belongs to.
getPersistencePolicyString getPersistencePolicy (Object spaceDef)
Gets persistence policy for provided space definition.
getPersistenceTypeString getPersistenceType (Object spaceDef)
Gets persistence type for provided space definition.
getReplicationCountint getReplicationCount (Object spaceDef)
Gets cache replication count for provided space definition.
getReplicationPolicyString getReplicationPolicy (Object spaceDef)
Gets replication policy for provided space definition.
getSpaceDefObject getSpaceDef (String spaceName)
Retrieve the attributes used to create the Space. If requested space is not found, then a default space definition will be returned.
getSpaceStateString getSpaceState (String spaceName)
Return state of space
invokevoid invoke (String spaceName, Object keyTuple, String codeName, Object contextTuple, Object... varargs)
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.
invokeLeechesObject invokeLeeches(String spaceName, String codeName, Object contextTuple, Object... varargs)
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.
invokeMembervoid invokeMember (String spaceName, Object member, String codeName, Object contextTuple, Object... varargs)
Causes execution of the invoke method of the specified class on the specific Member of the Space passed as an argument.
isReadyboolean isReady (String spaceName)
Check whether the Space is ready for operations.
loadvoid load (String space, Object tuple)
Load behaves exactly as a put, except that it does not trigger 'Persister.onWrite(com.tibco.as.space.persistence.WriteAction) method.'
lockObject lock (String spaceName, Object tuple, Object ... varargs)
Locks the entry stored in the Space which has the key specified in the given Tuple.
lockAllObject lockAll (String spaceName, Object tuples, Object... varargs)
Batch lock operation.
putObject put(String spaceName, Object tuple, Object... varargs)
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.
putAllObject putAll (String spaceName, Object tuples, Object... varargs)
Batch put operation.
setCachePolicyString getCachePolicy (Object spaceDef, String policy)
Sets cache policy for provided space definition.
setCapacitylong setCapacity (Object spaceDef, long capacity)
Sets cache capacity for provided space definition.
setDistributionRolevoid setDistributionRole (String spaceName, String role)
Sets the distribution role of the calling Member of the Space.
setPersistencePolicyString setPersistencePolicy (Object spaceDef, String policy)
Sets persistence policy for provided space definition.
setPersistenceTypeString setPersistenceType (Object spaceDef, String persistenceType)
Sets persistence type for provided space definition.
setReplicationCountint getReplicationCount (Object spaceDef, int capacity)
Sets cache replication count for provided space definition.
setReplicationPolicyint setReplicationPolicy (Object spaceDef, String policy)
Sets replication policy for provided space definition.
sizelong size (String spaceName)
Retrieves the number of entries stored in the Space.
takeObject take (String spaceName, Object tuple, Object... varargs)
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.
takeAllObject takeAll (String spaceName, Object tuples, Object... varargs)
Batch take operation.
unlockvoid unlock (String spaceName, Object tuple, Object ... varargs)
Unlocks the entry stored in the Space which has the key specified in the given Tuple.
unlockAllObject unlockAll (String spaceName, Object tuples, Object... varargs)
Batch unlock operation.
waitForReadyboolean waitForReady (String spaceName, long time2Wait)
Causes the client code to block until the Space is ready for operations or the specified timeout is reached.