モジュール jdk.jconsole
パッケージ com.sun.tools.jconsole

クラスJConsolePlugin

java.lang.Object
com.sun.tools.jconsole.JConsolePlugin
public abstract class JConsolePlugin extends Object
JConsoleプラグイン・クラスです。 JConsoleはservice providerメカニズムを使用してJConsoleプラグインを検索します。 ユーザーは、次のファイルを含むjarファイルに独自のJConsoleプラグインを格納して、提供することができます。 
 META-INF/services/com.sun.tools.jconsole.JConsolePlugin

このファイルには、個々のプラグインを表す次のような行が含まれています。 

 com.sun.example.JTop

これは、JConsolePluginを実装するクラスの完全指定クラス名です。

JConsoleのJConsoleプラグインをロードするには、次のコマンドを実行します。 

 jconsole -pluginpath <plugin-path>

<plugin-path>には検索対象のJConsoleプラグインのパス(ディレクトリまたはjarファイル)を指定します。 複数のパスを指定するときは、プラットフォーム固有のパス区切り文字で区切って指定します。

ある接続に対して新しいJConsoleウィンドウが作成されると、各JConsolePluginのインスタンスが作成されます。 JConsoleContextオブジェクトは、構築中は使用できません。 JConsoleは、プラグイン・オブジェクトが作成されてから、プラグインのJConsoleContextオブジェクトを設定します。 次に、getTabsメソッドを呼び出し、返されたタブをJConsoleウィンドウに追加します。

導入されたバージョン:
1.6
関連項目:
ServiceLoader

  • コンストラクタの詳細

    • JConsolePlugin

      protected JConsolePlugin()
      コンストラクタです。

  • メソッドの詳細

    • setContext

      public final void setContext​(JConsoleContext context)
      アプリケーションへの接続を表すJConsoleContextオブジェクトを設定します。 このメソッドは、プラグインの作成後、getTabs()の呼出しが行われる前に1回だけ呼び出されます。 このメソッドを呼び出すときは、任意のconnection stateのcontextを指定できます。
      パラメータ:
      context - JConsoleContextオブジェクト

    • getContext

      public final JConsoleContext getContext()
      アプリケーションへの接続を表すJConsoleContextオブジェクトを返します。 このメソッドは、contextが初期化される前に呼び出されると、nullを返すことがあります。
      戻り値:
      アプリケーションへの接続を表すJConsoleContextオブジェクト。

    • getTabs

      public abstract Map<String,​JPanel> getTabs()
      JConsoleウィンドウに追加されるタブを返します。

      返されるマップには、JConsoleウィンドウのタブ付きペインに追加される各タブにエントリ(キーとしてタブ名、値としてJPanelオブジェクトを指定)が1つずつ含まれます。 このメソッドは、このプラグインによって追加されるタブがない場合は空のマップを返します。 このメソッドは、新規接続時にイベント・ディスパッチ・スレッドから1回だけ呼び出されます。

      戻り値:
      JConsoleウィンドウに追加されるタブを表すタブ名とJPanelオブジェクトのマップ、または空のマップ。

    • newSwingWorker

      public abstract SwingWorker<?,​?> newSwingWorker()
      JConsoleがGUIを更新するのと同じ間隔でこのプラグインのGUIを更新するSwingWorkerを返します。

      JConsoleは、接続ごとに指定された間隔でGUIの更新を行うようにスケジュールします。 このメソッドは、各プラグインのSwingWorkerを取得するため、更新のたびに呼び出されます。

      JConsoleは、execute()メソッドを呼び出して、返されるSwingWorkerが次の場合に実行されるようにスケジュールを立てます。

      • SwingWorkerオブジェクトが実行されていない(つまり、SwingWorker.getState()メソッドがPENDING状態を返す)場合で、
      • 前回の更新時に返されたSwingWorkerオブジェクトがnullでなく(つまり、SwingWorker.isDoneメソッドの戻り値がtrue)、タスクを完了している場合。

      これらの条件が満たされていないと、SwingWorkerオブジェクトの処理スケジュールは立てられません。

      プラグインが独自のGUI更新スケジュールを立てる場合、このメソッドはnullを返します。

      戻り値:
      GUIの更新を行うSwingWorker、またはnull。

    • dispose

      public void dispose()
      このプラグインを破棄します。 このメソッドはJConsoleによって呼び出され、このプラグインが破棄されることと、このプラグインで割り当てられたすべてのリソースを解放するべきであることを通知します。 このメソッドを呼び出すときは、任意のconnection stateのJConsoleContextを指定できます。

    • addContextPropertyChangeListener

      public final void addContextPropertyChangeListener​(PropertyChangeListener listener)
      このプラグインのJConsoleContextオブジェクトにPropertyChangeListenerを追加します。 このメソッドは、JConsoleContextオブジェクトが使用できるとき、または使用できないときに、このプラグインがリスナーを登録できるようにする簡易メソッドです。

      たとえば、プラグイン・コンストラクタは、このメソッドを呼び出して、connectionStateプロパティの変更を待機するようにリスナーを登録できます。この場合、リスナーは、使用可能な状態になるとJConsoleContextオブジェクトに追加されます。

      パラメータ:
      listener - 追加するPropertyChangeListener
      例外:
      NullPointerException - listenerがnullである場合。

    • removeContextPropertyChangeListener

      public final void removeContextPropertyChangeListener​(PropertyChangeListener listener)
      このプラグインのJConsoleContextオブジェクトのリスナー・リストからPropertyChangeListenerを削除します。 listenerが追加されなかった場合、例外はスローされず、何もアクションは行われません。
      パラメータ:
      listener - 削除するPropertyChangeListener
      例外:
      NullPointerException - listenerがnullである場合。