RMIConnector (Java Platform SE 8)

java.lang.Object
- javax.management.remote.rmi.RMIConnector

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

Closeable, Serializable, AutoCloseable, JMXAddressable, JMXConnector
```
public class RMIConnector
extends Object
implements JMXConnector, Serializable, JMXAddressable
```
リモートRMIコネクタへの接続です。通常、こうした接続は、JMXConnectorFactoryで作成されます。しかし、JNDIを使用しないで取得されるRMIServerスタブなどにより、このクラスを直接使用できる特殊なアプリケーションもあります。

導入されたバージョン:

1.5

関連項目:

直列化された形式

フィールドのサマリー
- インタフェース javax.management.remote.JMXConnectorから継承されたフィールド
  CREDENTIALS

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

コンストラクタ
コンストラクタと説明
`RMIConnector(JMXServiceURL url, Map<String,?> environment)` 指定されたアドレスのRMIコネクタ・サーバーに接続する`RMIConnector`を構築します。
`RMIConnector(RMIServer rmiServer, Map<String,?> environment)` 指定されたRMIスタブを使って`RMIConnector`を構築します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)` 接続状態の変化を通知されるリスナーを追加します。
`void`	`close()` クライアントとサーバーの接続を終了します。
`void`	`connect()` コネクタ・サーバーとの接続を確立します。
`void`	`connect(Map<String,?> environment)` コネクタ・サーバーとの接続を確立します。
`JMXServiceURL`	`getAddress()` このコネクタのアドレスです。
`String`	`getConnectionId()` コネクタ・サーバーから、この接続のIDを取得します。
`MBeanServerConnection`	`getMBeanServerConnection()` リモートMBeanサーバーを表す`MBeanServerConnection`オブジェクトを返します。
`MBeanServerConnection`	`getMBeanServerConnection(Subject delegationSubject)` 指定された委譲対象の代わりにオペレーションを実行する、リモートMBeanサーバーを表す`MBeanServerConnection`オブジェクトを返します。
`void`	`removeConnectionNotificationListener(NotificationListener listener)` 状態の変更を通知されるリスナーをリストから削除します。
`void`	`removeConnectionNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback)` 状態の変更を通知されるリスナーをリストから削除します。
`String`	`toString()` このオブジェクトの文字列表現を返します。

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

- コンストラクタの詳細
  - RMIConnector
```
public RMIConnector(JMXServiceURL url,
                    Map<String,?> environment)
```
    指定されたアドレスのRMIコネクタ・サーバーに接続するRMIConnectorを構築します。
    
    アドレスは、コネクタ・サーバーを直接参照できます。次のいずれかの構文を使用します。
```
 service:jmx:rmi://[host[:port]]/stub/encoded-stub
 service:jmx:iiop://[host[:port]]/ior/encoded-IOR
 
```
    (角括弧[]はアドレスの一部ではなく、ホストとポートがオプションであることを示します。)
    
    次のいずれかの構文を使用して、アドレスで、JNDIによってRMIスタブを検索する場所を示すこともできます。
```
 service:jmx:rmi://[host[:port]]/jndi/jndi-name
 service:jmx:iiop://[host[:port]]/jndi/jndi-name
 
```
    実装も追加アドレス構文を認識できます。次に例を示します。
```
 service:jmx:iiop://[host[:port]]/stub/encoded-stub
 
```
    パラメータ:
    
    url - RMIコネクタ・サーバーのアドレス。
    
    environment - 接続の作成方法を指定する追加属性。JNDIベースのアドレスの場合、これらの属性に、InitialContextによって認識されるJNDI属性を含めることができ、有用である。このパラメータがnullの場合、空のマップを指定した場合と同じことになる。
    
    例外:
    
    IllegalArgumentException - urlがnullである場合。
  - RMIConnector
```
public RMIConnector(RMIServer rmiServer,
                    Map<String,?> environment)
