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

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

All Implemented Interfaces:

Subscription

Enclosing class:

LoggedBookmarkStore
```
protected static class LoggedBookmarkStore.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 of the backing bookmark log file, just before recovery is initiated.

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`_recoveryTimestamp` The last-modified timestamp of the backing bookmark log file, just before recovery is initiated.

Constructor Summary

Constructors
Constructor and Description

Subscription()

Constructors
Constructor and Description
`Subscription()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`discard(long index)`
`Field`	`getLastPersisted()`
`Field`	`getMostRecent()`
`protected Field`	`getMostRecent(boolean updateRecovery_)`
`Field`	`getMostRecentList(boolean useList)`
`long`	`getOldestBookmarkSeq()`
`BookmarkRangeField`	`getRange()`
`java.lang.String`	`getRecoveryTimestamp()`
`void`	`init(Field subscriptionId, LoggedBookmarkStore parent)`
`boolean`	`isDiscarded(BookmarkField bookmark)` Check to see if this message is older than the most recent one seen, and if it is, then check to see if it is discarded.
`boolean`	`justRecovered()` Call on a Subscription object just after recovery is performed to convert logged entries into recovery entries and set the publishers cache state to the earliest sequence seen for each publisher minus one.
`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.
`static void`	`setPublishersToDiscarded(java.util.List<BookmarkRingBuffer.Entry> active, java.util.Map<java.lang.Long,java.lang.Long> publishers)`
`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 of the backing bookmark log file, just 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. Originally we thought the recovery timestamp could be stored as the last-persisted for each recovered sub, but it must be stored separately here because setting it as a sub's last-persisted could cause us to lose a persisted ack that is earlier than the backing file's last-modified time.
- Constructor Detail
  - 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 subscriptionId,
                 LoggedBookmarkStore parent)
          throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - 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)
                    throws java.io.IOException
```
    Check to see if this message is older than the most recent one seen, and if it is, then check to see if it is discarded.
    
    Specified by:
    
    isDiscarded in interface Subscription
    
    Throws:
    
    java.io.IOException
  - getLastPersisted
```
public Field getLastPersisted()
```
  - getRange
```
public BookmarkRangeField getRange()
```
    Specified by:
    
    getRange in interface Subscription
  - getMostRecent
```
public Field getMostRecent()
```
    Specified by:
    
    getMostRecent in interface Subscription
  - getMostRecent
```
protected Field getMostRecent(boolean updateRecovery_)
```
  - 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 - Used to be the bookmark sequence number.
    
    Throws:
    
    java.io.IOException
  - 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
  - justRecovered
```
public boolean justRecovered()
```
    Call on a Subscription object just after recovery is performed to convert logged entries into recovery entries and set the publishers cache state to the earliest sequence seen for each publisher minus one. NOTE: If after recovery lastDiscarded for this sub is null (i.e. nothing was discarded) and lastPersisted is null or EPOCH (i.e. no persisted ack was recorded in the log), then we can throw away this subscription state and return this Subscription object to the pool.
    
    Returns:
    
    Indicates whether this subscription's state was reset (because it's undeeded due to the lack of any discards and persisted acks) and this object should be returned to the Subscription pool.
  - setPublishersToDiscarded
```
public static void setPublishersToDiscarded(java.util.List<BookmarkRingBuffer.Entry> active,
                                            java.util.Map<java.lang.Long,java.lang.Long> publishers)
```
  - setResizeHandler
```
public void setResizeHandler(BookmarkStoreResizeHandler handler,
                             BookmarkStore store)
```
    Specified by:
    
    setResizeHandler in interface Subscription

Class LoggedBookmarkStore.Subscription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_recoveryTimestamp

Constructor Detail

Subscription

Method Detail

reset

init

getRecoveryTimestamp

setRecoveryTimestamp

log

discard

isDiscarded

getLastPersisted

getRange

getMostRecent

getMostRecent

getMostRecentList

setLastPersisted

setLastPersisted

getOldestBookmarkSeq

justRecovered

setPublishersToDiscarded

setResizeHandler