org.jenkinsci.plugins.rabbitmqconsumer.publishers

インタフェース PublishChannel

既知の実装クラスのリスト:

PublishRMQChannel

public interface PublishChannel

A interface class for controlling RabbitMQ publish channel from externals.

作成者:

rinrinne a.k.a. rin_ne

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addListener(RMQChannelListener listener) Adds channel listener.
boolean	isOpen() Gets channel is opened.
Future<PublishResult>	publish(String exchangeName, String routingKey, com.rabbitmq.client.AMQP.BasicProperties props, byte[] body) Publish message.
void	removeListener(RMQChannelListener listener) Remove channel listener.
PublishResult	setupExchange(String exchangeName, String queueName) Setup exchange.
PublishResult	setupExchange(String exchangeName, String queueName, ExchangeType type, String routingKey) Setup exchange.

メソッドの詳細

publish

Future<PublishResult> publish(String exchangeName,
                              String routingKey,
                              com.rabbitmq.client.AMQP.BasicProperties props,
                              byte[] body)

Publish message. The usage of this method is the same as original amqp client library. See "Publising message"section in API guide. http://www.rabbitmq.com/api-guide.html This is non-blocking method. The message you provide is published from other thread. Note that the message still not published even if return from this method.

パラメータ:

exchangeName - the name of exchange.

routingKey - the routing key.

props - the properties of AMQP message.

body - the message body.

戻り値:

instance of Future class that computes PublishResult.

setupExchange

PublishResult setupExchange(String exchangeName,
                            String queueName)
                     throws CancellationException,
                            ExecutionException,
                            InterruptedException

Setup exchange. Fanout type exchange is declared then binded to queue in RabbitMQ. Note that this is blocking method.

パラメータ:

exchangeName - the exchange name. If null, unique name is used. You can get it from PublishResult.getExchangeName().

queueName - the queue name. this is mandatory.

戻り値:

instance of PublishResult.

例外:

CancellationException - if the computation was cancelled.

ExecutionException - if the computation threw an exception.

InterruptedException - if the current thread was interrupted while waiting.

setupExchange

PublishResult setupExchange(String exchangeName,
                            String queueName,
                            ExchangeType type,
                            String routingKey)
                     throws CancellationException,
                            ExecutionException,
                            InterruptedException

Setup exchange. Exchange is declared then binded to queue in RabbitMQ. Note that this is blocking method.

パラメータ:

exchangeName - the exchange name. If null, unique name is used. You can get it from PublishResult.getExchangeName().

queueName - the queue name. this is mandatory.

type - the exchange type.

routingKey - the routing key. Key usage is decided by exchange type.

戻り値:

instance of PublishResult.

例外:

CancellationException - if the computation was cancelled.

ExecutionException - if the computation threw an exception.

InterruptedException - if the current thread was interrupted while waiting.

isOpen

boolean isOpen()

Gets channel is opened. Note that you may not be able to publish message even if this method returns true.

戻り値:

true if channel is opened.

addListener

void addListener(RMQChannelListener listener)

Adds channel listener.

パラメータ:

listener - the listener.

removeListener

void removeListener(RMQChannelListener listener)

Remove channel listener.

パラメータ:

listener - the listener.