com.crankuptheamps.client

Class MemoryBookmarkStore.Subscription

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.

Constructor Summary

Constructors

Constructor and Description
Subscription() Default constructor that creates a Subscription object and initializes its state.
Subscription(Field subscriptionId) Constructor that creates a Subscription object with the provided subscription ID and initializes its state.

Method Summary

Modifier and Type	Method and Description
void	discard(long index) Discard a bookmark at the specified index.
Field	getMostRecent() Get the most recent bookmark.
Field	getMostRecentList(boolean useList)
long	getOldestBookmarkSeq() Get the oldest bookmark sequence number.
BookmarkRangeField	getRange() Gets the range of bookmarks stored in this bookmark store.
java.lang.String	getRecoveryTimestamp() Get the last-modified timestamp used for recovery.
void	init(Field subId, MemoryBookmarkStore parent) Initialize the Subscription with a new subscription ID and assign a reference to the parent bookmark store.
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) Log a bookmark, either a single bookmark or a list of bookmarks.
void	reset() Reset the state of this subscription object such that it can be returned to the pool for reuse.
void	setLastPersisted(BookmarkField bookmark) Set the last persisted bookmark.
void	setLastPersisted(long bookmark) Deprecated. use setLastPersisted(BookmarkField) instead.
protected void	setRecoveryTimestamp(java.lang.String rts) The last-modified timestamp, if any, from a RecoveryPointAdapter before recovery is initiated.
void	setResizeHandler(BookmarkStoreResizeHandler handler, BookmarkStore store) Set a resize handler for the bookmark 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)

Constructor that creates a Subscription object with the provided subscription ID and initializes its state.

Parameters:

subscriptionId - The subscription ID to associate with this Subscription.

Subscription

public Subscription()

Default constructor that creates a Subscription object and initializes its state.

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)

Initialize the Subscription with a new subscription ID and assign a reference to the parent bookmark store.

Parameters:

subId - The new subscription ID to associate with this Subscription.

parent - The parent MemoryBookmarkStore to which this Subscription belongs.

getRecoveryTimestamp

public java.lang.String getRecoveryTimestamp()

Get the last-modified timestamp used for recovery.

Returns:

The last-modified timestamp used for recovery.

setRecoveryTimestamp

protected final void setRecoveryTimestamp(java.lang.String rts)

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.

Parameters:

rts - The recovery timestamp to set.

log

public long log(BookmarkField bookmark)
         throws java.io.IOException,
                CommandException

Log a bookmark, either a single bookmark or a list of bookmarks.

Specified by:

log in interface Subscription

Parameters:

bookmark - The bookmark to log.

Returns:

The sequence number associated with the logged bookmark.

Throws:

java.io.IOException - Thrown when an IO operation fails.

CommandException - Thrown when a command operation fails.

discard

public void discard(long index)
             throws java.io.IOException

Discard a bookmark at the specified index.

Specified by:

discard in interface Subscription

Parameters:

index - The index of the bookmark to discard.

Throws:

java.io.IOException - Thrown when an IO operation fails.

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

Parameters:

bookmark - The bookmark containing the publisher ID and sequence number.

Returns:

True if the message is discarded or in-flight, false otherwise.

getRange

public BookmarkRangeField getRange()

Gets the range of bookmarks stored in this bookmark store.

Specified by:

getRange in interface Subscription

Returns:

A copy of the bookmark range.

getMostRecent

public Field getMostRecent()

Get the most recent bookmark.

Specified by:

getMostRecent in interface Subscription

Returns:

A copy of the most recent bookmark.

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

Set the last persisted bookmark.

Specified by:

setLastPersisted in interface Subscription

Parameters:

bookmark - The bookmark to set as the last persisted.

Throws:

java.io.IOException - If an I/O error occurs.

getOldestBookmarkSeq

public long getOldestBookmarkSeq()

Get the oldest bookmark sequence number.

Specified by:

getOldestBookmarkSeq in interface Subscription

Returns:

The sequence number of the oldest bookmark.

setResizeHandler

public void setResizeHandler(BookmarkStoreResizeHandler handler,
                             BookmarkStore store)

Set a resize handler for the bookmark store.

Specified by:

setResizeHandler in interface Subscription

Parameters:

handler - The resize handler to set.

store - The bookmark store to associate with the handler.