MemoryBookmarkStore (AMPS Java Client (5.3.2.1.6d15937f.540279))

java.lang.Object
- com.crankuptheamps.client.MemoryBookmarkStore

All Implemented Interfaces:

BookmarkStore, java.lang.AutoCloseable
```
public class MemoryBookmarkStore
extends java.lang.Object
implements BookmarkStore
```
Implements a bookmark store useful for handling server failover scenarios, but without a backing store to recover from subscriber failure. An optional RecoveryPointAdapter can be specified at construction to persist bookmark subscription recovery state to an external store so the subscription can be resumed if the subscriber fails.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`MemoryBookmarkStore.Subscription` The Subscription object is used to represent internal bookmark state for the messages received and discarded on a specific subscription within the bookmark store.

Field Summary

Fields
Modifier and Type	Field and Description
`protected RecoveryPointAdapter`	`_adapter` Optional recovery point adapter used to persist bookmark replay recovery state for each subscription.
`protected RecoveryPointFactory`	`_factory`

Constructor Summary

Constructors
Constructor and Description
`MemoryBookmarkStore()`
`MemoryBookmarkStore(int targetNumberOfSubscriptions)`
`MemoryBookmarkStore(int targetNumberOfSubscriptions, RecoveryPointAdapter adapter)` Initialize self with a target number of subscriptions to pool and the specified recovery point adapter.
`MemoryBookmarkStore(int targetNumberOfSubscriptions, RecoveryPointAdapter adapter, RecoveryPointFactory factory)` Initialize self with a target number of subscriptions to pool and the specified recovery point adapter.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`adapterUpdate(Field subId, BookmarkField bookmark)` Used inernally to update the RecoveryPointAdapter if there is one.
`void`	`close()` Closes down the bookmark store.
`void`	`discard(Field subId, long bookmarkSeqNo)` Call this when you want to mark the message specified by the subscription ID and the bookmark sequence number as discarded, indicating that the application has completed processing the message.
`void`	`discard(Message message)` Call this when you want to mark the provided message as discarded, indicating that the application has completed processing the message.
`protected MemoryBookmarkStore.Subscription`	`find(Field subId)` Finds and returns the Subscription object for the specified subscription id (subId).
`Field`	`getMostRecent(Field subId)` Call this when you want to return the correct recovery point for resubscription of the provided subID from the BookmarkStore.
`Field`	`getMostRecent(Field subId, boolean useList)` Call this when you want to return the correct recovery point for resubscription of the provided subID from the BookmarkStore.
`long`	`getOldestBookmarkSeq(Field subId)` Call this when you want to retrieve the sequence number of the oldest bookmark in the store.
`int`	`getServerVersion()` Called by Client when connected to an AMPS server in order to retrieve the version number of the server.
`boolean`	`isDiscarded(Message message)` Called for each arriving message to determine if the application has already processed and discarded this message.
`long`	`log(Message message)` Called internally by the Client to log a bookmark to the persistent log.
`void`	`persisted(Field subId, BookmarkField bookmark)` Called internally by the Client to record the last persisted message in the transaction log of the connected AMPS server to all of its sync replication destinations.
`void`	`persisted(Field subId, long bookmark)` Deprecated. use `persisted(Field, BookmarkField)` instead.
`void`	`purge()` Remove all entries in the bookmark store, completely clearing all record of messages received and discarded.
`void`	`purge(Field subId_)` Call this when you want to purge the contents of this store for a given subscription ID.
`void`	`setRecoveryPointFactory(RecoveryPointFactory factory_)` Change the RecoveryPointFactory used by this store for its adapter.
`void`	`setResizeHandler(BookmarkStoreResizeHandler handler)` Called this when you want to set a resize handler that is invoked when the store needs to resize.
`void`	`setServerVersion(int version)` Called internally by the Client when connected to an AMPS server to indicate what version the server is.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _adapter
```
protected RecoveryPointAdapter _adapter
```
    Optional recovery point adapter used to persist bookmark replay recovery state for each subscription.
  - _factory
```
protected RecoveryPointFactory _factory
```
- Constructor Detail
  - MemoryBookmarkStore
```
public MemoryBookmarkStore()
```
  - MemoryBookmarkStore
```
public MemoryBookmarkStore(int targetNumberOfSubscriptions)
```
  - MemoryBookmarkStore
```
public MemoryBookmarkStore(int targetNumberOfSubscriptions,
                           RecoveryPointAdapter adapter)
                    throws AMPSException
```
    Initialize self with a target number of subscriptions to pool and the specified recovery point adapter.
    
    Parameters:
    
    targetNumberOfSubscriptions - The number of subscriptions this store will initially create in its pool.
    
    adapter - Recovery point adapter this instance will call with recovery point state for each of its subscriptions. The adapter can persist this state to an external store and retrieve it on application restart so that bookmark replay subscriptions can be continued approximately where they left off (with the possible delivery of some duplicate messages). The adapter will be given FixedRecoveryPoints.
    
    Throws:
    
    AMPSException - If the given adapter throws an exception during recovery.
  - MemoryBookmarkStore
