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

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

All Implemented Interfaces:

Subscription

Enclosing class:

MemoryBookmarkStore
```
protected static class MemoryBookmarkStore.Subscription
extends java.lang.Object
implements 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 java.lang.String _recoveryTimestamp
The last-modified timestamp, if any, from a RecoveryPointAdapter before recovery is initiated.

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`_recoveryTimestamp` The last-modified timestamp, if any, from a RecoveryPointAdapter before recovery is initiated.

Constructor Summary

Constructors
Constructor and Description

Subscription()

Subscription(Field subscriptionId)

Constructors
Constructor and Description
`Subscription()`
`Subscription(Field subscriptionId)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`discard(long index)`
`Field`	`getMostRecent()`
`Field`	`getMostRecentList(boolean useList)`
`long`	`getOldestBookmarkSeq()`
`BookmarkRangeField`	`getRange()`
`java.lang.String`	`getRecoveryTimestamp()`
`void`	`init(Field subId, MemoryBookmarkStore parent)`
`boolean`	`isDiscarded(BookmarkField bookmark)` Check to see if this message is older than the most recent one seen, and if it is, check if it discarded.
`long`	`log(BookmarkField bookmark)`
`void`	`reset()` Reset the state of this subscription object such that it can be returned to the pool for reuse.
`void`	`setLastPersisted(BookmarkField bookmark)`
`void`	`setLastPersisted(long bookmark)` Deprecated. use `setLastPersisted(BookmarkField)` instead.
`protected void`	`setRecoveryTimestamp(java.lang.String rts)`
`void`	`setResizeHandler(BookmarkStoreResizeHandler handler, BookmarkStore store)`

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

- Field Detail
  - _recoveryTimestamp
```
protected volatile java.lang.String _recoveryTimestamp
```
    The last-modified timestamp, if any, from a RecoveryPointAdapter before recovery is initiated. When this is not null we intend to include it in the list of bookmarks returned by getMostRecentList() until a message is discarded on the sub or the sub state is purged.
- Constructor Detail
  - Subscription
```
public Subscription(Field subscriptionId)
```
  - Subscription
```
public Subscription()
```
- Method Detail
  - reset
```
public void reset()
```
    Reset the state of this subscription object such that it can be returned to the pool for reuse.
  - init
```
public void init(Field subId,
                 MemoryBookmarkStore parent)
```
  - getRecoveryTimestamp
```
public java.lang.String getRecoveryTimestamp()
```
  - setRecoveryTimestamp
```
protected final void setRecoveryTimestamp(java.lang.String rts)
```
  - log
```
public long log(BookmarkField bookmark)
         throws java.io.IOException,
                CommandException
```
    Specified by:
    
    log in interface Subscription
    
    Throws:
    
    java.io.IOException
    
    CommandException
  - discard
```
public void discard(long index)
             throws java.io.IOException
```
    Specified by:
    
    discard in interface Subscription
    
    Throws:
    
    java.io.IOException
  - isDiscarded
```
public boolean isDiscarded(BookmarkField bookmark)
```
    Check to see if this message is older than the most recent one seen, and if it is, check if it discarded.
    
    Specified by:
    
    isDiscarded in interface Subscription
  - getRange
```
public BookmarkRangeField getRange()
```
    Specified by:
    
    getRange in interface Subscription
  - getMostRecent
```
public Field getMostRecent()
```
    Specified by:
    
    getMostRecent in interface Subscription
  - getMostRecentList
```
public Field getMostRecentList(boolean useList)
```
    Specified by:
    
    getMostRecentList in interface Subscription
  - setLastPersisted
```
@Deprecated
public void setLastPersisted(long bookmark)
                                  throws java.io.IOException
```
    Deprecated. use setLastPersisted(BookmarkField) instead.
    
    Old style of setting a persisted bookmark no longer used.
    
    Specified by:
    
    setLastPersisted in interface Subscription
    
    Parameters:
    
    bookmark - The bookmark to be persisted.
    
    Throws:
    
    java.io.IOException - if the bookmark was unable to be persisted to the bookmark store.
  - setLastPersisted
```
public void setLastPersisted(BookmarkField bookmark)
                      throws java.io.IOException
```
    Specified by:
    
    setLastPersisted in interface Subscription
    
    Throws:
    
    java.io.IOException
  - getOldestBookmarkSeq
```
public long getOldestBookmarkSeq()
```
    Specified by:
    
    getOldestBookmarkSeq in interface Subscription
  - setResizeHandler
```
public void setResizeHandler(BookmarkStoreResizeHandler handler,
                             BookmarkStore store)
```
    Specified by:
    
    setResizeHandler in interface Subscription

Class MemoryBookmarkStore.Subscription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_recoveryTimestamp

Constructor Detail

Subscription

Subscription

Method Detail

reset

init

getRecoveryTimestamp

setRecoveryTimestamp

log

discard

isDiscarded

getRange

getMostRecent

getMostRecentList

setLastPersisted

setLastPersisted

getOldestBookmarkSeq

setResizeHandler