Package interlok.rabbitmq

Class BasicConsumer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageConsumerImp

interlok.rabbitmq.BasicConsumer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageConsumer, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator, StateManagedComponent

@ComponentProfile(summary="Basic consumer for RabbitMQ",
                  recommended=RabbitMqConnection.class,
                  tag="amqp, rabbitmq",
                  since="4.3.0")
public class BasicConsumer
extends AdaptrisMessageConsumerImp

Connects to a RabbitMQ Queue and consumes messages.

This is the simplest way to consume a message from RabbitMQ.

Any BasicProperties will be copied as metadata based on the Translator.BasicPropertiesBuilder implementation specified. The default is always to ignore incoming properties.

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor	Description
BasicConsumer()

Method Summary

Modifier and Type	Method	Description
String	consumeLocationKey()
Translator.EnvelopeHandler	getEnvelopeHandler()	How to handle the Delivery#getEnvelope().
Translator.BasicPropertiesHandler	getPropertiesHandler()	How to handle the Delivery#getProperties().
String	getQueue()	The queue to consume from.
protected String	newThreadName()
void	prepare()
void	setEnvelopeHandler(Translator.EnvelopeHandler envelopeHandler)	How to handle the Delivery#getEnvelope().
void	setPropertiesHandler(Translator.BasicPropertiesHandler propertiesHandler)	How to handle the Delivery#getProperties().
void	setQueue(String queue)	The queue to consume from.
void	start()
void	stop()
BasicConsumer	withEnvelopeHandler(Translator.EnvelopeHandler h)
BasicConsumer	withPropertiesHandler(Translator.BasicPropertiesHandler h)
BasicConsumer	withQueue(String s)

Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp

changeState, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.ComponentLifecycle

close, init

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Details

BasicConsumer

public BasicConsumer()

Method Details

prepare

public void prepare()
             throws CoreException

Throws:

CoreException

start

public void start()
           throws CoreException

Throws:

CoreException

stop

public void stop()

withQueue

public BasicConsumer withQueue(String s)

consumeLocationKey

public String consumeLocationKey()

newThreadName

protected String newThreadName()

Overrides:

newThreadName in class AdaptrisMessageConsumerImp

withEnvelopeHandler

public BasicConsumer withEnvelopeHandler(Translator.EnvelopeHandler h)

withPropertiesHandler

public BasicConsumer withPropertiesHandler(Translator.BasicPropertiesHandler h)

getQueue

public String getQueue()

The queue to consume from.

setQueue

public void setQueue(String queue)

The queue to consume from.

getEnvelopeHandler

public Translator.EnvelopeHandler getEnvelopeHandler()

How to handle the Delivery#getEnvelope().

If not explicitly configured, then the envelope associated with the incoming message is ignored.

setEnvelopeHandler

public void setEnvelopeHandler(Translator.EnvelopeHandler envelopeHandler)

How to handle the Delivery#getEnvelope().

If not explicitly configured, then the envelope associated with the incoming message is ignored.

getPropertiesHandler

public Translator.BasicPropertiesHandler getPropertiesHandler()

How to handle the Delivery#getProperties().

If not explicitly configured, then any properties associated with the incoming message are ignored

setPropertiesHandler

public void setPropertiesHandler(Translator.BasicPropertiesHandler propertiesHandler)

How to handle the Delivery#getProperties().

If not explicitly configured, then any properties associated with the incoming message are ignored