javax.management

インタフェース MBeanRegistration

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

CounterMonitor、GaugeMonitor、JMXConnectorServer、MLet、Monitor、PrivateMLet、RelationService、RelationSupport、RequiredModelMBean、RMIConnectorServer、StandardEmitterMBean、StandardMBean、StringMonitor、Timer

public interface MBeanRegistration

MBean サーバーへの登録または MBean サーバーからの登録解除の前後にさまざまなオペレーションを実行するため、MBean により実装されます。MBean サーバーまたは MBean サーバー内の名前、あるいはその両方への参照を取得するために、MBean もこのインタフェースを実装できます。

導入されたバージョン:

1.5

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	postDeregister() MBean サーバーから登録解除したあと、MBean が必要なオペレーションを実行できるようにします。
void	postRegister(Boolean registrationDone) MBean サーバーへの登録が成功または失敗したあと、MBean が必要なオペレーションを実行できるようにします。
void	preDeregister() MBean サーバーから登録解除する前に、MBean が必要なオペレーションを実行できるようにします。
ObjectName	preRegister(MBeanServer server, ObjectName name) MBean サーバーに登録する前に、MBean が必要なオペレーションを実行できるようにします。

メソッドの詳細

preRegister

ObjectName preRegister(MBeanServer server,
                     ObjectName name)
                       throws Exception

MBean サーバーに登録する前に、MBean が必要なオペレーションを実行できるようにします。MBean の名前を指定しないと、MBean により、登録用の名前が提供されます。例外がスローされた場合、MBean は MBean サーバーに登録されません。

パラメータ:

server - MBean サーバー。MBean はここに登録される。

name - MBean のオブジェクト名。MBeanServer インタフェース内の createMBean または registerMBean メソッドの name パラメータが null の場合、この名前も null になる。この場合、このメソッドは、新しい MBean 用に null 以外の ObjectName を必ず返す。

戻り値:

MBean の登録名。null は指定できない。name パラメータが null 以外の場合、通常は値が返されるが、これは必須ではない。

例外:

Exception - この例外は、MBean サーバーにキャッチされ、MBeanRegistrationException として再スローされる。

postRegister

void postRegister(Boolean registrationDone)

MBean サーバーへの登録が成功または失敗したあと、MBean が必要なオペレーションを実行できるようにします。

このメソッドの実装が RuntimeException または Error をスローする場合、MBean サーバーは RuntimeMBeanException または RuntimeErrorException の内部でこれらをそれぞれ再スローします。ただし、postRegister で例外をスローしても MBean の状態は変化しません。MBean がすでに登録されている (registrationDone が true である) 場合、MBean の登録は解除されません。

createMBean() または registerMBean() を呼び出すコードでは、このような例外が発行されたときに MBean の登録が失敗したとみなされることがあるため、これによって混乱が生じる可能性があります。したがって、回避できる場合は postRegister の実装で実行時例外またはエラーをスローしないことをお勧めします。

パラメータ:

registrationDone - MBean が MBean サーバーに正常に登録されたかどうかを示す。登録に失敗した場合の値は false。

preDeregister

void preDeregister()
                   throws Exception

MBean サーバーから登録解除する前に、MBean が必要なオペレーションを実行できるようにします。

例外:

Exception - この例外は、MBean サーバーにキャッチされ、MBeanRegistrationException として再スローされる。

postDeregister

void postDeregister()

MBean サーバーから登録解除したあと、MBean が必要なオペレーションを実行できるようにします。

このメソッドの実装が RuntimeException または Error をスローする場合、MBean サーバーは RuntimeMBeanException または RuntimeErrorException の内部でこれらをそれぞれ再スローします。ただし、postDeregister で例外をスローしても MBean の状態は変化しません。MBean はすでに正常に登録解除されており、その状態のままになります。

unregisterMBean() を呼び出すコードでは、MBean の登録解除が失敗したとみなされることがあるため、これによって混乱が生じる可能性があります。したがって、回避できる場合は postDeregister の実装で実行時例外またはエラーをスローしないことをお勧めします。