```
public MemoryBookmarkStore(int targetNumberOfSubscriptions,
                           RecoveryPointAdapter adapter,
                           RecoveryPointFactory factory)
                    throws AMPSException
```
    Initialize self with a target number of subscriptions to pool and the specified recovery point adapter.
    
    Parameters:
    
    targetNumberOfSubscriptions - The number of subscriptions this store will initially create in its pool.
    
    adapter - Recovery point adapter this instance will call with recovery point state for each of its subscriptions. The adapter can persist this state to an external store and retrieve it on application restart so that bookmark replay subscriptions can be continued approximately where they left off (with the possible delivery of some duplicate messages).
    
    factory - RecoveryPointFactory that will produce RecoveryPoints for the adapter.
    
    Throws:
    
    AMPSException - If the given adapter throws an exception during recovery.
- Method Detail
  - setRecoveryPointFactory
```
public void setRecoveryPointFactory(RecoveryPointFactory factory_)
                             throws AMPSException
```
    Change the RecoveryPointFactory used by this store for its adapter.
    
    Parameters:
    
    factory_ - The new RecoveryPointFactory
    
    Throws:
    
    AMPSException - if the factory_ parameter is null or the recovery point adapter is null.
  - log
```
public long log(Message message)
         throws AMPSException
```
    Description copied from interface: BookmarkStore
    
    Called internally by the Client to log a bookmark to the persistent log.
    
    Specified by:
    
    log in interface BookmarkStore
    
    Parameters:
    
    message - The message containing the bookmark to log.
    
    Returns:
    
    the corresponding bookmark sequence number for this bookmark.
    
    Throws:
    
    AMPSException - Thrown when the message cannot be logged.
  - discard
```
public void discard(Field subId,
                    long bookmarkSeqNo)
             throws AMPSException
```
    Description copied from interface: BookmarkStore
    
    Call this when you want to mark the message specified by the subscription ID and the bookmark sequence number as discarded, indicating that the application has completed processing the message. Marking a message as discarded means that the message will not be replayed when the subscription resumes. Recommended to use discard(Message) instead for performance.
    
    Specified by:
    
    discard in interface BookmarkStore
    
    Parameters:
    
    subId - The subscription ID of the bookmark.
    
    bookmarkSeqNo - The bookmark sequence number.
    
    Throws:
    
    AMPSException - Thrown when the specified bookmark cannot be discareded.
  - discard
```
public void discard(Message message)
             throws AMPSException
```
    Description copied from interface: BookmarkStore
    
    Call this when you want to mark the provided message as discarded, indicating that the application has completed processing the message. Marking a message as discarded means that the message will not be replayed when the subscription resumes.
    
    Specified by:
    
    discard in interface BookmarkStore
    
    Parameters:
    
    message - Message to be marked as discarded.
    
    Throws:
    
    AMPSException - Thrown when the specified message cannot be discareded.
  - getMostRecent
```
public Field getMostRecent(Field subId)
                    throws AMPSException
```
    Description copied from interface: BookmarkStore
    
    Call this when you want to return the correct recovery point for resubscription of the provided subID from the BookmarkStore. This is a single bookmark or (more often) a comma-delimited list of bookmarks.
    
    Specified by:
    
    getMostRecent in interface BookmarkStore
    
    Parameters:
    
    subId - The subscription ID of the most recent bookmark.
    
    Returns:
    
    A Field containing the correct recovery point to use for resubscriptions.
    
    Throws:
    
    AMPSException - Thrown when the store cannot produce a recovery point for the specified subID.
  - getMostRecent
```
public Field getMostRecent(Field subId,
                           boolean useList)
                    throws AMPSException
```
    Description copied from interface: BookmarkStore
    
    Call this when you want to return the correct recovery point for resubscription of the provided subID from the BookmarkStore. This is a single bookmark or (more often) a comma-delimited list of bookmarks.
    
    Specified by:
    
    getMostRecent in interface BookmarkStore
    
    Parameters:
    
    subId - The subscription ID of the most recent bookmark.
    
    useList - In the case where the store has not received any persisted acks, it will build a list of bookmarks based on the last discarded for each publisher if true (default).
    
    Returns:
    
    A Field containing the correct recovery point to use for resubscriptions.
    
    Throws:
    
    AMPSException - Thrown when the store cannot produce a recovery point for the specified subID.
  - isDiscarded
```
public boolean isDiscarded(Message message)
                    throws AMPSException
```
    Description copied from interface: BookmarkStore
    
    Called for each arriving message to determine if the application has already processed and discarded this message. Returns 'true' if the bookmark is in the log and marked as discarded and should therefore not be reprocessed. Otherwise, returns 'false'. Generally, isDiscarded is called by the Client however, if needed it can be called by the application as well.
    
    Specified by:
    
    isDiscarded in interface BookmarkStore
    
    Parameters:
    
    message - Message used to determine if the application has already processed and discarded the message.
    
    Returns:
    
    Whether the message is already in the store and marked as discarded.
    
    Throws:
    
    AMPSException - Thrown when the store cannot determine if the message is discarded.
  - persisted
