Relation (Java 2 Platform SE 5.0)

複数のプロパティやメソッドを持つ、より複雑な関係を表現したい場合は、Relation インタフェースを実装する独自のクラスを用意する必要があります。このクラスは、RelationSupport クラスから継承するか、インタフェース (RelationSupport オブジェクトメンバ、またはその委譲) を実装することによって取得できます。

こうしたユーザ関係クラスを指定することにより、プロパティやメソッドを導入できます。これらのプロパティやメソッドは、リモート管理用に公開する必要があります。つまり、すべてのユーザ関係クラスは MBean クラスでなければなりません。

導入されたバージョン:: 1.5

メソッドの概要
`RoleResult`	`getAllRoles()` 関係に含まれるすべてのロールを返します。
`Map`	`getReferencedMBeans()` 関係のさまざまなロールで参照される MBean を取得します。
`String`	`getRelationId()` 関係サービス内の関係を一意に識別するために使用される関係識別子を返します。
`ObjectName`	`getRelationServiceName()` 関係を処理する関係サービスの ObjectName を返します。
`String`	`getRelationTypeName()` 関連付けられた関係型の名前を返します。
`List`	`getRole(String theRoleName)` 指定されたロール名のロール値を取得します。
`Integer`	`getRoleCardinality(String theRoleName)` 指定されたロール内で現在参照されている MBean の数を返します。
`RoleResult`	`getRoles(String[] theRoleNameArray)` 指定された名前のロールの値を取得します。
`void`	`handleMBeanUnregistration(ObjectName theObjName, String theRoleName)` ロールに含まれる参照対象の MBean の登録が解除された場合に関係サービスによって使用されるコールバックです。
`RoleList`	`retrieveAllRoles()` 読み取りモードをチェックしないで、関係に含まれるすべてのロールを返します。
`void`	`setRole(Role theRole)` 指定されたロールを設定します。
`RoleResult`	`setRoles(RoleList theRoleList)` 指定されたロールを設定します。

メソッドの詳細

getRole

List getRole(String theRoleName)
             throws IllegalArgumentException,
                    RoleNotFoundException,
                    RelationServiceNotRegisteredException

指定されたロール名のロール値を取得します。

ロールが存在し、関係型に従って読み取り可能かどうかをチェックします。

パラメータ:

theRoleName - ロール名

戻り値:

ロール値となる ObjectName オブジェクトの ArrayList

例外:

IllegalArgumentException - ロール名が null の場合

RoleNotFoundException - 次の条件が成立する場合:

- 指定された名前のロールが存在しない場合

- ロールが読み取り不可な場合

RelationServiceNotRegisteredException - 関係サービスが MBean Server に登録されていない場合

getRoles

RoleResult getRoles(String[] theRoleNameArray)
                    throws IllegalArgumentException,
                           RelationServiceNotRegisteredException

指定された名前のロールの値を取得します。

各ロールが存在し、関係型に従って読み取り可能かどうかをチェックします。

パラメータ:: theRoleNameArray - 取得されるロールの名前から成る配列
戻り値:: RoleResult オブジェクト。取得に成功したロールの RoleList と取得されなかったロールの RoleUnresolvedList を含む
例外:: IllegalArgumentException - ロール名が null の場合; RelationServiceNotRegisteredException - 関係サービスが MBean Server に登録されていない場合
関連項目:: setRoles(javax.management.relation.RoleList)

getRoleCardinality

Integer getRoleCardinality(String theRoleName)
                           throws IllegalArgumentException,
                                  RoleNotFoundException

指定されたロール内で現在参照されている MBean の数を返します。

パラメータ:: theRoleName - ロール名
戻り値:: ロール内の現在参照されている MBean の数
例外:: IllegalArgumentException - ロール名が null の場合; RoleNotFoundException - 指定された名前のロールが存在しない場合

getAllRoles

RoleResult getAllRoles()
                       throws RelationServiceNotRegisteredException

関係に含まれるすべてのロールを返します。

戻り値:: RoleResult オブジェクト。取得に成功したロールの RoleList と読み取れなかったロールの RoleUnresolvedList を含む
例外:: RelationServiceNotRegisteredException - 関係サービスが MBean Server に登録されていない場合

