MBeanRegistrationSupport (Spring Framework 5.1.1.RELEASE API)

java.lang.Object
- org.springframework.jmx.support.MBeanRegistrationSupport

既知の直属サブクラス
ConnectorServerFactoryBean, MBeanExporter
```
public class MBeanRegistrationSupport
extends java.lang.Object
```
MBean を MBeanServer に登録するためのサポートインフラストラクチャを提供します。特定の ObjectName で既存の MBean に遭遇したときの動作は完全に構成可能であり、柔軟な登録設定が可能です。
登録されているすべての MBean は追跡され、unregisterBeans() メソッドを呼び出すことで登録解除できます。
サブクラスは、onRegister(ObjectName) メソッドと onUnregister(ObjectName) メソッドをそれぞれオーバーライドすることにより、MBean が登録または登録解除されたときに通知を受け取ることができます。
デフォルトでは、すでに使用されている ObjectName を使用して MBean を登録しようとすると、登録プロセスは失敗します。
registrationPolicy プロパティを RegistrationPolicy.IGNORE_EXISTING に設定すると、登録プロセスは既存の MBean を無視して、登録したままにします。これは、複数のアプリケーションが共有 MBeanServer で共通の MBean を共有する必要がある設定で役立ちます。
registrationPolicy プロパティを RegistrationPolicy.REPLACE_EXISTING に設定すると、必要に応じて、登録時に既存の MBean が置き換えられます。これは、MBeanServer の状態を保証できない状況で役立ちます。
導入:
2.0
作成者:
Rob Harrop, Juergen Hoeller, Phillip Webb
関連事項:
setServer(javax.management.MBeanServer), setRegistrationPolicy(org.springframework.jmx.support.RegistrationPolicy), MBeanExporter

フィールド概要

フィールド
修飾子と型	フィールドと説明
`protected Log`	`logger` このクラスの `Log` インスタンス。
`protected javax.management.MBeanServer`	`server` Bean の登録に使用されている `MBeanServer` インスタンス。

コンストラクター概要
コンストラクター
コンストラクターと説明
MBeanRegistrationSupport()

コンストラクター
コンストラクターと説明
`MBeanRegistrationSupport()`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected void`	`doRegister(java.lang.Object mbean, javax.management.ObjectName objectName)` 実際に MBean をサーバーに登録します。
`protected void`	`doUnregister(javax.management.ObjectName objectName)` 指定された MBean をサーバーから実際に登録解除します。
`protected javax.management.ObjectName[]`	`getRegisteredObjectNames()` 登録されているすべての Bean の `ObjectNames` を返します。
`javax.management.MBeanServer`	`getServer()` Bean が登録される `MBeanServer` を返します。
`protected void`	`onRegister(javax.management.ObjectName objectName)` MBean が指定された `ObjectName` で登録されたときに呼び出されます。
`protected void`	`onRegister(javax.management.ObjectName objectName, java.lang.Object mbean)` MBean が指定された `ObjectName` で登録されたときに呼び出されます。
`protected void`	`onUnregister(javax.management.ObjectName objectName)` MBean が指定された `ObjectName` で登録解除されたときに呼び出されます。
`void`	`setRegistrationPolicy(RegistrationPolicy registrationPolicy)` すでに存在する `ObjectName` で MBean を登録しようとするときに使用するポリシー。
`void`	`setServer(javax.management.MBeanServer server)` すべての Bean を登録する `MBeanServer` インスタンスを指定します。
`protected void`	`unregisterBeans()` このクラスのインスタンスによって登録されたすべての Bean を登録解除します。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - logger
```
protected final Log logger
```
    このクラスの Log インスタンス。
  - server
```
@Nullable
protected javax.management.MBeanServer server
```
    Bean の登録に使用されている MBeanServer インスタンス。
- コンストラクターの詳細
  - MBeanRegistrationSupport
```
public MBeanRegistrationSupport()
```
- メソッドの詳細
  - setServer
```
public void setServer(@Nullable
                      javax.management.MBeanServer server)
```
    すべての Bean を登録する MBeanServer インスタンスを指定します。MBeanExporter は、何も指定されていない場合、既存の MBeanServer を見つけようとします。
  - getServer
```
@Nullable
public final javax.management.MBeanServer getServer()
```
    Bean が登録される MBeanServer を返します。
  - setRegistrationPolicy
```
public void setRegistrationPolicy(RegistrationPolicy registrationPolicy)
```
    すでに存在する ObjectName で MBean を登録しようとするときに使用するポリシー。
    パラメーター:
    registrationPolicy - 使用するポリシー
    導入:
    3.2
  - doRegister
```
protected void doRegister(java.lang.Object mbean,
                          javax.management.ObjectName objectName)
                   throws javax.management.JMException
```
    実際に MBean をサーバーに登録します。既存の MBean に遭遇したときの動作は、setRegistrationPolicy(org.springframework.jmx.support.RegistrationPolicy) を使用して構成できます。
    パラメーター:
    mbean - MBean インスタンス
    objectName - MBean の推奨 ObjectName
    例外:
    javax.management.JMException - 登録に失敗した場合
  - unregisterBeans
```
protected void unregisterBeans()
```
    このクラスのインスタンスによって登録されたすべての Bean を登録解除します。
  - doUnregister
```
protected void doUnregister(javax.management.ObjectName objectName)
```
    指定された MBean をサーバーから実際に登録解除します。
    パラメーター:
    objectName - MBean の推奨 ObjectName
  - getRegisteredObjectNames
```
protected final javax.management.ObjectName[] getRegisteredObjectNames()
```
    登録されているすべての Bean の ObjectNames を返します。
  - onRegister
```
protected void onRegister(javax.management.ObjectName objectName,
                          java.lang.Object mbean)
```
    指定された ObjectName で MBean が登録されたときに呼び出されます。MBean の登録時に、サブクラスが追加の処理を実行できるようにします。
    デフォルトの実装は onRegister(ObjectName) に委譲します。
    パラメーター:
    objectName - MBean が登録された実際の ObjectName
    mbean - 登録された MBean インスタンス
  - onRegister
```
protected void onRegister(javax.management.ObjectName objectName)
```
    指定された ObjectName で MBean が登録されたときに呼び出されます。MBean の登録時に、サブクラスが追加の処理を実行できるようにします。
    デフォルトの実装は空です。サブクラスでオーバーライドできます。
    パラメーター:
    objectName - MBean が登録された実際の ObjectName
  - onUnregister
```
protected void onUnregister(javax.management.ObjectName objectName)
```
    指定された ObjectName で MBean が登録解除されたときに呼び出されます。MBean が登録解除されたときに、サブクラスが追加の処理を実行できるようにします。
    デフォルトの実装は空です。サブクラスでオーバーライドできます。
    パラメーター:
    objectName - MBean が登録された ObjectName

クラス MBeanRegistrationSupport

フィールド概要

コンストラクター概要

方法の概要

クラス java.lang.Object から継承されたメソッド

フィールドの詳細

logger

server

コンストラクターの詳細

MBeanRegistrationSupport

メソッドの詳細

setServer

getServer

setRegistrationPolicy

doRegister

unregisterBeans

doUnregister

getRegisteredObjectNames

onRegister

onRegister

onUnregister