```
    指定されたRMIスタブを使ってRMIConnectorを構築します。
    
    パラメータ:
    
    rmiServer - RMIコネクタ・サーバーを表すRMIスタブ。
    
    environment - 接続の作成方法を指定する追加属性。このパラメータがnullの場合、空のマップを指定した場合と同じことになる。
    
    例外:
    
    IllegalArgumentException - rmiServerがnullである場合。
- メソッドの詳細
  - toString
```
public String toString()
```
    このオブジェクトの文字列表現を返します。一般に、toStringメソッドは、このオブジェクトを「テキストで表す」文字列を返します。この結果は、人間が読める簡潔で有益な情報であるべきです。
    
    オーバーライド:
    
    toString 、クラス: Object
    
    戻り値:
    
    このオブジェクトのString表現。
  - getAddress
```
public JMXServiceURL getAddress()
```
    このコネクタのアドレスです。
    
    定義:
    
    getAddress 、インタフェース: JMXAddressable
    
    戻り値:
    
    このコネクタのアドレス。存在しない場合はnull。
    
    導入されたバージョン:
    
    1.6
  - connect
```
public void connect()
             throws IOException
```
    次のインタフェースからコピーされた説明: JMXConnector
    
    コネクタ・サーバーとの接続を確立します。このメソッドは、connect(null)と同等です。
    
    定義:
    
    connect 、インタフェース: JMXConnector
    
    例外:
    
    IOException - 通信障害により接続を確立できなかった場合、またはiiopプロトコルでRMI/IIOPがサポートされていない場合
  - connect
```
public void connect(Map<String,?> environment)
             throws IOException
```
    次のインタフェースからコピーされた説明: JMXConnector
    
    コネクタ・サーバーとの接続を確立します。
    
    このオブジェクト上で、すでにconnectが呼び出されている場合、もう1回呼び出しても何も起こりません。一方、connectのあとでJMXConnector.close()が呼び出されている場合、再度connectを呼び出すとIOExceptionがスローされます。
    このオブジェクト上でconnectが1回も呼び出されていない場合、または呼出しに対して例外が生成された場合、connectを呼び出すとコネクタ・サーバーとの接続が試行されます。
    
    定義:
    
    connect 、インタフェース: JMXConnector
    
    パラメータ:
    
    environment - 接続のプロパティ。このマップ内のプロパティは、JMXConnectorの作成時に指定されたマップ内のプロパティをオーバーライドする(存在する場合)。このパラメータがnullの場合、空のマップを指定した場合と同じことになる。
    
    例外:
    
    IOException - 通信障害により接続を確立できなかった場合、またはiiopプロトコルでRMI/IIOPがサポートされていない場合
  - getConnectionId
```
public String getConnectionId()
                       throws IOException
```
    次のインタフェースからコピーされた説明: JMXConnector
    
    コネクタ・サーバーから、この接続のIDを取得します。コネクタ・サーバー内のすべての接続は一意のIDを持ち、このIDは接続の寿命が尽きるまで変わりません。
    
    定義:
    
    getConnectionId 、インタフェース: JMXConnector
    
    戻り値:
    
    この接続の一意のID。コネクタ・サーバーがJMXConnectionNotificationに格納するIDと同じ。package descriptionは接続IDの規約の説明。
    
    例外:
    
    IOException - 接続の終了、中断などが原因で接続IDを取得できない場合。
  - getMBeanServerConnection
```
public MBeanServerConnection getMBeanServerConnection()
                                               throws IOException
