javax.management.modelmbean

インタフェース ModelMBean

すべてのスーパーインタフェース:

DynamicMBean, ModelMBeanNotificationBroadcaster, NotificationBroadcaster, PersistentMBean

既知のすべての実装クラス:

RequiredModelMBean

public interface ModelMBean
extends DynamicMBean, PersistentMBean, ModelMBeanNotificationBroadcaster

このインタフェースは ModelMBean によって実装される必要があります。このインタフェースの実装は、すべての JMX エージェントに付属しています。

管理対象になる Java リソースは、MBeanServer の createMBean メソッドを使って、ModelMBean をインスタンス化します。次に、ModelMBean インスタンスの ModelMBeanInfo (Descriptor 付き) を設定します。ModelMBean の ModelMBeanInfo で公開された属性とオペレーションには、MBean、コネクタ、アダプタからアクセスできます。ModelMBeanInfo Descriptor を使って、管理対象アプリケーション内の値とメソッドを定義し、ModelMBean の属性およびオペレーションにマップすることができます。このマッピングは、XML 形式のファイルを使った開発時、または実行時にプログラムを使って動的に定義できます。

MBeanServer でインスタンス化された MBean はすべて管理対象となります。これらの属性およびオペレーションには、MBeanServer に接続されたコネクタまたはアダプタ経由でリモートアクセスできます。JMX 準拠の MBean でない Java オブジェクトは、MBeanServer に登録できません。リソースは、ModelMBean をインスタンス化することにより、MBean の有効性を保証します。

すべての public メソッドで、MBeanException および RuntimeOperationsException がスローされる必要があります。こうすることにより、分散型通信 (RMI、EJB など) による例外をラップできます。仕様および javadoc に記載されているシナリオ以外では、実装が必ずしもこれらの例外をスローするとは限りません。

導入されたバージョン:

1.5

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	setManagedResource(Object mr, String mr_type) この ModelMBean 管理インタフェース (MBeanInfo と Descriptor) 内のすべてのメソッドの実行先オブジェクトのインスタンスハンドルを設定します。
void	setModelMBeanInfo(ModelMBeanInfo inModelMBeanInfo) 渡された ModelMBeanInfo を使って ModelMBean オブジェクトを初期化します。

インタフェース javax.management.DynamicMBean から継承されたメソッド

getAttribute, getAttributes, getMBeanInfo, invoke, setAttribute, setAttributes

インタフェース javax.management.PersistentMBean から継承されたメソッド

load, store

インタフェース javax.management.modelmbean.ModelMBeanNotificationBroadcaster から継承されたメソッド

addAttributeChangeNotificationListener, removeAttributeChangeNotificationListener, sendAttributeChangeNotification, sendAttributeChangeNotification, sendNotification, sendNotification

インタフェース javax.management.NotificationBroadcaster から継承されたメソッド

addNotificationListener, getNotificationInfo, removeNotificationListener

メソッドの詳細

setModelMBeanInfo

void setModelMBeanInfo(ModelMBeanInfo inModelMBeanInfo)
                       throws MBeanException,
                              RuntimeOperationsException

ModelMBeanInfo を使って ModelMBean オブジェクトを初期化します。このメソッドを使用すると、ModelMBean 上に、MBeanServer に登録されていないカスタム ModelMBeanInfo を設定できます。
ModelMBean の ModelMBeanInfo (Descriptor 付き) をカスタマイズし、ModelMBean に設定したあと、ModelMBean を MBeanServer に登録することができます。

ModelMBean が現在登録されている場合、このメソッドは IllegalStateException をラップする RuntimeOperationsException をスローします。

パラメータ:

inModelMBeanInfo - ModelMBean によって使用される ModelMBeanInfo オブジェクト。

例外:

MBeanException - 分散通信 Exception をラップする。

RuntimeOperationsException -

• パラメータとして渡された MBeanInfo が null の場合、IllegalArgumentException をラップする。
• ModelMBean が現在 MBeanServer に登録されている場合、IllegalStateException をラップする。

setManagedResource

void setManagedResource(Object mr,
                      String mr_type)
                        throws MBeanException,
                               RuntimeOperationsException,
                               InstanceNotFoundException,
                               InvalidTargetObjectTypeException

この ModelMBean 管理インタフェース (MBeanInfo と Descriptor) 内のすべてのメソッドの実行先オブジェクトのインスタンスハンドルを設定します。

パラメータ:

mr - 管理対象のリソースになっているオブジェクト

mr_type - 管理対象のリソースの参照の型次のうちのいずれか: ObjectReference、Handle、IOR、EJBHandle、RMIReference。MBeanServer が渡された mr_type を処理できない場合、InvalidTargetTypeException がスローされる。

例外:

MBeanException - オブジェクトのイニシャライザが例外をスローした場合。

RuntimeOperationsException - IllegalArgumentException をラップする場合:パラメータとして渡された管理対象のリソースの型が null の場合。

InstanceNotFoundException - 管理対象のリソースオブジェクトが見つからない場合

InvalidTargetObjectTypeException - 管理対象のリソースの型を ModelMBean または JMX エージェントで処理できない場合。