compact3

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形式のファイルを使った開発時、または実行時にプログラムを使って動的に定義できます。

ModelMBean内でインスタンス化される各ModelMBeanが管理対象になります。これらの属性およびオペレーションには、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エージェントで処理できない場合。