```
    次のインタフェースからコピーされた説明: JMXConnector
    
    リモートMBeanサーバーを表すMBeanServerConnectionオブジェクトを返します。通常、JMXConnectorに対してこのメソッドを2回呼び出した場合、各呼出しで同じMBeanServerConnectionオブジェクトが返されます。ただし、これは必須条件ではありません。
    
    返されたMBeanServerConnection内の各メソッドに対してこのメソッドを呼び出すと、リモートMBeanサーバー内の対応するメソッドが呼び出されます。MBeanサーバー・メソッドによって返される値が、クライアントに返される値となります。MBeanサーバー・メソッドがExceptionをスローした場合、クライアントには同じExceptionが返されます。MBeanサーバー・メソッド自体、またはその呼出しの試行でErrorが発生した場合、クライアントには、発生したErrorをラップするJMXServerErrorExceptionが返されます。
    
    このメソッドの呼出しは、getMBeanServerConnection(null)の呼び出しと同等です。委譲対象が指定されておらず、MBeanServerConnection上で呼び出されたすべてのオペレーションは認証対象(存在する場合)を使用する必要があります。
    
    定義:
    
    getMBeanServerConnection 、インタフェース: JMXConnector
    
    戻り値:
    
    メソッドをリモートMBeanサーバーに転送することによりMBeanServerConnectionインタフェースを実装するオブジェクト。
    
    例外:
    
    IOException - 有効なMBeanServerConnectionを作成できない場合。たとえば、connectメソッドによるリモートMBeanサーバーとの接続がまだ確立されていない場合、MBeanサーバーとの接続がすでに終了している場合、接続が中断された場合など。
  - getMBeanServerConnection
```
public MBeanServerConnection getMBeanServerConnection(Subject delegationSubject)
                                               throws IOException
```
    次のインタフェースからコピーされた説明: JMXConnector
    
    指定された委譲対象の代わりにオペレーションを実行する、リモートMBeanサーバーを表すMBeanServerConnectionオブジェクトを返します。通常、JMXConnectorおよびSubjectに対してこのメソッドを2回呼び出した場合、各呼出しで同じMBeanServerConnectionオブジェクトが返されます。ただし、これは必須条件ではありません。
    
    返されたMBeanServerConnection内の各メソッドに対してこのメソッドを呼び出すと、認証対象ではなく委譲対象に代わって、リモートMBeanサーバー内の対応するメソッドが呼び出されます。MBeanサーバー・メソッドによって返される値が、クライアントに返される値となります。MBeanサーバー・メソッドがExceptionをスローした場合、クライアントには同じExceptionが返されます。MBeanサーバー・メソッド自体、またはその呼出しの試行でErrorが発生した場合、クライアントには、発生したErrorをラップするJMXServerErrorExceptionが返されます。
    
    定義:
    
    getMBeanServerConnection 、インタフェース: JMXConnector
    
    パラメータ:
    
    delegationSubject - Subject。これの代わりに要求が実行される。nullも可、その場合は認証済Subjectの代わりに要求が実行される(存在する場合)。
    
    戻り値:
    
    メソッドをリモートMBeanサーバーに転送することにより、委譲対象の代わりにMBeanServerConnectionインタフェースを実装するオブジェクト。
    
    例外:
    
    IOException - 有効なMBeanServerConnectionを作成できない場合。たとえば、connectメソッドによるリモートMBeanサーバーとの接続がまだ確立されていない場合、MBeanサーバーとの接続がすでに終了している場合、接続が中断された場合など。
  - addConnectionNotificationListener
```
public void addConnectionNotificationListener(NotificationListener listener,
                                              NotificationFilter filter,
                                              Object handback)
```
    次のインタフェースからコピーされた説明: JMXConnector
    
    接続状態の変化を通知されるリスナーを追加します。このリスナーは、JMXConnectionNotification型の通知を受信します。実装により、これ以外の型の通知が送信される場合もあります。
    
    このメソッドに追加できるリスナーの数に制限はありません。フィルタとハンドバックに同一の値または異なった値を指定して、同一のリスナーを繰返し追加することも可能です。複製エントリも特別扱いされません。たとえば、リスナーをフィルタなしで2回登録した場合、各通知で、このリスナーのhandleNotificationメソッドが2回呼び出されます。
    
    定義:
    
    addConnectionNotificationListener 、インタフェース: JMXConnector
    
    パラメータ:
    
    listener - 接続状態通知を受け取るリスナー。
    
    filter - リスナーに配信される通知を選択するフィルタ。すべての通知を配信する場合はnull。
    
    handback - 各通知とともにリスナーに渡されるオブジェクト。nullも可。
    
    関連項目:
    
    JMXConnector.removeConnectionNotificationListener(javax.management.NotificationListener), NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
  - removeConnectionNotificationListener
```
public void removeConnectionNotificationListener(NotificationListener listener)
                                          throws ListenerNotFoundException
