javax.management
クラス NotificationBroadcasterSupport

java.lang.Object
  javax.management.NotificationBroadcasterSupport

すべての実装されたインタフェース:

NotificationBroadcaster, NotificationEmitter

直系の既知のサブクラス:

JMXConnectorServer, Monitor, RelationService, Timer

public class NotificationBroadcasterSupport
extends Object
implements NotificationEmitter

NotificationEmitter インタフェースの実装を提供します。これは、通知を送信する MBean のスーパークラスとして使用可能です。

通知ディスパッチモデルが同期モデルであるか非同期モデルであるかは指定されていません。スレッドが sendNotification を呼び出したとき、各リスナーの NotificationListener.handleNotification メソッドがそのスレッド内で呼び出されれば同期モデル、別のスレッド内で呼び出されれば非同期モデルということになります。

アプリケーションは、通知ディスパッチが同期または非同期であるかに依存してはなりません。

• アプリケーションは同期モデルを想定できない。sendNotification メソッドの終了時までに、すべてのリスナーの handleNotification メソッドが呼び出されるわけではない。また、リスナーは、通知を生成された順に受信するとは限らない。順番に依存するリスナーは、通知シーケンス番号を使って、受信した通知の並び順を確認する (Notification.getSequenceNumber() を参照)
• アプリケーションは非同期モデルを想定しない。アクションを速やかに実行できないと判断した場合、リスナーは、その他のリスナーや sendNotification の呼び出し元への応答の遅延を回避するため、別のスレッドでアクションを実行する

導入されたバージョン:

1.5

コンストラクタの概要

NotificationBroadcasterSupport()

メソッドの概要

void	addNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) リスナーを追加します。
MBeanNotificationInfo[]	getNotificationInfo() この MBean が通知を送信するたびに、その通知の Java クラス名と通知型を示す配列を返します。
protected void	handleNotification(NotificationListener listener, Notification notif, Object handback) このメソッドは、リスナーに通知を送信するため、sendNotification によって呼び出されます。
void	removeNotificationListener(NotificationListener listener) この MBean からリスナーを削除します。
void	removeNotificationListener(NotificationListener listener, NotificationFilter filter, Object handback) この MBean からリスナーを削除します。
void	sendNotification(Notification notification) 通知を送信します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

NotificationBroadcasterSupport

public NotificationBroadcasterSupport()

メソッドの詳細

addNotificationListener

public void addNotificationListener(NotificationListener listener,
                                    NotificationFilter filter,
                                    Object handback)

リスナーを追加します。

定義:

インタフェース NotificationBroadcaster 内の addNotificationListener

パラメータ:

listener - 通知を受け取るリスナー

filter - フィルタオブジェクト。フィルタが null の場合、通知処理の前にフィルタは適用されない

handback - 通知の発行時にリスナーに送信される不透明なオブジェクト。Notification ブロードキャスタオブジェクトは、このオブジェクトを使用できない。このオブジェクトは、手を加えない状態で、通知と共にリスナーへ送り返されなければならない

例外:

IllegalArgumentException - リスナーが null の場合

関連項目:

removeNotificationListener(javax.management.NotificationListener)

removeNotificationListener

public void removeNotificationListener(NotificationListener listener)
                                throws ListenerNotFoundException

インタフェース NotificationBroadcaster の記述:

この MBean からリスナーを削除します。リスナーが別のハンドバックオブジェクトまたは通知フィルタに登録されている場合、このリスナーに対応するすべてのエントリが削除されます。

定義:

インタフェース NotificationBroadcaster 内の removeNotificationListener

パラメータ:

listener - 以前にこの MBean に追加されたリスナー

例外:

ListenerNotFoundException - リスナーが MBean に登録されていない場合

関連項目:

NotificationBroadcaster.addNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object), NotificationEmitter.removeNotificationListener(javax.management.NotificationListener, javax.management.NotificationFilter, java.lang.Object)

removeNotificationListener

public void removeNotificationListener(NotificationListener listener,
                                       NotificationFilter filter,
                                       Object handback)
                                throws ListenerNotFoundException

インタフェース NotificationEmitter の記述:

この MBean からリスナーを削除します。MBean は、指定された listener、filter、および handback パラメータと正確に一致するリスナーを持っている必要があります。該当するリスナーが複数存在する場合、そのうちの 1 つだけが削除されます。

削除されるリスナー内で null が指定されている場合、filter および handback パラメータは null になります。

定義:

インタフェース NotificationEmitter 内の removeNotificationListener

パラメータ:

listener - 以前にこの MBean に追加されたリスナー

filter - リスナーの追加時に指定されたフィルタ

handback - リスナーの追加時に指定されたハンドバック

例外:

ListenerNotFoundException - リスナーが MBean に登録されていない場合、または指定されたフィルタおよびハンドバックで登録されていない場合

getNotificationInfo

public MBeanNotificationInfo[] getNotificationInfo()

インタフェース NotificationBroadcaster の記述:

この MBean が通知を送信するたびに、その通知の Java クラス名と通知型を示す配列を返します。

MBean が、この配列に記述されていない通知を送信することはできません。ただし、一部の MBean サーバクライアントは、現在の機能によって完成する配列に依存している場合があります。

定義:

インタフェース NotificationBroadcaster 内の getNotificationInfo

戻り値:

通知の配列

sendNotification

public void sendNotification(Notification notification)

通知を送信します。

パラメータ:

notification - 送信する通知

handleNotification

protected void handleNotification(NotificationListener listener,
                                  Notification notif,
                                  Object handback)

このメソッドは、リスナーに通知を送信するため、sendNotification によって呼び出されます。通知の配信方法を変更したい場合、たとえば通知を別々のスレッドで配信したい場合などは、サブクラス内でオーバーライドできます。

このメソッドは、sendNotification を呼び出したスレッドによって呼び出されるとは限りません。

このメソッドのデフォルト実装は、以下と同等です。

 listener.handleNotification(notif, handback);
 

パラメータ:

listener - 通知の配信先リスナー

notif - リスナーに配信される通知

handback - リスナーの追加時に指定されたハンドバックオブジェクト