public interface MBeanServerConnection
MBeanServer
インタフェースはこのインタフェースを拡張します。修飾子と型 | メソッドと説明 |
---|---|
void |
addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)
登録済み MBean にリスナーを追加します。
|
void |
addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)
登録済み MBean にリスナーを追加します。
|
ObjectInstance |
createMBean(String className, ObjectName name)
MBean をインスタンス化し、MBean サーバーに登録します。
|
ObjectInstance |
createMBean(String className, ObjectName name, Object[] params, String[] signature)
MBean をインスタンス化し、MBean サーバーに登録します。
|
ObjectInstance |
createMBean(String className, ObjectName name, ObjectName loaderName)
MBean をインスタンス化し、MBean サーバーに登録します。
|
ObjectInstance |
createMBean(String className, ObjectName name, ObjectName loaderName, Object[] params, String[] signature)
MBean をインスタンス化し、MBean サーバーに登録します。
|
Object |
getAttribute(ObjectName name, String attribute)
指定された MBean の特定の属性の値を取得します。
|
AttributeList |
getAttributes(ObjectName name, String[] attributes)
指定された MBean の複数の属性の値を取り出します。
|
String |
getDefaultDomain()
MBean の指定に使用するデフォルトのドメインを返します。
|
String[] |
getDomains()
MBean が現在登録されているドメインのリストを返します。
|
Integer |
getMBeanCount()
MBean サーバーに登録されている MBean の数を返します。
|
MBeanInfo |
getMBeanInfo(ObjectName name)
このメソッドは、MBean が管理用として公開している属性とオペレーションを検出します。
|
ObjectInstance |
getObjectInstance(ObjectName name)
MBean に登録された、指定された MBean の
ObjectInstance を取得します。 |
Object |
invoke(ObjectName name, String operationName, Object[] params, String[] signature)
MBean上でオペレーションを呼び出します。
|
boolean |
isInstanceOf(ObjectName name, String className)
指定された MBean が指定されたクラスのインスタンスである場合は true、そうでない場合は false を返します。
|
boolean |
isRegistered(ObjectName name)
このオブジェクト名で識別される MBean が、すでに MBean サーバーに登録されているかどうかをチェックします。
|
Set<ObjectInstance> |
queryMBeans(ObjectName name, QueryExp query)
MBean サーバーによって制御される MBean を取得します。
|
Set<ObjectName> |
queryNames(ObjectName name, QueryExp query)
MBean サーバーによって制御される MBean の名前を取得します。
|
void |
removeNotificationListener(ObjectName name, NotificationListener listener)
登録済み MBean からリスナーを削除します。
|
void |
removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback)
登録済み MBean からリスナーを削除します。
|
void |
removeNotificationListener(ObjectName name, ObjectName listener)
登録済み MBean からリスナーを削除します。
|
void |
removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback)
登録済み MBean からリスナーを削除します。
|
void |
setAttribute(ObjectName name, Attribute attribute)
指定された MBean の特定の属性の値を設定します。
|
AttributeList |
setAttributes(ObjectName name, AttributeList attributes)
指定された MBean の複数の属性の値を設定します。
|
void |
unregisterMBean(ObjectName name)
MBean サーバーから MBean の登録を解除します。
|
ObjectInstance createMBean(String className, ObjectName name) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, IOException
MBean をインスタンス化し、MBean サーバーに登録します。MBean サーバーは、Default Loader Repository
を使って、この MBean のクラスをロードします。MBean にはオブジェクト名が関連付けられます。このオブジェクト名が null の場合、MBean は、MBeanRegistration
インタフェースを実装し、preRegister
メソッドから返される独自の名前を使用する必要があります。
このメソッドは、createMBean(className, name, (Object[]) null, (String[]) null)
と同等です。
className
- インスタンス化する MBean のクラス名。name
- MBean のオブジェクト名。null も可。ObjectName
と Java クラス名を含む ObjectInstance
。含まれる ObjectName
が n
の場合、含まれる Java クラス名は getMBeanInfo(n)
.getClassName()
。ReflectionException
- MBean のコンストラクタの呼び出し時に発行される java.lang.ClassNotFoundException
または java.lang.Exception
をラップする場合。InstanceAlreadyExistsException
- MBean がすでに MBean サーバーによって制御されている場合。MBeanRegistrationException
- MBean の preRegister
(MBeanRegistration
インタフェース) メソッドが例外をスローした場合。MBean は登録されない。RuntimeMBeanException
- MBean のコンストラクタ、あるいはその preRegister
または postRegister
メソッドが RuntimeException
をスローした場合。MBean の postRegister
(MBeanRegistration
インタフェース) メソッドが RuntimeException
をスローすると、MBean の作成と登録は成功しますが、createMBean
メソッドは RuntimeMBeanException
をスローします。このような場合、createMBean
メソッドが例外をスローしたとしても、MBean は実際に登録されます。RuntimeMBeanException
は preRegister
でもスローされますが、その場合は MBean は登録されません。RuntimeErrorException
- MBean の postRegister
(MBeanRegistration
インタフェース) メソッドが Error
をスローすると、MBean の作成と登録は成功しますが、createMBean
メソッドは RuntimeErrorException
をスローします。このような場合、createMBean
メソッドが例外をスローしたとしても、MBean は実際に登録されます。RuntimeErrorException
は preRegister
でもスローされますが、その場合は MBean は登録されません。MBeanException
- MBean のコンストラクタが例外をスローした場合NotCompliantMBeanException
- このクラスが JMX 準拠の MBean でない場合RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータに渡される className が null であるか、パラメータに渡される ObjectName
がパターンであるか、MBean に ObjectName
が指定されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。MBeanRegistration
ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException, IOException
MBean をインスタンス化し、MBean サーバーに登録します。使用するクラスローダーは、オブジェクト名で識別されます。MBean にはオブジェクト名が関連付けられます。ローダーのオブジェクト名が null の場合、MBean サーバーのロードに使用した ClassLoader が使用されます。MBean のオブジェクト名が null の場合、MBean は、MBeanRegistration
インタフェースを実装し、preRegister
メソッドから返される独自の名前を使用する必要があります。
このメソッドは、createMBean(className, name, loaderName, (Object[]) null, (String[]) null)
と同等です。
className
- インスタンス化する MBean のクラス名。name
- MBean のオブジェクト名。null も可。loaderName
- 使用するクラスローダーのオブジェクト名。ObjectName
と Java クラス名を含む ObjectInstance
。含まれる ObjectName
が n
の場合、含まれる Java クラス名は getMBeanInfo(n)
.getClassName()
。ReflectionException
- MBean のコンストラクタの呼び出し時に発行される java.lang.ClassNotFoundException
または java.lang.Exception
をラップする場合。InstanceAlreadyExistsException
- MBean がすでに MBean サーバーによって制御されている場合。MBeanRegistrationException
- MBean の preRegister
(MBeanRegistration
インタフェース) メソッドが例外をスローした場合。MBean は登録されない。RuntimeMBeanException
- MBean のコンストラクタ、あるいはその preRegister
または postRegister
メソッドが RuntimeException
をスローした場合。MBean の postRegister
(MBeanRegistration
インタフェース) メソッドが RuntimeException
をスローすると、MBean の作成と登録は成功しますが、createMBean
メソッドは RuntimeMBeanException
をスローします。このような場合、createMBean
メソッドが例外をスローしたとしても、MBean は実際に登録されます。RuntimeMBeanException
は preRegister
でもスローされますが、その場合は MBean は登録されません。RuntimeErrorException
- MBean の postRegister
(MBeanRegistration
インタフェース) メソッドが Error
をスローすると、MBean の作成と登録は成功しますが、createMBean
メソッドは RuntimeErrorException
をスローします。このような場合、createMBean
メソッドが例外をスローしたとしても、MBean は実際に登録されます。RuntimeErrorException
は preRegister
でもスローされますが、その場合は MBean は登録されません。MBeanException
- MBean のコンストラクタが例外をスローした場合NotCompliantMBeanException
- このクラスが JMX 準拠の MBean でない場合InstanceNotFoundException
- 指定されたクラスローダーが MBean サーバーに登録されていない場合。RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータに渡される className が null であるか、パラメータに渡される ObjectName
がパターンであるか、MBean に ObjectName
が指定されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。MBeanRegistration
ObjectInstance createMBean(String className, ObjectName name, Object[] params, String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, IOException
Default Loader Repository
を使って、この MBean のクラスをロードします。MBean にはオブジェクト名が関連付けられます。このオブジェクト名が null の場合、MBean は、MBeanRegistration
インタフェースを実装し、preRegister
メソッドから返される独自の名前を使用する必要があります。className
- インスタンス化する MBean のクラス名。name
- MBean のオブジェクト名。null も可。params
- 呼び出されるコンストラクタのパラメータを含む配列。signature
- 呼び出されるコンストラクタのシグニチャーを含む配列。ObjectName
と Java クラス名を含む ObjectInstance
。含まれる ObjectName
が n
の場合、含まれる Java クラス名は getMBeanInfo(n)
.getClassName()
。ReflectionException
- MBean のコンストラクタの呼び出し時に発行される java.lang.ClassNotFoundException
または java.lang.Exception
をラップする場合。InstanceAlreadyExistsException
- MBean がすでに MBean サーバーによって制御されている場合。MBeanRegistrationException
- MBean の preRegister
(MBeanRegistration
インタフェース) メソッドが例外をスローした場合。MBean は登録されない。RuntimeMBeanException
- MBean のコンストラクタ、あるいはその preRegister
または postRegister
メソッドが RuntimeException
をスローした場合。MBean の postRegister
(MBeanRegistration
インタフェース) メソッドが RuntimeException
をスローすると、MBean の作成と登録は成功しますが、createMBean
メソッドは RuntimeMBeanException
をスローします。このような場合、createMBean
メソッドが例外をスローしたとしても、MBean は実際に登録されます。RuntimeMBeanException
は preRegister
でもスローされますが、その場合は MBean は登録されません。RuntimeErrorException
- MBean の postRegister
(MBeanRegistration
インタフェース) メソッドが Error
をスローすると、MBean の作成と登録は成功しますが、createMBean
メソッドは RuntimeErrorException
をスローします。このような場合、createMBean
メソッドが例外をスローしたとしても、MBean は実際に登録されます。RuntimeErrorException
は preRegister
でもスローされますが、その場合は MBean は登録されません。MBeanException
- MBean のコンストラクタが例外をスローした場合NotCompliantMBeanException
- このクラスが JMX 準拠の MBean でない場合RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータに渡される className が null であるか、パラメータに渡される ObjectName
がパターンであるか、MBean に ObjectName
が指定されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。MBeanRegistration
ObjectInstance createMBean(String className, ObjectName name, ObjectName loaderName, Object[] params, String[] signature) throws ReflectionException, InstanceAlreadyExistsException, MBeanRegistrationException, MBeanException, NotCompliantMBeanException, InstanceNotFoundException, IOException
MBean をインスタンス化し、MBean サーバーに登録します。使用するクラスローダーは、オブジェクト名で識別されます。MBean にはオブジェクト名が関連付けられます。ローダーのオブジェクト名が指定されていない場合、MBean サーバーのロードに使用した ClassLoader が使用されます。MBean のオブジェクト名が null の場合、MBean は、MBeanRegistration
インタフェースを実装し、preRegister
メソッドから返される独自の名前を使用する必要があります。
className
- インスタンス化する MBean のクラス名。name
- MBean のオブジェクト名。null も可。params
- 呼び出されるコンストラクタのパラメータを含む配列。signature
- 呼び出されるコンストラクタのシグニチャーを含む配列。loaderName
- 使用するクラスローダーのオブジェクト名。ObjectName
と Java クラス名を含む ObjectInstance
。含まれる ObjectName
が n
の場合、含まれる Java クラス名は getMBeanInfo(n)
.getClassName()
。ReflectionException
- MBean のコンストラクタの呼び出し時に発行される java.lang.ClassNotFoundException
または java.lang.Exception
をラップする場合。InstanceAlreadyExistsException
- MBean がすでに MBean サーバーによって制御されている場合。MBeanRegistrationException
- MBean の preRegister
(MBeanRegistration
インタフェース) メソッドが例外をスローした場合。MBean は登録されない。RuntimeMBeanException
- MBean のコンストラクタ、あるいはその preRegister
または postRegister
メソッドが RuntimeException
をスローした場合。MBean の postRegister
(MBeanRegistration
インタフェース) メソッドが RuntimeException
をスローすると、MBean の作成と登録は成功しますが、createMBean
メソッドは RuntimeMBeanException
をスローします。このような場合、createMBean
メソッドが例外をスローしたとしても、MBean は実際に登録されます。RuntimeMBeanException
は preRegister
でもスローされますが、その場合は MBean は登録されません。RuntimeErrorException
- MBean の postRegister
メソッド (MBeanRegistration
インタフェース) メソッドが Error
をスローすると、MBean の作成と登録は成功しますが、createMBean
メソッドは RuntimeErrorException
をスローします。このような場合、createMBean
メソッドが例外をスローしたとしても、MBean は実際に登録されます。RuntimeErrorException
は preRegister
でもスローされますが、その場合は MBean は登録されません。MBeanException
- MBean のコンストラクタが例外をスローした場合NotCompliantMBeanException
- このクラスが JMX 準拠の MBean でない場合InstanceNotFoundException
- 指定されたクラスローダーが MBean サーバーに登録されていない場合。RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータに渡される className が null であるか、パラメータに渡される ObjectName
がパターンであるか、MBean に ObjectName
が指定されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。MBeanRegistration
void unregisterMBean(ObjectName name) throws InstanceNotFoundException, MBeanRegistrationException, IOException
name
- 登録解除する MBean のオブジェクト名。InstanceNotFoundException
- 指定された MBean が MBean サーバーに登録されていない場合。MBeanRegistrationException
- MBean の preDeregister (MBeanRegistration
インタフェース) メソッドが例外をスローした場合。RuntimeMBeanException
- MBean の postDeregister
(MBeanRegistration
インタフェース) メソッドが RuntimeException
をスローすると、MBean の登録解除は成功しますが、unregisterMBean
メソッドは RuntimeMBeanException
をスローします。このような場合、unregisterMBean
メソッドが例外をスローしたとしても、MBean は実際に登録解除されます。RuntimeMBeanException
は preDeregister
でもスローされますが、その場合は MBean の登録は解除されません。RuntimeErrorException
- MBean の postDeregister
(MBeanRegistration
インタフェース) メソッドが Error
をスローすると、MBean の登録解除は成功しますが、unregisterMBean
メソッドは RuntimeErrorException
をスローします。このような場合、unregisterMBean
メソッドが例外をスローしたとしても、MBean は実際に登録解除されます。RuntimeMBeanException
は preDeregister
でもスローされますが、その場合は MBean の登録は解除されません。RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータ内のオブジェクト名が null であるか、登録解除しようとしている MBean が MBeanServerDelegate
である場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。MBeanRegistration
ObjectInstance getObjectInstance(ObjectName name) throws InstanceNotFoundException, IOException
ObjectInstance
を取得します。name
- MBean のオブジェクト名。ObjectInstance
。含まれる ObjectName
は name
で、含まれるクラス名は getMBeanInfo(name)
.getClassName()
。InstanceNotFoundException
- 指定された MBean が MBean サーバーに登録されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。Set<ObjectInstance> queryMBeans(ObjectName name, QueryExp query) throws IOException
ObjectName
やクエリー式のパターンマッチングによって指定された MBean のセット、特定の MBean のいずれかを返します。オブジェクト名が null である場合、またはドメインやキーのプロパティーが指定されていない場合、すべてのオブジェクトが選択されます。クエリーが指定されている場合は、さらにフィルタリングが適用されます。このメソッドは、選択された MBean に対して、ObjectInstance
オブジェクトのセット (ObjectName
と Java クラス名を含む) を返します。name
- 取得する MBean を識別するオブジェクト名パターン。null の場合、またはドメインやキーのプロパティーが指定されていない場合は、登録されているすべての MBean が取得される。query
- MBean の選択に適用されるクエリー式。null の場合、MBean の選択にクエリー式は適用されない。ObjectInstance
オブジェクトを含むセット。クエリーの条件を満たす MBean が存在しない場合、空のリストが返される。IOException
- MBean サーバーとの通信時に問題が発生した場合。Set<ObjectName> queryNames(ObjectName name, QueryExp query) throws IOException
ObjectName
や Query 式のパターンマッチングによって指定された MBean のセットの名前、特定の MBean の名前のいずれかを返します。これにより、MBean が登録されているかどうかを判別できます。オブジェクト名が null である場合、またはドメインやキーのプロパティーが指定されていない場合、すべてのオブジェクトが選択されます。クエリーが指定されている場合は、さらにフィルタリングが適用されます。このメソッドは、選択された MBean に対して、ObjectName のセットを返します。name
- 取得する MBean 名を識別するオブジェクト名パターン。null の場合、またはドメインやキーのプロパティーが指定されていない場合は、登録されているすべての MBean の名前が取得される。query
- MBean の選択に適用されるクエリー式。null の場合、MBean の選択にクエリー式は適用されない。IOException
- MBean サーバーとの通信時に問題が発生した場合。boolean isRegistered(ObjectName name) throws IOException
name
- チェック対象の MBean のオブジェクト名。RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータ内のオブジェクト名が null の場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。Integer getMBeanCount() throws IOException
IOException
- MBean サーバーとの通信時に問題が発生した場合。Object getAttribute(ObjectName name, String attribute) throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException, IOException
name
- MBean のオブジェクト名。この MBean の属性が取得される。attribute
- 取得される属性の名前を指定する String。AttributeNotFoundException
- MBean の指定された属性がアクセス不能である場合。MBeanException
- MBean の getter によってスローされる例外をラップする場合。InstanceNotFoundException
- 指定された MBean が MBean サーバーに登録されていない場合。ReflectionException
- setter の呼び出し時にスローされる java.lang.Exception
をラップする場合。RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータ内のオブジェクト名が null であるか、パラメータ内の属性が null である場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。setAttribute(javax.management.ObjectName, javax.management.Attribute)
AttributeList getAttributes(ObjectName name, String[] attributes) throws InstanceNotFoundException, ReflectionException, IOException
指定された MBean の複数の属性の値を取り出します。MBean はオブジェクト名で識別されます。
何らかの理由で 1 つ以上の属性を取得できない場合、それらは返される AttributeList
から省略されます。呼び出し側はリストが attributes
配列と同じサイズであることを確認する必要があります。属性の取得を妨げた問題を見つけるには、その属性の getAttribute
を呼び出します。
このメソッドを呼び出して、要求されたすべての属性を正常に取得できたことを確認する例を次に示します。
String[] attrNames = ...; AttributeList list = mbeanServerConnection.getAttributes(objectName, attrNames); if (list.size() == attrNames.length) System.out.println("All attributes were retrieved successfully"); else {List<String>
missing = newArrayList<String>
(Arrays.asList
(attrNames)); for (Attribute a : list.asList()) missing.remove(a.getName()); System.out.println("Did not retrieve: " + missing); }
name
- MBean のオブジェクト名。この MBean の属性が取得される。attributes
- 取得される属性のリスト。InstanceNotFoundException
- 指定された MBean が MBean サーバーに登録されていない場合。ReflectionException
- Dynamic MBean の getAttributes メソッドの呼び出し時に例外が発生した場合。RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータ内のオブジェクト名が null であるか、パラメータ内の属性が null である場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。setAttributes(javax.management.ObjectName, javax.management.AttributeList)
void setAttribute(ObjectName name, Attribute attribute) throws InstanceNotFoundException, AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException, IOException
name
- MBean 名。この MBean の属性が設定される。attribute
- 設定される属性の ID と設定される値。InstanceNotFoundException
- 指定された MBean が MBean サーバーに登録されていない場合。AttributeNotFoundException
- MBean の指定された属性がアクセス不能である場合。InvalidAttributeValueException
- 指定された値が、属性に対する有効な値でない場合。MBeanException
- MBean の setter によってスローされる例外をラップする場合。ReflectionException
- setter の呼び出し時にスローされる java.lang.Exception
をラップする場合。RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータ内のオブジェクト名が null であるか、パラメータ内の属性が null である場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。getAttribute(javax.management.ObjectName, java.lang.String)
AttributeList setAttributes(ObjectName name, AttributeList attributes) throws InstanceNotFoundException, ReflectionException, IOException
指定された MBean の複数の属性の値を設定します。MBean はオブジェクト名で識別されます。
何らかの理由で 1 つ以上の属性を設定できない場合、それらは返される AttributeList
から省略されます。呼び出し側は入力の AttributeList
が出力のそれと同じサイズであることを確認する必要があります。属性の取得を妨げた問題の発見は、通常、その属性の setAttribute
を呼び出すことで可能ですが、必ずしも成功する保証はありません。たとえば、2 つの属性の値が互いに矛盾するために拒否された可能性があります。どちらか 1 つであれば、設定できる可能性があります。
このメソッドを呼び出して、要求されたすべての属性を正常に設定できたことを確認する例を次に示します。
AttributeList inputAttrs = ...; AttributeList outputAttrs = mbeanServerConnection.setAttributes(objectName, inputAttrs); if (inputAttrs.size() == outputAttrs.size()) System.out.println("All attributes were set successfully"); else {List<String>
missing = newArrayList<String>
(); for (Attribute a : inputAttrs.asList()) missing.add(a.getName()); for (Attribute a : outputAttrs.asList()) missing.remove(a.getName()); System.out.println("Did not set: " + missing); }
name
- MBean のオブジェクト名。この MBean の属性が設定される。attributes
- 属性のリスト。属性のリスト (設定される属性の ID と設定される値)。InstanceNotFoundException
- 指定された MBean が MBean サーバーに登録されていない場合。ReflectionException
- Dynamic MBean の getAttributes メソッドの呼び出し時に例外が発生した場合。RuntimeOperationsException
- java.lang.IllegalArgumentException
をラップする場合。すなわち、パラメータ内のオブジェクト名が null であるか、パラメータ内の属性が null である場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。getAttributes(javax.management.ObjectName, java.lang.String[])
Object invoke(ObjectName name, String operationName, Object[] params, String[] signature) throws InstanceNotFoundException, MBeanException, ReflectionException, IOException
MBean上でオペレーションを呼び出します。
オーバーロードされる可能性があるオペレーションを区別するために signature
が必要であるため、可能な場合は、MBean プロキシを介してさらに簡単にオペレーションを呼び出すことができます。たとえば、次のような Standard MBean インタフェースが存在する場合を考えましょう。
public interface FooMBean { public int countMatches(String[] patterns, boolean ignoreCase); }
countMatches
オペレーションは次のようにして呼び出すことができます。
String[] myPatterns = ...; int count = (Integer) mbeanServerConnection.invoke( objectName, "countMatches", new Object[] {myPatterns, true}, new String[] {String[].class.getName(), boolean.class.getName()});
または、次のようにプロキシを介して呼び出すこともできます。
String[] myPatterns = ...; FooMBean fooProxy = JMX.newMBeanProxy( mbeanServerConnection, objectName, FooMBean.class); int count = fooProxy.countMatches(myPatterns, true);
name
- メソッドの呼び出しが行われる MBean のオブジェクト名。operationName
- 呼び出されるオペレーションの名前。params
- オペレーションの呼び出し時に設定されるパラメータを含む配列。signature
- オペレーションのシグニチャーを含む配列 (Class.getName()
から返される形式のクラス名の配列)。クラスオブジェクトのロードには、オペレーションを呼び出した MBean をロードするときと同じクラスローダーが使用される。InstanceNotFoundException
- 指定された MBean が MBean サーバーに登録されていない場合。MBeanException
- MBean の呼び出しメソッドによってスローされる例外をラップする場合。ReflectionException
- メソッドの呼び出し時にスローされる java.lang.Exception
をラップする場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。String getDefaultDomain() throws IOException
IOException
- MBean サーバーとの通信時に問題が発生した場合。String[] getDomains() throws IOException
MBean が現在登録されているドメインのリストを返します。返される配列内に文字列が含まれるのは、その文字列と等しい getDomain()
を持つ ObjectName に 1 個以上の MBean が登録されている場合だけです。返される配列内の文字列の順序は未定義です。
IOException
- MBean サーバーとの通信時に問題が発生した場合。void addNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, IOException
登録済み MBean にリスナーを追加します。MBean が発行した通知は、リスナーに転送されます。
name
- リスナーが追加される MBean の名前。listener
- 登録済み MBean が発行した通知を処理するリスナーオブジェクト。filter
- フィルタオブジェクト。フィルタが null の場合、通知処理の前にフィルタは適用されない。handback
- 通知が発行されたときリスナーに送信されるコンテキスト。InstanceNotFoundException
- 登録済み MBean の中に、指定された MBean 名がない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。removeNotificationListener(ObjectName, NotificationListener)
, removeNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)
void addNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, IOException
登録済み MBean にリスナーを追加します。
MBean が発行した通知は、MBeanServer によってリスナーに転送されます。通知のソースが MBean オブジェクトの参照になっている場合、MBean サーバーは、これを MBean の ObjectName で置き換えます。それ以外の場合、ソースが変更されることはありません。
通知を受け取るリスナーオブジェクトは、このメソッドの呼び出し時に指定された名前で登録されたリスナーオブジェクトです。その後は登録しなくても引き続き通知を受け取ります。
name
- リスナーが追加される MBean の名前。listener
- 登録済み MBean が発行した通知を処理するリスナーのオブジェクト名。filter
- フィルタオブジェクト。フィルタが null の場合、通知処理の前にフィルタは適用されない。handback
- 通知が発行されたときリスナーに送信されるコンテキスト。InstanceNotFoundException
- 登録済み MBean の中に、通知リスナーまたは通知ブロードキャスタの MBean 名がない場合。RuntimeOperationsException
- IllegalArgumentException
をラップする場合。listener
によって指定された MBean が存在していても、NotificationListener
インタフェースを実装していない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。removeNotificationListener(ObjectName, ObjectName)
, removeNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)
void removeNotificationListener(ObjectName name, ObjectName listener) throws InstanceNotFoundException, ListenerNotFoundException, IOException
リスナーが、別のフィルタまたはコールバックにより複数回登録された場合、このメソッドは、これらすべての登録を削除します。
name
- リスナーが削除される MBean の名前。listener
- 削除されるリスナーのオブジェクト名。InstanceNotFoundException
- 登録済み MBean の中に、指定された MBean 名がない場合。ListenerNotFoundException
- リスナーが MBean に登録されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)
void removeNotificationListener(ObjectName name, ObjectName listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException, IOException
登録済み MBean からリスナーを削除します。
MBean は、指定された listener
、filter
、および handback
パラメータと正確に一致するリスナーを持っている必要があります。該当するリスナーが複数存在する場合、そのうちの 1 つだけが削除されます。
削除されるリスナー内で null が指定されている場合にのみ、filter
および handback
パラメータは null になります。
name
- リスナーが削除される MBean の名前。listener
- 削除されるリスナーのオブジェクト名。filter
- リスナーの追加時に指定されたフィルタ。handback
- リスナーの追加時に指定されたハンドバック。InstanceNotFoundException
- 登録済み MBean の中に、指定された MBean 名がない場合。ListenerNotFoundException
- リスナーが MBean に登録されていない場合、または指定されたフィルタおよびハンドバックで登録されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。addNotificationListener(ObjectName, ObjectName, NotificationFilter, Object)
void removeNotificationListener(ObjectName name, NotificationListener listener) throws InstanceNotFoundException, ListenerNotFoundException, IOException
登録済み MBean からリスナーを削除します。
リスナーが、別のフィルタまたはコールバックにより複数回登録された場合、このメソッドは、これらすべての登録を削除します。
name
- リスナーが削除される MBean の名前。listener
- 削除されるリスナー。InstanceNotFoundException
- 登録済み MBean の中に、指定された MBean 名がない場合。ListenerNotFoundException
- リスナーが MBean に登録されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)
void removeNotificationListener(ObjectName name, NotificationListener listener, NotificationFilter filter, Object handback) throws InstanceNotFoundException, ListenerNotFoundException, IOException
登録済み MBean からリスナーを削除します。
MBean は、指定された listener
、filter
、および handback
パラメータと正確に一致するリスナーを持っている必要があります。該当するリスナーが複数存在する場合、そのうちの 1 つだけが削除されます。
削除されるリスナー内で null が指定されている場合にのみ、filter
および handback
パラメータは null になります。
name
- リスナーが削除される MBean の名前。listener
- 削除されるリスナー。filter
- リスナーの追加時に指定されたフィルタ。handback
- リスナーの追加時に指定されたハンドバック。InstanceNotFoundException
- 登録済み MBean の中に、指定された MBean 名がない場合。ListenerNotFoundException
- リスナーが MBean に登録されていない場合、または指定されたフィルタおよびハンドバックで登録されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。addNotificationListener(ObjectName, NotificationListener, NotificationFilter, Object)
MBeanInfo getMBeanInfo(ObjectName name) throws InstanceNotFoundException, IntrospectionException, ReflectionException, IOException
name
- 分析対象の MBean の名前。MBeanInfo
のインスタンス。この MBean のすべての属性とオペレーションの取得を許可する。IntrospectionException
- イントロスペクション中に例外が発生した場合。InstanceNotFoundException
- 指定された MBean が見つからなかった場合。ReflectionException
- Dynamic MBean の getMBeanInfo メソッドの呼び出し時に例外が発生した場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。boolean isInstanceOf(ObjectName name, String className) throws InstanceNotFoundException, IOException
指定された MBean が指定されたクラスのインスタンスである場合は true、そうでない場合は false を返します。
name
が MBean を指定していない場合、このメソッドは InstanceNotFoundException
をスローします。
それ以外の場合、
X は name
で指定された MBean、
L は X の ClassLoader、
N は X の MBeanInfo
内のクラス名になります。
N が className
と等しい場合、結果は true です。
それ以外の場合、L が className
を正常にロードし、X がこのクラスのインスタンスである場合、結果は true です。
それ以外の場合、L が N と className
の両方を正常にロードし、最初のクラスから 2 番目のクラスを割り当てることができる場合、結果は true です。
それ以外の場合、結果は false です。
name
- MBean の ObjectName
。className
- クラスの名前。InstanceNotFoundException
- 指定された MBean が MBean サーバーに登録されていない場合。IOException
- MBean サーバーとの通信時に問題が発生した場合。Class.isInstance(java.lang.Object)
バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.