RMQConnection (RabbitMQ Consumer Plugin 2.8 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, String userName, hudson.util.Secret userPassword)` Creates instance with specified parameter.
`RMQConnection(String serviceUri, String userName, hudson.util.Secret userPassword, long watchdogPeriod)` Creates instance with specified parameter.

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addRMQConnectionListener(RMQConnectionListener rmqConnectionListener)` Add `RMQConnectionListener`.
`void`	`close()` Close connection.
`com.rabbitmq.client.Channel`	`createPureChannel()` Create pure channel.
`boolean`	`equals(Object obj)`
`com.rabbitmq.client.Connection`	`getConnection()` Gets connection.
`boolean`	`getConsumeChannelStatus(String queueName)` Gets status of channel binds specified queue.
`Collection<ConsumeRMQChannel>`	`getConsumeRMQChannels()` Gets the list of ConsumeRMQChannels.
`Collection<PublishRMQChannel>`	`getPublishRMQChannels()` Gets the list of PublishRMQChannels.
`Collection<AbstractRMQChannel>`	`getRMQChannels()` Gets the list of RMQChannels.
`String`	`getServiceUri()` Gets URI for RabbitMQ service.
`String`	`getUserName()` Gets URI for RabbitMQ service.
`hudson.util.Secret`	`getUserPassword()` Gets URI for RabbitMQ service.
`int`	`hashCode()`
`boolean`	`isOpen()` Gets if connection is established.
`boolean`	`isOpenRMQConnection()` Gets whether actual RabbitMQ connection is opened.
`void`	`notifyOnCloseCompleted()` Notify OnCloseCompleted event.
`void`	`notifyOnOpen()` Notify OnOpen event.
`void`	`notifyRMQConnectionListeners(RMQConnectionEvent event)` Notify event for `RMQConnection`.
`void`	`onCloseCompleted(AbstractRMQChannel rmqChannel)` Calls when close process for channel is completed.
`void`	`onOpen(AbstractRMQChannel 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(Collection<RabbitmqConsumeItem> consumeItems)` Updates each channels.
`void`	`updatePublishChannel()` Update publish channel.

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

- コンストラクタの詳細
  - RMQConnection
```
public RMQConnection(String serviceUri,
                     String userName,
                     hudson.util.Secret userPassword)
```
    Creates instance with specified parameter.
    
    パラメータ:
    
    serviceUri - the URI for RabbitMQ service.
    
    userName - the name of user.
    
    userPassword - the password of user.
  - RMQConnection
```
public RMQConnection(String serviceUri,
                     String userName,
                     hudson.util.Secret userPassword,
                     long watchdogPeriod)
```
    Creates instance with specified parameter.
    
    パラメータ:
    
    serviceUri - the URI for RabbitMQ service.
    
    userName - the name of user.
    
    userPassword - the password of user.
    
    watchdogPeriod - the period of watchdog in seconds.
- メソッドの詳細
  - getConnection
```
public com.rabbitmq.client.Connection getConnection()
```
    Gets connection.
    
    戻り値:
    
    the connection.
  - createPureChannel
```
public com.rabbitmq.client.Channel createPureChannel()
```
    Create pure channel.
    
    戻り値:
    
    the channel.
  - getServiceUri
```
public String getServiceUri()
```
    Gets URI for RabbitMQ service.
    
    戻り値:
    
    the URI.
  - getUserName
```
public String getUserName()
```
    Gets URI for RabbitMQ service.
    
    戻り値:
    
    the URI.
  - getUserPassword
```
public hudson.util.Secret getUserPassword()
```
    Gets URI for RabbitMQ service.
    
    戻り値:
    
    the URI.
  - getRMQChannels
```
public Collection<AbstractRMQChannel> getRMQChannels()
```
    Gets the list of RMQChannels.
    
    戻り値:
    
    the collection of RMQChannels.
  - getConsumeRMQChannels
```
public Collection<ConsumeRMQChannel> getConsumeRMQChannels()
```
    Gets the list of ConsumeRMQChannels.
    
    戻り値:
    
    the collection of ComsumeRMQChannels.
  - getPublishRMQChannels
```
public Collection<PublishRMQChannel> getPublishRMQChannels()
```
    Gets the list of PublishRMQChannels.
    
    戻り値:
    
    the list of PublishRMQChannels.
  - getConsumeChannelStatus
```
public boolean getConsumeChannelStatus(String queueName)
```
    Gets status of channel binds 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()
           throws IOException
```
    Close connection.
    
    例外:
    
    IOException - throws if something error.
  - isOpen
```
public boolean isOpen()
```
    Gets if connection is established.
    
    戻り値:
    
    true if connection is already established.
  - updateChannels
```
public void updateChannels(Collection<RabbitmqConsumeItem> consumeItems)
```
    Updates each channels.
    
    パラメータ:
    
    consumeItems - the list of consume items.
  - updatePublishChannel
```
public void updatePublishChannel()
```
    Update publish channel.
  - onOpen
```
public void onOpen(AbstractRMQChannel rmqChannel)
```
    Calls when channel is opend.
    
    定義:
    
    onOpen インタフェース内 RMQChannelListener
    
    パラメータ:
    
    rmqChannel - the channel.
  - onCloseCompleted
```
public void onCloseCompleted(AbstractRMQChannel rmqChannel)
```
    Calls when close process for channel is completed.
    
    定義:
    
    onCloseCompleted インタフェース内 RMQChannelListener
    
    パラメータ:
    
    rmqChannel - the channel.
  - addRMQConnectionListener
```
public void addRMQConnectionListener(RMQConnectionListener rmqConnectionListener)
```
    Add RMQConnectionListener.
    
    定義:
    
    addRMQConnectionListener インタフェース内 RMQConnectionNotifier
    
    パラメータ:
    
    rmqConnectionListener - the connection listener.
  - removeRMQConnectionListener
```
public void removeRMQConnectionListener(RMQConnectionListener rmqConnectionListener)
```
    Removes RMQConnectionListener.
    
    定義:
    
    removeRMQConnectionListener インタフェース内 RMQConnectionNotifier
    
    パラメータ:
    
    rmqConnectionListener - the connection listener.
  - isOpenRMQConnection
```
public boolean isOpenRMQConnection()
```
    Gets whether actual RabbitMQ connection is opened.
    
    定義:
    
    isOpenRMQConnection インタフェース内 RMQConnectionNotifier
    
    戻り値:
    
    true if connection is already established.
  - notifyRMQConnectionListeners
```
public void notifyRMQConnectionListeners(RMQConnectionEvent event)
```
    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.
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 Object
  - equals
```
public boolean equals(Object obj)
```
    オーバーライド:
    
    equals クラス内 Object

クラス RMQConnection

コンストラクタのサマリー

メソッドのサマリー

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

コンストラクタの詳細

RMQConnection

RMQConnection

メソッドの詳細

getConnection

createPureChannel

getServiceUri

getUserName

getUserPassword

getRMQChannels

getConsumeRMQChannels

getPublishRMQChannels

getConsumeChannelStatus

open

close

isOpen

updateChannels

updatePublishChannel

onOpen

onCloseCompleted

addRMQConnectionListener

removeRMQConnectionListener

isOpenRMQConnection

notifyRMQConnectionListeners

notifyOnCloseCompleted

notifyOnOpen

shutdownCompleted

hashCode

equals