JMXConnectorServerMBean (Java 2 Platform SE 5.0)

メソッドの概要
`JMXServiceURL`	`getAddress()` このコネクタサーバのアドレス
`Map<String,?>`	`getAttributes()` このコネクタサーバの属性
`String[]`	`getConnectionIds()` 現在有効になっている、このコネクタサーバとの接続の ID のリストです。
`boolean`	`isActive()` コネクタサーバがアクティブかどうかを判定します。
`void`	`setMBeanServerForwarder(MBeanServerForwarder mbsf)` このコネクタサーバ経由で着信した MBean サーバへの要求を遮断するオブジェクトを追加します。
`void`	`start()` コネクタサーバをアクティブにして、クライアント接続の待機を開始します。
`void`	`stop()` コネクタサーバを終了して、クライアント接続の待機を停止します。
`JMXConnector`	`toJMXConnector(Map<String,?> env)` このコネクタサーバのクライアントスタブを返します。

メソッドの詳細

void start()
           throws IOException

コネクタサーバをアクティブにして、クライアント接続の待機を開始します。コネクタサーバがすでにアクティブな場合は、このメソッドを呼び出しても何も起こりません。コネクタサーバが停止している状態でこのメソッドを呼び出すと、IOException が生成されます。

例外:: IOException - 待機を開始できない場合、またはコネクタサーバが停止している場合; IllegalStateException - コネクタサーバが MBean サーバに接続されていない場合

void stop()
          throws IOException

コネクタサーバを終了して、クライアント接続の待機を停止します。このメソッドを呼び出すと、このサーバで作成されたすべてのクライアント接続が終了します。このメソッドが正常に終了した場合も、例外を生成して終了した場合も、コネクタサーバは新しいクライアント接続を作成しなくなります。

いったん停止したコネクタサーバを再度起動することはできません。

コネクタサーバがすでに停止している場合は、このメソッドを呼び出しても何も起こりません。コネクタサーバがまだ起動していない状態でこのメソッドを呼び出すと、コネクタサーバオブジェクトが永続的に無効化されます。

クライアント接続の終了時に生成された例外は、このメソッドからはスローされません。この MBean からは、JMXConnectionNotification.FAILED 型の JMXConnectionNotification と、終了できなかった接続の接続 ID が発行されます。

コネクタサーバの終了は、時間のかかるオペレーションです。たとえば有効な接続を持っているクライアントマシンがクラッシュした場合、終了オペレーションはネットワークプロトコルのタイムアウトまで中断される可能性があります。終了オペレーションの途中で待たされたくない場合は、別スレッドで実行してください。

例外:: IOException - サーバを正常に終了できない場合。この例外がスローされたとき、サーバはすでにすべてのクライアント接続の終了を試行済み。サーバが終了を試行したとき例外を生成したものを除いて、すべてのクライアント接続は終了済み

boolean isActive()

コネクタサーバがアクティブかどうかを判定します。start メソッドが正常に終了すると、コネクタサーバはアクティブになります。その後、stop メソッドが呼び出されるか、障害が発生するまで、コネクタサーバはアクティブな状態を維持します。

void setMBeanServerForwarder(MBeanServerForwarder mbsf)

このコネクタサーバ経由で着信した MBean サーバへの要求を遮断するオブジェクトを追加します。このオブジェクトは、このコネクタサーバによって作成された新しい接続の MBeanServer として指定されます。既存の接続に影響はありません。

このコネクタサーバがすでに MBeanServer オブジェクトに関連付けられている場合は、mbsf.setMBeanServer にこのオブジェクトが渡されます。この処理で例外が生成された場合、このメソッドはその例外をスローします。スローされる例外は、何の影響も持ちません。

このコネクタがまだ MBeanServer オブジェクトに関連付けられていない場合、または mbsf.setMBeanServer 呼び出しが成功した場合、mbsf がこのコネクタサーバの MBeanServer になります。

パラメータ:: mbsf - 新しい MBeanServerForwarder
例外:: IllegalArgumentException - mbsf.setMBeanServer 呼び出しが IllegalArgumentException を生成して失敗した場合。mbsf が null の場合も含まれる

String[] getConnectionIds()

現在有効になっている、このコネクタサーバとの接続の ID のリストです。

JMXServiceURL getAddress()

このコネクタサーバのアドレス

Map<String,?> getAttributes()

このコネクタサーバの属性

戻り値:: このコネクタサーバの属性を含む読み取り専用マップ。直列化可能な値を持つ属性は、このマップから除外される。直列化可能な属性が存在しない場合、空のマップが返される

JMXConnector toJMXConnector(Map<String,?> env)
                            throws IOException

このコネクタサーバのクライアントスタブを返します。クライアントスタブは直列化可能なオブジェクトです。このオブジェクトの connect メソッドを使って、このコネクタサーバとの新しい接続を 1 つ確立できます。

指定されたコネクタが、クライアントスタブの生成機能をサポートしない場合もあります。ただし、JMX リモート API によって指定されたコネクタ (JMXMP コネクタと RMI コネクタ) は、この機能をサポートします。

パラメータ:: env - JMXConnector.connect(Map) に提供可能な同じ種類のクライアント接続パラメータ。null は空マップと同等
戻り値:: このコネクタサーバとの新しい接続を確立するために使用できるクライアントスタブ
例外:: UnsupportedOperationException - このコネクタサーバがクライアントスタブの生成機能をサポートしない場合; IllegalStateException - JMXConnectorServer が起動していない場合 (isActive() を参照); IOException - 通信障害により、スタブを作成できない場合