RMQConnection (RabbitMQ Consumer Plugin 1.0 API)

java.lang.Object
- org.jenkinsci.plugins.rabbitmqconsumer.RMQConnection

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

com.rabbitmq.client.ShutdownListener, EventListener, RMQChannelListener, RMQConnectionNotifier
```
public class RMQConnection
extends Object
implements com.rabbitmq.client.ShutdownListener, RMQChannelListener, RMQConnectionNotifier
```
Handle class for RabbitMQ connection.

作成者:

rinrinne a.k.a. rin_ne

コンストラクタの概要

コンストラクタ
コンストラクタと説明

RMQConnection(String serviceUri)
Creates instance with specified parameter.

コンストラクタ
コンストラクタと説明
`RMQConnection(String serviceUri)` Creates instance with specified parameter.

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`void`	`addRMQConnectionListener(RMQConnectionListener rmqConnectionListener)` Add `RMQConnectionListener`.
`void`	`close()` Close connection.
`boolean`	`getChannelStatus(String queueName)` Gets status of channel bins specified queue.
`List<RMQChannel>`	`getRMQChannels()` Gets the list of RMQChannels.
`String`	`getServiceUri()` Gets URI for RabbitMQ service.
`boolean`	`isOpen()` Gets if connection is established.
`boolean`	`isOpenRMQConnection()` Gets whether connection is opened.
`void`	`notifyOnCloseCompleted()` Notify OnCloseCompleted event.
`void`	`notifyOnOpen()` Notify OnOpen event.
`void`	`notifyRMQConnectionListeners(RMQConnectionEvent event)` Notify event for `RMQConnection`.
`void`	`onCloseCompleted(RMQChannel rmqChannel)` Calls when close process for channel is completed.
`void`	`onOpen(RMQChannel rmqChannel)` Calls when channel is opend.
`void`	`open()` Open connection.
`void`	`removeRMQConnectionListener(RMQConnectionListener rmqConnectionListener)` Removes `RMQConnectionListener`.
`void`	`shutdownCompleted(com.rabbitmq.client.ShutdownSignalException shutdownSignalException)`
`void`	`updateChannels(List<RabbitmqConsumeItem> consumeItems)` Updates each channels.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - RMQConnection
```
public RMQConnection(String serviceUri)
```
    Creates instance with specified parameter.
    
    パラメータ:
    serviceUri - the URI for RabbitMQ service.
- メソッドの詳細
  - getServiceUri
```
public String getServiceUri()
```
    Gets URI for RabbitMQ service.
    
    戻り値:
    the URI.
  - getRMQChannels
```
public List<RMQChannel> getRMQChannels()
```
    Gets the list of RMQChannels.
    
    戻り値:
    the list of RMQChannels.
  - getChannelStatus
```
public boolean getChannelStatus(String queueName)
```
    Gets status of channel bins specified queue.
    
    パラメータ:
    queueName - the queue name.
    
    戻り値:
    true if channel for specified queue is already established.
  - open
```
public void open()
          throws IOException
```
    Open connection.
    
    例外:
    
    IOException - thow if connection cannot be opend.
  - close
```
public void close()
```
    Close connection.
  - isOpen
```
public boolean isOpen()
```
    Gets if connection is established.
    
    戻り値:
    true if connection is already established.
  - updateChannels
```
public void updateChannels(List<RabbitmqConsumeItem> consumeItems)
```
    Updates each channels.
    
    パラメータ:
    consumeItems - the list of consume items.
  - onOpen
```
public void onOpen(RMQChannel rmqChannel)
```
    インタフェースからコピーされた説明: RMQChannelListener
    
    Calls when channel is opend.
    
    定義:
    
    onOpen インタフェース内 RMQChannelListener
    
    パラメータ:
    rmqChannel - the channel.
  - onCloseCompleted
```
public void onCloseCompleted(RMQChannel rmqChannel)
```
    インタフェースからコピーされた説明: RMQChannelListener
    
    Calls when close process for channel is completed.
    
    定義:
    
    onCloseCompleted インタフェース内 RMQChannelListener
    
    パラメータ:
    rmqChannel - the channel.
  - addRMQConnectionListener
```
public void addRMQConnectionListener(RMQConnectionListener rmqConnectionListener)
```
    インタフェースからコピーされた説明: RMQConnectionNotifier
    
    Add RMQConnectionListener.
    
    定義:
    
    addRMQConnectionListener インタフェース内 RMQConnectionNotifier
    
    パラメータ:
    rmqConnectionListener - the connection listener.
  - removeRMQConnectionListener
```
public void removeRMQConnectionListener(RMQConnectionListener rmqConnectionListener)
```
    インタフェースからコピーされた説明: RMQConnectionNotifier
    
    Removes RMQConnectionListener.
    
    定義:
    
    removeRMQConnectionListener インタフェース内 RMQConnectionNotifier
    
    パラメータ:
    rmqConnectionListener - the connection listener.
  - isOpenRMQConnection
```
public boolean isOpenRMQConnection()
```
    インタフェースからコピーされた説明: RMQConnectionNotifier
    
    Gets whether connection is opened.
    
    定義:
    
    isOpenRMQConnection インタフェース内 RMQConnectionNotifier
    
    戻り値:
    true if connection is already established.
  - notifyRMQConnectionListeners
```
public void notifyRMQConnectionListeners(RMQConnectionEvent event)
```
    インタフェースからコピーされた説明: RMQConnectionNotifier
    
    Notify event for RMQConnection.
    
    定義:
    
    notifyRMQConnectionListeners インタフェース内 RMQConnectionNotifier
    
    パラメータ:
    event - the event for connection.
  - 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.

クラス RMQConnection

コンストラクタの概要

メソッドの概要

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

コンストラクタの詳細

RMQConnection

メソッドの詳細

getServiceUri

getRMQChannels

getChannelStatus

open

close

isOpen

updateChannels

onOpen

onCloseCompleted

addRMQConnectionListener

removeRMQConnectionListener

isOpenRMQConnection

notifyRMQConnectionListeners

notifyOnCloseCompleted

notifyOnOpen

shutdownCompleted