AS

Description

AS Client Functions

Functions

NameSignature and Synopsis
beginTransactionvoid beginTransaction(String channelUri)
Start a transaction
commitTransactionvoid commitTransaction(String channelUri)
Commit a transaction
getConceptBlobFromPayloadObject getConceptBlobFromPayload(SimpleEvent event, String blobFieldName, Concept conceptTemplate)
Get Concept's Blob from the payload of SimpleEvent
getConsumptionModeString getConsumptionMode(SimpleEvent event)
Gets the Event consumption mode.
getEventObject getEvent(String destinationUri, SimpleEvent key)
Get the event with specific key from Space
getEventTypeString getEventType(SimpleEvent event)
Gets the event type.
getEventsObject[] getEvents(String destinationUri, SimpleEvent[] keys)
Get the event result set
getSimpleEventBlobFromPayloadObject getSimpleEventBlobFromPayload(SimpleEvent event, String blobFieldName, SimpleEvent eventTemplate)
Get SimpleEvent's Blob from the payload of SimpleEvent
lockEventObject lockEvent(String destinationUri, SimpleEvent event, Object... options)
Locks the event associated with a key event value. If lock operation is a success, matching tuple is returned (or null if no match is found), and lock must be released subsequently. If lock operation fails (e.g. due to specified timeout) then an exception is thrown with 'LOCKED (entry_lock_timeout)' message, which must be handled by the caller.
lockEventsObject[] lockEvents(String destinationUri, SimpleEvent[] keys, Object... options)
Batch lock operation
putEventObject putEvent(String destinationUri, SimpleEvent event)
Stores a event into the Space and returns the corresponding entry
putEventsObject[] putEvents(String destinationUri, SimpleEvent[] keys)
Batch put operation
queryObject[] query(String destinationUri, SimpleEvent eventTemplate, String browserTypeStr, String timeScope, String distributionScope, int timeout, long prefetch, String filter)
Retrieves the entries that match the conditions you specified in the associated Space
queryIteratorObject queryIterator(String destinationUri, SimpleEvent eventTemplate, String browserTypeStr, String timeScope, String distributionScope, int timeout, long prefetch, String filter)
Retrieves the iterator of entries that match the conditions you specified in the associated Space
releaseTransactionObject releaseTransaction(String channelUri)
Return TransationId if the thread is in a transaction. TransactionId can then be given to another thread to continue transaction
rollbackTransactionvoid rollbackTransaction(String channelUri)
Rollback a transaction
takeEventObject takeEvent(String destinationUri, SimpleEvent key)
Returns and atomically removes from the space the event (if one exists) whose event key fields match the key fields of the event provided
takeEventsObject[] takeEvents(String destinationUri, SimpleEvent[] keys)
Batch take operation
takeSnapshotObject[] takeSnapshot(String destinationUri, SimpleEvent eventTemplate, String browserTypeStr, String distributionScope, int timeout, long prefetch, String filter)
Take snapshot of the entries that match the conditions you specified in the associated Space
takeTransactionvoid takeTransaction(String channelUri, Object transactionId)
Take TransactionId to continue transaction
unlockEventvoid unlockEvent(String destinationUri, SimpleEvent event, Object... options)
Unlocks the event associated with a key event value. If unlock operation fails (e.g. due to specified timeout) then an exception is thrown with 'LOCKED (entry_lock_timeout)' message, which must be handled by the caller.
unlockEventsObject[] unlockEvents(String destinationUri, SimpleEvent[] keys, Object... options)
Batch unlock operation