Skip navigation links

com.oracle.cep.cluster.ha.adapter
Interface QueueTrimmingProtocol

All Known Implementing Classes:

QueueTrimmingAdapter.BasicQueueTrimmingProtocol

public interface QueueTrimmingProtocol

Protocol to use for queue trimming.

Method Summary

boolean	disableEventTrimming(java.lang.Object event) Conditionally disables event trimming based on the passed in event.
void	enableEventTrimming(java.lang.Object trimmingKey) Enables event trimming using the passed in trimming key.
boolean	eventTrimmingDisabled()
boolean	eventTrimmingEnabled()
java.lang.Object	getTrimmingKey()
void	resetEventTrimming() Unconditionally turns off event trimming if it is on.
boolean	trimLastEvent() Returns whether or not to trim the last event examined.
int	trimQueue(java.lang.Object key) Trim the queue using the key.

Method Detail

trimQueue

public int trimQueue(java.lang.Object key)

Trim the queue using the key.

Parameters:

key - to use for queue trimming

Returns:

the number of events trimmed

trimLastEvent

public boolean trimLastEvent()

Returns whether or not to trim the last event examined. For example, when trimming using a monotonic time value which may not be unique, we do not trim the last event since only events with a time value that precedes the trimming key should be trimmed.

Returns:

whether this protocol trims the last event

disableEventTrimming

public boolean disableEventTrimming(java.lang.Object event)

Conditionally disables event trimming based on the passed in event.

Parameters:

event -

Returns:

whether or not event trimming was disabled

eventTrimmingDisabled

public boolean eventTrimmingDisabled()

Returns:

whether or not event trimming is currently disabled

eventTrimmingEnabled

public boolean eventTrimmingEnabled()

Returns:

whether or not event trimming is currently enabled

enableEventTrimming

public void enableEventTrimming(java.lang.Object trimmingKey)

Enables event trimming using the passed in trimming key. Event trimming is enabled when an event could not be trimmed from the queue because it has not yet been output to the queue. This prevents events from entering the queue which could have already been trimmed thereby lessening the likelihood that duplicates are produced at failover.

Parameters:

trimmingKey - the key to use for event trimming

getTrimmingKey

public java.lang.Object getTrimmingKey()

Returns:

the current trimming key, null if the event trimming is disabled

resetEventTrimming

public void resetEventTrimming()

Unconditionally turns off event trimming if it is on.