```
@Deprecated
public void persisted(Field subId,
                                  long bookmark)
                           throws AMPSException
```
    Deprecated. use persisted(Field, BookmarkField) instead.
    
    Old style of setting a persisted bookmark no longer used.
    
    Specified by:
    
    persisted in interface BookmarkStore
    
    Parameters:
    
    subId - The subId associated with the bookmark to be persisted.
    
    bookmark - The bookmark to be persisted.
    
    Throws:
    
    AMPSException - If the bookmark was unable to be persisted to the bookmark store.
  - persisted
```
public void persisted(Field subId,
                      BookmarkField bookmark)
               throws AMPSException
```
    Description copied from interface: BookmarkStore
    
    Called internally by the Client to record the last persisted message in the transaction log of the connected AMPS server to all of its sync replication destinations.
    
    Specified by:
    
    persisted in interface BookmarkStore
    
    Parameters:
    
    subId - The subscription ID for the message.
    
    bookmark - The bookmark containing the message.
    
    Throws:
    
    AMPSException - Thrown if the store is unable to record information in the store.
  - find
```
protected MemoryBookmarkStore.Subscription find(Field subId)
```
    Finds and returns the Subscription object for the specified subscription id (subId).
    
    Parameters:
    
    subId - The subId to find or create a Subscription for.
    
    Returns:
    
    The Subscription for the given subId.
  - purge
```
public void purge()
           throws AMPSException
```
    Remove all entries in the bookmark store, completely clearing all record of messages received and discarded.
    
    Specified by:
    
    purge in interface BookmarkStore
    
    Throws:
    
    AMPSException - Thrown if the store is unable to remove the contents.
  - purge
```
public void purge(Field subId_)
           throws AMPSException
```
    Description copied from interface: BookmarkStore
    
    Call this when you want to purge the contents of this store for a given subscription ID. Removes any tracking history associated with publishers and received messages, and may delete or truncate on-disk representations as well. NOTE: This should only be called when the specified subscription isn't active (i.e. before it's subscribed or after it's unsubscribed).
    
    Specified by:
    
    purge in interface BookmarkStore
    
    Parameters:
    
    subId_ - The identifier of the subscription to purge.
    
    Throws:
    
    AMPSException - Thrown if the store is unable to remove information for the subscription.
  - getOldestBookmarkSeq
```
public long getOldestBookmarkSeq(Field subId)
                          throws AMPSException
```
    Description copied from interface: BookmarkStore
    
    Call this when you want to retrieve the sequence number of the oldest bookmark in the store.
    
    Specified by:
    
    getOldestBookmarkSeq in interface BookmarkStore
    
    Parameters:
    
    subId - The subscription ID for the oldest bookmark in the store.
    
    Returns:
    
    The internal sequence number of the oldest bookmark in the store.
    
    Throws:
    
    AMPSException - The operation could not successfully be completed.
  - setResizeHandler
```
public void setResizeHandler(BookmarkStoreResizeHandler handler)
```
    Description copied from interface: BookmarkStore
    
    Called this when you want to set a resize handler that is invoked when the store needs to resize.
    
    Specified by:
    
    setResizeHandler in interface BookmarkStore
    
    Parameters:
    
    handler - The handler to invoke for the resize.
  - setServerVersion
```
public void setServerVersion(int version)
```
    Description copied from interface: BookmarkStore
    
    Called internally by the Client when connected to an AMPS server to indicate what version the server is. A bookmark store can modify behavior based on the version of the server.
    
    Specified by:
    
    setServerVersion in interface BookmarkStore
    
    Parameters:
    
    version - The version of the AMPS server.
  - getServerVersion
```
public int getServerVersion()
```
    Called by Client when connected to an AMPS server in order to retrieve the version number of the server. Returns retrieved version number.
    
    Returns:
    
    the server version, represented as an integer
  - close
```
public void close()
           throws AMPSException
```
    Closes down the bookmark store. If a recovery point adapter was specified during construction, this will call close() on it.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    AMPSException
  - adapterUpdate
```
protected void adapterUpdate(Field subId,
                             BookmarkField bookmark)
                      throws java.io.IOException
```
    Used inernally to update the RecoveryPointAdapter if there is one.
    
    Parameters:
    
    subId - The subId to update.
    
    bookmark - The latest bookmark.
    
    Throws:
    
    java.io.IOException - If there is an exception from the adapter.

Class MemoryBookmarkStore

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_adapter

_factory

Constructor Detail

MemoryBookmarkStore

MemoryBookmarkStore

MemoryBookmarkStore

MemoryBookmarkStore

Method Detail

setRecoveryPointFactory

log

discard

discard

getMostRecent

getMostRecent

isDiscarded

persisted

persisted

find

purge

purge

getOldestBookmarkSeq

setResizeHandler

setServerVersion

getServerVersion

close

adapterUpdate