```
    次のインタフェースからコピーされた説明: JMXConnector
    
    状態の変更を通知されるリスナーをリストから削除します。削除対象として指定できるのは、以前に追加されたリスナーのみです。条件に該当するリスナーが複数存在する場合、すべて削除されます。
    
    定義:
    
    removeConnectionNotificationListener 、インタフェース: JMXConnector
    
    パラメータ:
    
    listener - 接続状態通知を受け取るリスナー。
    
    例外:
    
    ListenerNotFoundException - リスナーがこのJMXConnectorに登録されていない場合。
    
    関連項目:
    
    JMXConnector.removeConnectionNotificationListener(NotificationListener, NotificationFilter, Object), JMXConnector.addConnectionNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object), NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
  - removeConnectionNotificationListener
```
public void removeConnectionNotificationListener(NotificationListener listener,
                                                 NotificationFilter filter,
                                                 Object handback)
                                          throws ListenerNotFoundException
```
    次のインタフェースからコピーされた説明: JMXConnector
    
    状態の変更を通知されるリスナーをリストから削除します。削除対象として指定できるのは、以前に同じ3つのパラメータで追加されたリスナーのみです。条件に該当するリスナーが複数存在する場合も、削除されるのは1つだけです。
    
    定義:
    
    removeConnectionNotificationListener 、インタフェース: JMXConnector
    
    パラメータ:
    
    listener - 接続状態通知を受け取るリスナー。
    
    filter - リスナーに配信される通知を選択するフィルタ。nullも可。
    
    handback - 各通知とともにリスナーに渡されるオブジェクト。nullも可。
    
    例外:
    
    ListenerNotFoundException - リスナーがこのJMXConnectorに登録されていない場合、または指定されたフィルタおよびハンドバックで登録されていない場合。
    
    関連項目:
    
    JMXConnector.removeConnectionNotificationListener(NotificationListener), JMXConnector.addConnectionNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object), NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)
  - close
```
public void close()
           throws IOException
```
    次のインタフェースからコピーされた説明: JMXConnector
    
    クライアントとサーバーの接続を終了します。現行の要求または新しい要求が、JMXConnector.getMBeanServerConnection()から返されるMBeanServerConnectionを使用する場合、IOExceptionがスローされます。
    
    このオブジェクト上で、すでにcloseが呼び出されている場合、もう1回呼び出しても何も起こりません。closeが1回も呼び出されていない場合、または呼出しに対して例外が生成された場合は、接続の終了が試行されます。この試行に成功した場合、closeは通常どおり終了します。失敗した場合は例外が生成されることがあります。
    
    接続の終了は、時間のかかるオペレーションです。たとえばサーバーがクラッシュした場合、終了オペレーションはネットワーク・プロトコルのタイム・アウトまで中断される可能性があります。終了オペレーションの途中で待たされたくない場合は、別スレッドで実行してください。
    
    定義:
    
    close 、インタフェース: Closeable
    
    定義:
    
    close 、インタフェース: AutoCloseable
    
    定義:
    
    close 、インタフェース: JMXConnector
    
    例外:
    
    IOException - 接続を正常に終了できない場合。この例外がスローされた場合、接続のサーバー側が正常に終了したかどうかは不明。

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

クラスRMIConnector

フィールドのサマリー

インタフェース javax.management.remote.JMXConnectorから継承されたフィールド

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

メソッドのサマリー

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

コンストラクタの詳細

RMIConnector

RMIConnector

メソッドの詳細

toString

getAddress

connect

connect

getConnectionId

getMBeanServerConnection

getMBeanServerConnection

addConnectionNotificationListener

removeConnectionNotificationListener

removeConnectionNotificationListener

close