com.ibm.broker.replay.api
Class ReplaySignature

java.lang.Object
  extended bycom.ibm.broker.replay.api.ReplaySignature

public class ReplaySignature
extends java.lang.Object

ReplaySignature is provided when a ReplayMessageConsumer is created to demarcate the signature of the replay flow, in terms of message sequence numbers and timestamps (it also offers control of timing and cadence).


Constructor Summary
ReplaySignature()
           
 
Method Summary
 long getEnd()
          Gets the ending point of the replay request.
 long getSamplingInterval()
          Gets the sampling interval of the replay request.
 long getStart()
          Gets the starting point of the replay request.
 long getThrottlingInterMessageTime()
          Gets the inter-message throttling time of this replay request.
 boolean isEndNever()
          Queries whether the ending point of the replay request is "NEVER".
 boolean isEndSequenceNumber()
          Queries whether the ending point of the replay request is a sequence number.
 boolean isEndTimestamp()
          Queries whether the ending point of the replay request is a timestamp.
 boolean isSampled()
          Queries whether the replay request is sampled.
 boolean isSampledByNumberOfMessages()
          Queries whether the sampling is done by number of messages.
 boolean isSampledByTime()
          Queries whether the sampling is done by time.
 boolean isSampledOnAggregatedTopics()
          Queries whether the sampling is done on all topics requested in this replay.
 boolean isSampledOnTopic()
          Queries whether the sampling is done on a per-topic basis.
 boolean isStartNow()
          Queries whether the starting point of the replay request is "NOW".
 boolean isStartSequenceNumber()
          Queries whether the starting point of the replay request is a sequence number.
 boolean isStartTimestamp()
          Queries whether the starting point of the replay request is a timestamp.
 boolean isTimingAsap()
          Queries whether the timing of the replay request is ASAP.
 boolean isTimingOriginal()
          Queries whether the timing of the replay request is original (the same cadence as the messages were originally published in).
 boolean isTimingThrottled()
          Queries whether the timing of the replay request is throttled.
 void setEndAsSequenceNumber(long l)
          Sets the ending point of the replay request to be an explicit sequence number.
 void setEndAsTimestamp(long l)
          Sets the ending point of the replay request to be an explicit timestamp.
 void setEndToNever()
          Sets the ending point of the replay request to "NEVER".
 void setSamplingOnAggregatedTopics()
          Sets the sampling of the replay request to be on all topics requested in this replay.
 void setSamplingOnTopic()
          Sets the sampling of the replay request to be on a per-topic basis.
 void setSamplingToByNumberOfMessages(long l)
          Sets the sampling of the replay request to be done by number of messages.
 void setSamplingToByTime(long l)
          Sets the sampling of the replay request to be done by time.
 void setStartAsSequenceNumber(long l)
          Sets the starting point of the replay request to be an explicit sequence number.
 void setStartAsTimestamp(long l)
          Sets the starting point of the replay request to be an explicit timestamp.
 void setStartToNow()
          Sets the starting point of the replay request to "NOW".
 void setTimingToAsap()
          Sets the timing of the replay request to be ASAP.
 void setTimingToOriginal()
          Sets the timing of the replay request to be original (the same cadence as the messages were originally published in).
 void setTimingToThrottled(long l)
          Sets the timing of the replay request to be throttled with a certain amount of time between each message delivery.
 java.lang.String toString()
          Generates a String representing this replay request.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReplaySignature

public ReplaySignature()
Method Detail

getStart

public long getStart()
Gets the starting point of the replay request. Use the boolean query methods to determine if this is a sequence number or a timestamp.

Returns:
The long containing the replay starting point.

setStartToNow

public void setStartToNow()
Sets the starting point of the replay request to "NOW". This does not infer a time, merely that the request should attach directly to "near-live" at the earliest opportunity.


setStartAsTimestamp

public void setStartAsTimestamp(long l)
Sets the starting point of the replay request to be an explicit timestamp.

Parameters:
l - a long containing a millisecond value (measured from the epoch).

setStartAsSequenceNumber

public void setStartAsSequenceNumber(long l)
Sets the starting point of the replay request to be an explicit sequence number.

Parameters:
l - a long containing a sequence number.

isStartNow

public boolean isStartNow()
Queries whether the starting point of the replay request is "NOW".

Returns:
True if the starting point is set to "NOW", false otherwise.

isStartTimestamp

public boolean isStartTimestamp()
Queries whether the starting point of the replay request is a timestamp.

Returns:
True if the starting point is a timestamp, false otherwise.

isStartSequenceNumber

public boolean isStartSequenceNumber()
Queries whether the starting point of the replay request is a sequence number.

Returns:
True if the starting point is a sequence number, false otherwise.

getEnd

