org.springframework.amqp.rabbit.listener

Class ConsumeOkEvent

java.lang.Object

java.util.EventObject

org.springframework.context.ApplicationEvent

org.springframework.amqp.event.AmqpEvent

org.springframework.amqp.rabbit.listener.ConsumeOkEvent

All Implemented Interfaces:

Serializable

public class ConsumeOkEvent
extends AmqpEvent

An AmqpEvent emitted by the listener container when consumer is subscribed to the queue.

Since:

1.7.5

Author:

Gary Russell, Artem Bilan

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ConsumeOkEvent(Object source, String queue, String consumerTag) Instantiate a ConsumeOkEvent based on the provided consumer, queue and consumer tag.

Method Summary

Modifier and Type	Method and Description
String	getConsumerTag() Obtain the consumer tag assigned to the consumer.
String	getQueue() Obtain the queue name a consumer has been subscribed.
String	toString()

Methods inherited from class org.springframework.context.ApplicationEvent

getTimestamp

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumeOkEvent

public ConsumeOkEvent(Object source,
                      String queue,
                      String consumerTag)

Instantiate a ConsumeOkEvent based on the provided consumer, queue and consumer tag.

Parameters:

source - the consumer subscribed to the queue

queue - the queue to consume

consumerTag - the tag indicate a consumer subscription

Method Detail

getQueue

public String getQueue()

Obtain the queue name a consumer has been subscribed.

Returns:

the queue name a consumer subscribed.

Since:

1.7.7

getConsumerTag

public String getConsumerTag()

Obtain the consumer tag assigned to the consumer.

Returns:

the consumer tag for subscription.

Since:

1.7.7

toString

public String toString()

Overrides:

toString in class EventObject