org.jenkinsci.plugins.rabbitmqconsumer

クラス RMQChannel

java.lang.Object

org.jenkinsci.plugins.rabbitmqconsumer.RMQChannel

すべての実装されたインタフェース:

com.rabbitmq.client.ShutdownListener, EventListener, RMQChannelNotifier

public class RMQChannel
extends Object
implements RMQChannelNotifier, com.rabbitmq.client.ShutdownListener

Handle class for RabbitMQ channel.

作成者:

rinrinne a.k.a. rin_ne

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラスと説明
class	RMQChannel.MessageConsumer Handle class that consume message.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
RMQChannel(String queueName, HashSet<String> appIds) Creates instance with specified parameters.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	addRMQChannelListener(RMQChannelListener rmqChannelListener) Add RMQChannelListener.
void	close() Close channel.
void	consume() Starts consume.
HashSet<String>	getAppIds() Get hashset of app ids.
com.rabbitmq.client.Channel	getChannel() Gets instance of Channel, not RMQChannel.
String	getQueueName() Gets queue name.
boolean	isConsumeStarted() Gets whether consumer is already started or not.
boolean	isOpenRMQChannel() Gets whether channel is opened.
void	notifyOnCloseCompleted() Notify OnCloseCompleted event.
void	notifyOnOpen() Notify OnOpen event.
void	notifyRMQChannelListeners(RMQChannelEvent event) Notify RMQChannelListeners.
void	open(com.rabbitmq.client.Connection connection) Open connection.
void	removeRMQChannelListener(RMQChannelListener rmqChannelListener) Removes RMQChannelListener.
void	shutdownCompleted(com.rabbitmq.client.ShutdownSignalException shutdownSignalException)

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

RMQChannel

public RMQChannel(String queueName,
          HashSet<String> appIds)

Creates instance with specified parameters.

パラメータ:

queueName - the queue name.

appIds - the hashset of application id.

メソッドの詳細

open

public void open(com.rabbitmq.client.Connection connection)
          throws IOException

Open connection.

パラメータ:

connection - the instance of Connection, not RMQConnection.

例外:

IOException - exception if channel cannot be created.

getChannel

public com.rabbitmq.client.Channel getChannel()

Gets instance of Channel, not RMQChannel.

戻り値:

the instance of Channel.

getAppIds

public HashSet<String> getAppIds()

Get hashset of app ids.

戻り値:

the hashset of app ids.

getQueueName

public String getQueueName()

Gets queue name.

戻り値:

the queue name.

close

public void close()

Close channel.

consume

public void consume()

Starts consume.

isConsumeStarted

public boolean isConsumeStarted()

Gets whether consumer is already started or not.

戻り値:

true if consumer is already started.

addRMQChannelListener

public void addRMQChannelListener(RMQChannelListener rmqChannelListener)

インタフェースからコピーされた説明: RMQChannelNotifier

Add RMQChannelListener.

定義:

addRMQChannelListener インタフェース内 RMQChannelNotifier

パラメータ:

rmqChannelListener - the channel listener.

removeRMQChannelListener

public void removeRMQChannelListener(RMQChannelListener rmqChannelListener)

インタフェースからコピーされた説明: RMQChannelNotifier

Removes RMQChannelListener.

定義:

removeRMQChannelListener インタフェース内 RMQChannelNotifier

パラメータ:

rmqChannelListener - the channel listener.

isOpenRMQChannel

public boolean isOpenRMQChannel()

インタフェースからコピーされた説明: RMQChannelNotifier

Gets whether channel is opened.

定義:

isOpenRMQChannel インタフェース内 RMQChannelNotifier

戻り値:

true if channel is already opened.

notifyRMQChannelListeners

public void notifyRMQChannelListeners(RMQChannelEvent event)

インタフェースからコピーされた説明: RMQChannelNotifier

Notify RMQChannelListeners.

定義:

notifyRMQChannelListeners インタフェース内 RMQChannelNotifier

パラメータ:

event - the event for channel.

notifyOnCloseCompleted

public void notifyOnCloseCompleted()

Notify OnCloseCompleted event.

notifyOnOpen

public void notifyOnOpen()

Notify OnOpen event.

shutdownCompleted

public void shutdownCompleted(com.rabbitmq.client.ShutdownSignalException shutdownSignalException)

定義:

shutdownCompleted インタフェース内 com.rabbitmq.client.ShutdownListener

パラメータ:

shutdownSignalException - the exception.