public long getEnd()
Gets the ending point of the replay request. Use the boolean query methods to determine if this is a sequence number or a timestamp.

Returns:
The long containing the replay ending point.

setEndToNever

public void setEndToNever()
Sets the ending point of the replay request to "NEVER". This does not infer a time, merely that the request should not terminate unless explicitly closed.


setEndAsTimestamp

public void setEndAsTimestamp(long l)
Sets the ending point of the replay request to be an explicit timestamp.

Parameters:
l - a long containing a millisecond value (measured from the epoch).

setEndAsSequenceNumber

public void setEndAsSequenceNumber(long l)
Sets the ending point of the replay request to be an explicit sequence number.

Parameters:
l - a long containing a sequence number.

isEndNever

public boolean isEndNever()
Queries whether the ending point of the replay request is "NEVER".

Returns:
True if the ending point is set to "NEVER", false otherwise.

isEndTimestamp

public boolean isEndTimestamp()
Queries whether the ending point of the replay request is a timestamp.

Returns:
True if the ending point is a timestamp, false otherwise.

isEndSequenceNumber

public boolean isEndSequenceNumber()
Queries whether the ending point of the replay request is a sequence number.

Returns:
True if the ending point is a sequence number, false otherwise.

setTimingToAsap

public void setTimingToAsap()
Sets the timing of the replay request to be ASAP.


setTimingToOriginal

public void setTimingToOriginal()
Sets the timing of the replay request to be original (the same cadence as the messages were originally published in).


isTimingAsap

public boolean isTimingAsap()
Queries whether the timing of the replay request is ASAP.

Returns:
True if the timing is ASAP, false otherwise.

isTimingOriginal

public boolean isTimingOriginal()
Queries whether the timing of the replay request is original (the same cadence as the messages were originally published in).

Returns:
True if the timing is original, false otherwise.

getThrottlingInterMessageTime

public long getThrottlingInterMessageTime()
Gets the inter-message throttling time of this replay request.

Returns:
The long containing the inter-message time.

setTimingToThrottled

public void setTimingToThrottled(long l)
Sets the timing of the replay request to be throttled with a certain amount of time between each message delivery.

Parameters:
l - a long containing the inter-message time.

isTimingThrottled

public boolean isTimingThrottled()
Queries whether the timing of the replay request is throttled.

Returns:
True if the timing is throttled, false otherwise.

getSamplingInterval

public long getSamplingInterval()
Gets the sampling interval of the replay request. Use the boolean query methods to determine if this refers to sampling by time or number of messages.

Returns:
The long containing the replay sampling interval.

setSamplingOnTopic

public void setSamplingOnTopic()
Sets the sampling of the replay request to be on a per-topic basis. Note that per-topic sampling can be either by time or number of messages.


setSamplingOnAggregatedTopics

public void setSamplingOnAggregatedTopics()
Sets the sampling of the replay request to be on all topics requested in this replay. Note that aggregated-topic sampling can be either by time or number of messages.


setSamplingToByTime

public void setSamplingToByTime(long l)
Sets the sampling of the replay request to be done by time. Note that this is orthogonal to whether the sampling is per-topic or aggregated.

Parameters:
l - a long containing the sampling interval.

setSamplingToByNumberOfMessages

public void setSamplingToByNumberOfMessages(long l)
Sets the sampling of the replay request to be done by number of messages. Note that this is orthogonal to whether the sampling is per-topic or aggregated.

Parameters:
l - a long containing the sampling interval.

isSampled

public boolean isSampled()
Queries whether the replay request is sampled.

Returns:
True if the replay request is sampled, false otherwise.

isSampledOnTopic

public boolean isSampledOnTopic()
Queries whether the sampling is done on a per-topic basis. Note that per-topic sampling can be either by time or number of messages.

Returns:
True if the sampling is per-topic, false otherwise.

isSampledOnAggregatedTopics

public boolean isSampledOnAggregatedTopics()
Queries whether the sampling is done on all topics requested in this replay. Note that aggregated-topic sampling can be either by time or number of messages, and if there is only one topic in this replay request (i.e. no wildcards were supplied) then this setting and the per-topic setting will be the same.

Returns:
True if the sampling is per-topic, false otherwise.

isSampledByTime

public boolean isSampledByTime()
Queries whether the sampling is done by time. Note that this is orthogonal to whether the sampling is per-topic or aggregated.

Returns:
True if the sampling is done by time, false otherwise.

isSampledByNumberOfMessages

public boolean isSampledByNumberOfMessages()
Queries whether the sampling is done by number of messages. Note that this is orthogonal to whether the sampling is per-topic or aggregated.

Returns:
True if the sampling is done by number of messages, false otherwise.

toString

public java.lang.String toString()
Generates a String representing this replay request.

Returns:
A String containing the details of this replay request.