JavaTM Platform
Standard Ed. 6

javax.management.remote
インタフェース JMXConnectorServerMBean

既知の実装クラスの一覧:
JMXConnectorServer, RMIConnectorServer

public interface JMXConnectorServerMBean

 

コネクタサーバーの MBean インタフェースです。JMX API コネクタサーバーは MBean サーバーに接続され、リモートクライアントが利用するこの MBean サーバーとの接続を確立します。

 

新しく作成されたコネクタサーバーは「非アクティブ」であり、まだ接続を待機していません。このコネクタサーバーは、start メソッドが呼び出されてから、接続の待機を開始します。

導入されたバージョン:
1.5

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

メソッドの詳細

start

void start()
           throws IOException
 

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

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

stop

void stop()
          throws IOException
 

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

 

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

 

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

 

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

 

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

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

isActive

boolean isActive()
 

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

戻り値:
コネクタサーバーがアクティブな場合は true

setMBeanServerForwarder

void setMBeanServerForwarder(MBeanServerForwarder mbsf)
 

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

 

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

 

スローされる例外は、何の影響も持ちません。 このコネクタがまだ MBeanServer オブジェクトに関連付けられていない場合、または mbsf.setMBeanServer 呼び出しが成功した場合、mbsf がこのコネクタサーバーの MBeanServer になります。

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

getConnectionIds

String[] getConnectionIds()
 

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

戻り値:
ID リストを含む新しい文字配列。現在有効になっている 接続がない場合、 この配列は空になる

getAddress

JMXServiceURL getAddress()
 

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

戻り値:
このコネクタサーバーのアドレス。 存在しない場合は null

getAttributes

Map<String,?> getAttributes()
 

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

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

toJMXConnector

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

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

 

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

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

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。