retrieveAllRoles

RoleList retrieveAllRoles()

読み取りモードをチェックしないで、関係に含まれるすべてのロールを返します。

戻り値:: RoleList

setRole

void setRole(Role theRole)
             throws IllegalArgumentException,
                    RoleNotFoundException,
                    RelationTypeNotFoundException,
                    InvalidRoleValueException,
                    RelationServiceNotRegisteredException,
                    RelationNotFoundException

指定されたロールを設定します。

関係の関係型に含まれている対応するロール定義に従って、ロールをチェックします。

通知を送信します。関係が MBean であるかどうかによって、RelationNotification の型は RELATION_BASIC_UPDATE または RELATION_MBEAN_UPDATE になります。

パラメータ:

theRole - 設定されるロール (名前と新しい値)

例外:

IllegalArgumentException - ロールが null の場合

RoleNotFoundException - ロールが書き込み可能でない場合 (ロールの初期化時には、書き込みアクセスモードのチェックは行われない)

InvalidRoleValueException - ロールに対して提供された値が無効な場合:

- 指定された値に含まれる参照対象の MBean の数が予想最小値より小さい場合

- 指定された値に含まれる参照対象の MBean の数が予想最大値を超えている場合

- 値に含まれる参照対象の MBean のうち 1 つが、そのロールの MBean クラスのオブジェクトでない場合

- そのロールの MBean が存在しない場合

RelationServiceNotRegisteredException - 関係サービスが MBean Server に登録されていない場合

RelationTypeNotFoundException - 関係サービスに関係型が宣言されていない場合

RelationNotFoundException - 関係サービスに関係が追加されていない場合

関連項目:

getRole(java.lang.String)

setRoles

RoleResult setRoles(RoleList theRoleList)
                    throws IllegalArgumentException,
                           RelationServiceNotRegisteredException,
                           RelationTypeNotFoundException,
                           RelationNotFoundException

指定されたロールを設定します。

関係の関係型に含まれている対応するロール定義に従って、ロールをチェックします。

ロールが更新されるたびに通知を送信します。関係が MBean であるかどうかによって、RelationNotification の型は RELATION_BASIC_UPDATE または RELATION_MBEAN_UPDATE になります。

パラメータ:: theRoleList - 設定されるロールのリスト
戻り値:: RoleResult オブジェクト。設定に成功したロールの RoleList と設定されなかったロールの RoleUnresolvedList を含む
例外:: IllegalArgumentException - ロール名が null の場合; RelationServiceNotRegisteredException - 関係サービスが MBean Server に登録されていない場合; RelationTypeNotFoundException - 関係サービスに関係型が宣言されていない場合; RelationNotFoundException - 関係サービスに関係 MBean が追加されていない場合
関連項目:: getRoles(java.lang.String[])

handleMBeanUnregistration

void handleMBeanUnregistration(ObjectName theObjName,
                               String theRoleName)
                               throws IllegalArgumentException,
                                      RoleNotFoundException,
                                      InvalidRoleValueException,
                                      RelationServiceNotRegisteredException,
                                      RelationTypeNotFoundException,
                                      RelationNotFoundException

ロールに含まれる参照対象の MBean の登録が解除された場合に関係サービスによって使用されるコールバックです。

関係サービスは、このメソッドを呼び出して、関係に、登録解除の影響を反映するためのアクションを取らせます。

このメソッドは、ユーザからは呼び出されません。

現在の実装は、現在の値 (参照対象の MBean の ObjectName のリスト) を使ってロールを設定します。登録解除されているものは使用しません。

パラメータ:: theObjName - 登録解除された MBean の ObjectName; theRoleName - MBean の参照に使用されるロール名
例外:: IllegalArgumentException - パラメータが null の場合; RoleNotFoundException - 関係内にロールが存在しないか、書き込み不可である場合; InvalidRoleValueException - ロールがロール情報に準拠していない場合 (関係サービスから呼び出された場合は起こり得ない条件); RelationServiceNotRegisteredException - 関係サービスが MBean Server に登録されていない場合; RelationTypeNotFoundException - 関係サービスに関係型が宣言されていない場合; RelationNotFoundException - このメソッドが、関係サービスに追加されていない関係 MBean に対して呼び出された場合