org.apache.activemq.broker.region.cursors
Class AbstractStoreCursor

java.lang.Object
  org.apache.activemq.broker.region.cursors.AbstractPendingMessageCursor
      org.apache.activemq.broker.region.cursors.AbstractStoreCursor

All Implemented Interfaces:

PendingMessageCursor, Service, MessageRecoveryListener, UsageListener

public abstract class AbstractStoreCursor
extends AbstractPendingMessageCursor
implements MessageRecoveryListener, UsageListener

Store based cursor

Field Summary

protected boolean	batchResetNeeded
protected boolean	cacheEnabled
protected Destination	regionDestination
protected int	size
protected boolean	storeHasMessages

Fields inherited from class org.apache.activemq.broker.region.cursors.AbstractPendingMessageCursor

audit, enableAudit, maxAuditDepth, maxBatchSize, maxProducersToAudit, memoryUsageHighWaterMark, systemUsage, useCache

Constructor Summary

protected

AbstractStoreCursor(Destination destination)

Method Summary

void	addMessageFirst(MessageReference node) add message to await dispatch
void	addMessageLast(MessageReference node) add message to await dispatch
void	clear() clear all pending messages
protected abstract void	doFillBatch()
protected void	fillBatch()
void	finished()
void	gc() free up any internal buffers
protected abstract int	getStoreSize()
boolean	hasMessagesBufferedToDeliver()
boolean	hasNext()
boolean	isEmpty()
MessageReference	next()
void	onUsageChanged(Usage usage, int oldPercentUsage, int newPercentUsage)
boolean	recoverMessage(Message message)
boolean	recoverMessage(Message message, boolean cached)
void	release() hint to the cursor to release any locks it might have grabbed after a reset
void	remove() remove the message at the cursor position
void	remove(MessageReference node) remove a node
void	reset() reset the cursor
protected abstract void	resetBatch()
int	size()
void	start()
void	stop()

Methods inherited from class org.apache.activemq.broker.region.cursors.AbstractPendingMessageCursor

add, addRecoveredMessage, destroy, getMaxAuditDepth, getMaxBatchSize, getMaxProducersToAudit, getMemoryUsageHighWaterMark, getMessageAudit, getSystemUsage, hasSpace, isDuplicate, isEmpty, isEnableAudit, isFull, isRecoveryRequired, isStarted, isTransient, isUseCache, pageInList, remove, resetForGC, rollback, setEnableAudit, setMaxAuditDepth, setMaxBatchSize, setMaxProducersToAudit, setMemoryUsageHighWaterMark, setMessageAudit, setSystemUsage, setUseCache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.activemq.store.MessageRecoveryListener

hasSpace, recoverMessageReference

Field Detail

regionDestination

protected final Destination regionDestination

cacheEnabled

protected boolean cacheEnabled

batchResetNeeded

protected boolean batchResetNeeded

storeHasMessages

protected boolean storeHasMessages

size

protected int size

Constructor Detail

AbstractStoreCursor

protected AbstractStoreCursor(Destination destination)

Method Detail

start

public final void start()
                 throws Exception

Specified by:

start in interface Service

Overrides:

start in class AbstractPendingMessageCursor

Throws:

Exception

stop

public final void stop()
                throws Exception

Specified by:

stop in interface Service

Overrides:

stop in class AbstractPendingMessageCursor

Throws:

Exception

recoverMessage

public final boolean recoverMessage(Message message)
                             throws Exception

Specified by:

recoverMessage in interface MessageRecoveryListener

Throws:

Exception

recoverMessage

public boolean recoverMessage(Message message,
                              boolean cached)
                       throws Exception

Throws:

Exception

reset

public final void reset()

Description copied from interface: PendingMessageCursor

reset the cursor

Specified by:

reset in interface PendingMessageCursor

Overrides:

reset in class AbstractPendingMessageCursor

release

public void release()

Description copied from interface: PendingMessageCursor

hint to the cursor to release any locks it might have grabbed after a reset

Specified by:

release in interface PendingMessageCursor

Overrides:

release in class AbstractPendingMessageCursor

finished

public final void finished()

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface PendingMessageCursor

Overrides:

hasNext in class AbstractPendingMessageCursor

Returns:

true if there pending messages to dispatch

next

public final MessageReference next()

Specified by:

next in interface PendingMessageCursor

Overrides:

next in class AbstractPendingMessageCursor

Returns:

the next pending message

addMessageLast

public final void addMessageLast(MessageReference node)
                          throws Exception

Description copied from interface: PendingMessageCursor

add message to await dispatch

Specified by:

addMessageLast in interface PendingMessageCursor

Overrides:

addMessageLast in class AbstractPendingMessageCursor

Throws:

IOException

Exception

addMessageFirst

public final void addMessageFirst(MessageReference node)
                           throws Exception

Description copied from interface: PendingMessageCursor

add message to await dispatch

Specified by:

addMessageFirst in interface PendingMessageCursor

Overrides:

addMessageFirst in class AbstractPendingMessageCursor

Throws:

Exception

remove

public final void remove()

Description copied from interface: PendingMessageCursor

remove the message at the cursor position

Specified by:

remove in interface PendingMessageCursor

Overrides:

remove in class AbstractPendingMessageCursor

remove

public final void remove(MessageReference node)

Description copied from interface: PendingMessageCursor

remove a node

Specified by:

remove in interface PendingMessageCursor

Overrides:

remove in class AbstractPendingMessageCursor

onUsageChanged

public final void onUsageChanged(Usage usage,
                                 int oldPercentUsage,
                                 int newPercentUsage)

Specified by:

onUsageChanged in interface UsageListener

clear

public final void clear()

Description copied from interface: PendingMessageCursor

clear all pending messages

Specified by:

clear in interface PendingMessageCursor

Overrides:

clear in class AbstractPendingMessageCursor

gc

public final void gc()

Description copied from interface: PendingMessageCursor

free up any internal buffers

Specified by:

gc in interface PendingMessageCursor

Overrides:

gc in class AbstractPendingMessageCursor

fillBatch

protected final void fillBatch()

Overrides:

fillBatch in class AbstractPendingMessageCursor

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface PendingMessageCursor

Overrides:

isEmpty in class AbstractPendingMessageCursor

Returns:

true if there are no pending messages

hasMessagesBufferedToDeliver

public final boolean hasMessagesBufferedToDeliver()

Specified by:

hasMessagesBufferedToDeliver in interface PendingMessageCursor

Overrides:

hasMessagesBufferedToDeliver in class AbstractPendingMessageCursor

Returns:

true if the cursor has buffered messages ready to deliver

size

public final int size()

Specified by:

size in interface PendingMessageCursor

Overrides:

size in class AbstractPendingMessageCursor

Returns:

the number of pending messages

doFillBatch

protected abstract void doFillBatch()
                             throws Exception

Throws:

Exception

resetBatch

protected abstract void resetBatch()

getStoreSize

protected abstract int getStoreSize()