Package interlok.rabbitmq

Class PublishToDefaultExchange

java.lang.Object

com.adaptris.core.ServiceImp

interlok.rabbitmq.PublishToDefaultExchange

All Implemented Interfaces:

AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, ConnectedService, MessageEventGenerator, Service, StateManagedComponent

@ComponentProfile(summary="Put the message payload onto an AMQP Queue",
                  recommended=RabbitMqConnection.class,
                  since="4.3.0",
                  tag="amqp,rabbitmq")
public class PublishToDefaultExchange
extends ServiceImp
implements ConnectedService

Wraps StandardMessageProducer as a service for discoverability purposes.

This is the simplest way to publish a message to RabbitMQ to an exchange of "" which is equivalent to the default exchange.

It does not expose all the configuration possible to StandardMessageProducer and is included as a convenience to simply publish a message to a RabbitMQ Queue. It does expose a RabbitMqConnection as configuration so you will have the opportunity to share connections.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PublishToDefaultExchange.Behaviour	Controls behaviour when publishing the messsage.

Field Summary

Fields inherited from class com.adaptris.core.ServiceImp

log

Constructor Summary

Constructors

Constructor	Description
PublishToDefaultExchange()

Method Summary

Modifier and Type	Method	Description
final void	closeService()
void	doService(AdaptrisMessage msg)
PublishToDefaultExchange.Behaviour	getBehaviour()	What to do after publishing the message depending on whether that was successful or not.
AdaptrisConnection	getConnection()	The RabbitMQ Connection.
Translator.BasicPropertiesBuilder	getPropertyBuilder()	How to build the required BasicProperties if required.
String	getQueue()	The queue to publish to.
final void	initService()
final void	prepare()
void	setBehaviour(PublishToDefaultExchange.Behaviour behaviour)	What to do after publishing the message depending on whether that was successful or not.
void	setConnection(AdaptrisConnection connection)	The RabbitMQ Connection.
void	setPropertyBuilder(Translator.BasicPropertiesBuilder propertyBuilder)	How to build the required BasicProperties if required.
void	setQueue(String queue)	The queue to publish to.
void	start()
void	stop()
PublishToDefaultExchange	withConnection(RabbitMqConnection c)
PublishToDefaultExchange	withQueue(String q)

Methods inherited from class com.adaptris.core.ServiceImp

changeState, close, continueOnFailure, createName, createQualifier, getContinueOnFail, getIsTrackingEndpoint, getUniqueId, init, isBranching, isTrackingEndpoint, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, setContinueOnFail, setIsTrackingEndpoint, setUniqueId

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.ComponentLifecycle

close, init

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Methods inherited from interface com.adaptris.core.Service

continueOnFailure, isBranching, setUniqueId

Methods inherited from interface com.adaptris.core.StateManagedComponent

changeState, requestClose, requestInit, requestStart, requestStop, retrieveComponentState

Constructor Details

PublishToDefaultExchange

public PublishToDefaultExchange()

Method Details

doService

public void doService(AdaptrisMessage msg)
               throws ServiceException

Specified by:

doService in interface Service

Throws:

ServiceException

prepare

public final void prepare()
                   throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

initService

public final void initService()
                       throws CoreException

Specified by:

initService in class ServiceImp

Throws:

CoreException

closeService

public final void closeService()

Specified by:

closeService in class ServiceImp

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Overrides:

start in class ServiceImp

Throws:

CoreException

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

Overrides:

stop in class ServiceImp

withConnection

public PublishToDefaultExchange withConnection(RabbitMqConnection c)

withQueue

public PublishToDefaultExchange withQueue(String q)

getQueue

public String getQueue()

The queue to publish to.

setQueue

public void setQueue(String queue)

The queue to publish to.

getPropertyBuilder

public Translator.BasicPropertiesBuilder getPropertyBuilder()

How to build the required BasicProperties if required.

The default if not explicitly specified is to return a null object which uses the default behaviour of RabbitMQ.

setPropertyBuilder

public void setPropertyBuilder(Translator.BasicPropertiesBuilder propertyBuilder)

How to build the required BasicProperties if required.

The default if not explicitly specified is to return a null object which uses the default behaviour of RabbitMQ.

getBehaviour

public PublishToDefaultExchange.Behaviour getBehaviour()

What to do after publishing the message depending on whether that was successful or not.

• TRADITIONAL : act like a traditional service and throw an exception if publishing was not successful
• NO_EXCEPTION: Never throw an exception, add metadata against the key "queue_publish_status" indicating success or failure. Failure will contain the stacktrace from the exception but no exception will be thrown by the service.

setBehaviour

public void setBehaviour(PublishToDefaultExchange.Behaviour behaviour)

What to do after publishing the message depending on whether that was successful or not.

• TRADITIONAL : act like a traditional service and throw an exception if publishing was not successful
• NO_EXCEPTION: Never throw an exception, add metadata against the key "queue_publish_status" indicating success or failure. Failure will contain the stacktrace from the exception but no exception will be thrown by the service.

getConnection

public AdaptrisConnection getConnection()

The RabbitMQ Connection.

Specified by:

getConnection in interface ConnectedService

setConnection

public void setConnection(AdaptrisConnection connection)

The RabbitMQ Connection.

Specified by:

setConnection in interface ConnectedService