RelationServiceMBean (Java Platform SE 6)

メソッドの概要
`void`	`addRelation(ObjectName relationObjectName)` ユーザーによって作成され、MBean Server に登録される MBean を、関係として関係サービスに追加します。
`void`	`addRelationType(RelationType relationTypeObj)` 指定されたオブジェクトを関係型として追加します。
`Integer`	`checkRoleReading(String roleName, String relationTypeName)` 指定された型の関係で、指定された Role の読み取りが可能かどうかをチェックします。
`Integer`	`checkRoleWriting(Role role, String relationTypeName, Boolean initFlag)` 指定された型の関係で、指定された Role の設定が可能かどうかをチェックします。
`void`	`createRelation(String relationId, String relationTypeName, RoleList roleList)` 指定された関係型の単純な関係 (RelationSupport オブジェクト) を作成し、これを関係サービスに追加します。
`void`	`createRelationType(String relationTypeName, RoleInfo[] roleInfoArray)` RoleInfo オブジェクトから提供されたロール情報を使って、関係型 (RelationTypeSupport オブジェクト) を作成し、関係サービスへ追加します。
`Map<ObjectName,List<String>>`	`findAssociatedMBeans(ObjectName mbeanName, String relationTypeName, String roleName)` 関係内の指定された MBean に関連付けられた MBean を取得します。
`Map<String,List<String>>`	`findReferencingRelations(ObjectName mbeanName, String relationTypeName, String roleName)` 指定された MBean が参照される関係を取得します。
`List<String>`	`findRelationsOfType(String relationTypeName)` 指定された型の関係の関係 ID を返します。
`List<String>`	`getAllRelationIds()` 関係サービスによって処理されるすべての関係のすべての関係 ID を返します。
`List<String>`	`getAllRelationTypeNames()` 既知のすべての関係型の名前を取得します。
`RoleResult`	`getAllRoles(String relationId)` 関係に含まれるすべてのロールを返します。
`boolean`	`getPurgeFlag()` 関係内の参照対象の MBean の登録解除の通知をいつ受信したか、関係をただちに「パージ」 (有効でなくなった関係を検索) する必要があるかどうか、または purgeRelations メソッドが明示的に呼び出される場合にのみパージが実行されるかどうかを示すフラグを返します。
`Map<ObjectName,List<String>>`	`getReferencedMBeans(String relationId)` 関係のさまざまなロールで参照される MBean を取得します。
`String`	`getRelationTypeName(String relationId)` 指定された関係の関係型の名前を返します。
`List<ObjectName>`	`getRole(String relationId, String roleName)` 指定された関係に含まれる指定されたロール名のロール値を取得します。
`Integer`	`getRoleCardinality(String relationId, String roleName)` 指定されたロール内で現在参照されている MBean の数を取得します。
`RoleInfo`	`getRoleInfo(String relationTypeName, String roleInfoName)` 指定された関係型の指定されたロールの情報を取得します。
`List<RoleInfo>`	`getRoleInfos(String relationTypeName)` 指定された関係型のロール情報 (RoleInfo オブジェクト) のリストを取得します。
`RoleResult`	`getRoles(String relationId, String[] roleNameArray)` 指定された関係に含まれる指定された名前のロールの値を取得します。
`Boolean`	`hasRelation(String relationId)` 関係サービス内に指定された関係 ID で識別される関係があるかどうかをチェックします。
`void`	`isActive()` 関係サービスがアクティブかどうかをチェックします。
`String`	`isRelation(ObjectName objectName)` MBean が関係として関係サービスに追加されている場合、指定された ObjectName に関連付けられる関係 ID を返します。
`ObjectName`	`isRelationMBean(String relationId)` ユーザーによって作成され、関係として関係サービスに追加された MBean が関係を表す場合、この MBean の ObjectName を返します。
`void`	`purgeRelations()` 関係をパージします。
`void`	`removeRelation(String relationId)` 指定された関係型を関係サービスから削除します。
`void`	`removeRelationType(String relationTypeName)` 指定された関係型を関係サービスから削除します。
`void`	`sendRelationCreationNotification(String relationId)` 関係作成の通知 (RelationNotification) を送信します。
`void`	`sendRelationRemovalNotification(String relationId, List<ObjectName> unregMBeanList)` 関係削除の通知 (RelationNotification) を送信します。
`void`	`sendRoleUpdateNotification(String relationId, Role newRole, List<ObjectName> oldRoleValue)` 指定された関係内のロール更新の通知 (RelationNotification) を送信します。
`void`	`setPurgeFlag(boolean purgeFlag)` 関係内の参照対象の MBean の登録解除の通知をいつ受信したか、関係をただちに「パージ」 (有効でなくなった関係を検索) する必要があるかどうか、または purgeRelations メソッドが明示的に呼び出される場合にのみパージが実行されるかどうかを示すフラグを設定します。
`void`	`setRole(String relationId, Role role)` 指定された関係内の指定されたロールを設定します。
`RoleResult`	`setRoles(String relationId, RoleList roleList)` 指定された関係内の指定されたロールを設定します。
`void`	`updateRoleMap(String relationId, Role newRole, List<ObjectName> oldRoleValue)` 指定された関係内の指定されたロールを更新するため、関係サービスロールマップの更新を処理します。

メソッドの詳細

isActive

void isActive()
              throws RelationServiceNotRegisteredException

関係サービスがアクティブかどうかをチェックします。現在、関係サービスを MBean Server に登録する必要があります。

例外:: RelationServiceNotRegisteredException - 関係サービスが未登録の場合

getPurgeFlag

boolean getPurgeFlag()

関係内の参照対象の MBean の登録解除の通知をいつ受信したか、関係をただちに「パージ」 (有効でなくなった関係を検索) する必要があるかどうか、または purgeRelations メソッドが明示的に呼び出される場合にのみパージが実行されるかどうかを示すフラグを返します。

true の場合、ただちにパージを行う必要があります。

戻り値:: ただちにパージを行う必要がある場合は true
関連項目:: setPurgeFlag(boolean)

setPurgeFlag

void setPurgeFlag(boolean purgeFlag)

関係内の参照対象の MBean の登録解除の通知をいつ受信したか、関係をただちに「パージ」 (有効でなくなった関係を検索) する必要があるかどうか、または purgeRelations メソッドが明示的に呼び出される場合にのみパージが実行されるかどうかを示すフラグを設定します。

true の場合、ただちにパージを行う必要があります。

パラメータ:: purgeFlag - flag
関連項目:: getPurgeFlag()

createRelationType

void createRelationType(String relationTypeName,
                        RoleInfo[] roleInfoArray)
                        throws IllegalArgumentException,
                               InvalidRelationTypeException

RoleInfo オブジェクトから提供されたロール情報を使って、関係型 (RelationTypeSupport オブジェクト) を作成し、関係サービスへ追加します。

パラメータ:

relationTypeName - 関係型の名前

roleInfoArray - ロール情報の配列

例外:

IllegalArgumentException - パラメータが null の場合

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

- 同じ名前の関係型がすでに存在する場合

- 同じ名前が 2 つの異なったロール情報で使用されている場合

- ロール情報が提供されなかった場合

- ロール情報として null が提供された場合

addRelationType

void addRelationType(RelationType relationTypeObj)
                     throws IllegalArgumentException,
                            InvalidRelationTypeException

指定されたオブジェクトを関係型として追加します。このオブジェクトは、RelationType インタフェースを実装する必要があります。

パラメータ:: relationTypeObj - 関係型オブジェクト (RelationType インタフェースを実装)
例外:: IllegalArgumentException - パラメータが null である場合、または relationTypeObj.getRelationTypeName() が null を返す場合; InvalidRelationTypeException - 同じ名前の関係型がすでに存在する場合

getAllRelationTypeNames

List<String> getAllRelationTypeNames()

既知のすべての関係型の名前を取得します。

戻り値:: 関係型の名前 (String) の ArrayList

getRoleInfos

List<RoleInfo> getRoleInfos(String relationTypeName)
                            throws IllegalArgumentException,
                                   RelationTypeNotFoundException

指定された関係型のロール情報 (RoleInfo オブジェクト) のリストを取得します。

パラメータ:: relationTypeName - 関係型の名前
戻り値:: RoleInfo の ArrayList
例外:: IllegalArgumentException - パラメータが null の場合; RelationTypeNotFoundException - その名前の関係型が存在しない場合

getRoleInfo

RoleInfo getRoleInfo(String relationTypeName,
                     String roleInfoName)
                     throws IllegalArgumentException,
                            RelationTypeNotFoundException,
                            RoleInfoNotFoundException

指定された関係型の指定されたロールの情報を取得します。

パラメータ:: relationTypeName - 関係型の名前; roleInfoName - ロール名
戻り値:: RoleInfo オブジェクト
例外:: IllegalArgumentException - パラメータが null の場合; RelationTypeNotFoundException - 関係サービスにとって未知の関係型である場合; RoleInfoNotFoundException - 関係型にロールが含まれていない場合

removeRelationType

void removeRelationType(String relationTypeName)
                        throws RelationServiceNotRegisteredException,
                               IllegalArgumentException,
                               RelationTypeNotFoundException

指定された関係型を関係サービスから削除します。

その型の関係オブジェクトが関係サービスから削除されます。

パラメータ:: relationTypeName - 削除される関係型の名前
例外:: RelationServiceNotRegisteredException - 関係サービスが MBean サーバーに登録されていない場合; IllegalArgumentException - パラメータが null の場合; RelationTypeNotFoundException - その名前の関係型が存在しない場合

createRelation

void createRelation(String relationId,
                    String relationTypeName,
                    RoleList roleList)
                    throws RelationServiceNotRegisteredException,
                           IllegalArgumentException,
                           RoleNotFoundException,
                           InvalidRelationIdException,
                           RelationTypeNotFoundException,
                           InvalidRoleValueException

指定された関係型の単純な関係 (RelationSupport オブジェクト) を作成し、これを関係サービスに追加します。

ロールはパラメータに指定されたロールリストに従って初期化されます。この方法で初期化されないロールは、ObjectName の空の ArrayList に設定されます。

RELATION_BASIC_CREATION 型の RelationNotification が送信されます。

パラメータ:

relationId - 関係サービス内の関係を一意に識別するために使用される関係識別子

relationTypeName - 関係サービス内に作成する必要がある関係型の名前

roleList - 関係のロールを初期化するためのロールリスト (null も可)

例外:

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

IllegalArgumentException - パラメータが null の場合

RoleNotFoundException - 関係型内に存在しないロールに値が提供された場合

InvalidRelationIdException - 関係 ID がすでに使用されている場合

RelationTypeNotFoundException - 関係サービスにとって未知の関係型である場合

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

- 同じ名前が 2 つの異なったロールで使用されている場合

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

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

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

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

addRelation

void addRelation(ObjectName relationObjectName)
                 throws IllegalArgumentException,
                        RelationServiceNotRegisteredException,
                        NoSuchMethodException,
                        InvalidRelationIdException,
                        InstanceNotFoundException,
                        InvalidRelationServiceException,
                        RelationTypeNotFoundException,
                        RoleNotFoundException,
                        InvalidRoleValueException

ユーザーによって作成され、MBean Server に登録される MBean を、関係として関係サービスに追加します。

MBean を関係として追加するためには、次の条件が満たされている必要があります。

- MBean が Relation インタフェースを実装している

- MBean が RelationService ObjectName 用として現在の関係サービスの ObjectName を持っている

- MBean が現在の関係サービス内で一意かつ未使用の関係 ID を持っている

- MBean が関係型用として関係サービス内で作成された関係型を持っている

- MBean が関係型内で提供されたロール情報に適合するロールを持っている

パラメータ:

relationObjectName - 追加される関係 MBean の ObjectName

例外:

IllegalArgumentException - パラメータが null の場合

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

NoSuchMethodException - MBean が Relation インタフェースを実装していない場合

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

- MBean 内に関係識別子が存在しない

- 関係識別子が関係サービスですでに使用されている場合

InstanceNotFoundException - 指定された ObjectName の MBean が登録されていない場合

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

- MBean 内に関係サービス名が存在しない場合

- MBean 内の関係サービス名が現在の関係サービスの関係サービス名でない場合

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

- MBean 内に関係型名が存在しない場合

- MBean 内の関係型名が関係サービス内に作成された関係型に対応していない場合

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

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

- ロールに含まれる参照対象の MBean の数が予想最大値を超えている場合

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

- ロールに提供された MBean が存在しない場合

RoleNotFoundException - 関係型内に存在しないロールに値が提供された場合

isRelationMBean

ObjectName isRelationMBean(String relationId)
                           throws IllegalArgumentException,
                                  RelationNotFoundException

ユーザーによって作成され、関係として関係サービスに追加された MBean が関係を表す場合、この MBean の ObjectName を返します。

パラメータ:: relationId - 関係を識別する関係 ID
戻り値:: 対応する関係 MBean の ObjectName。関係が MBean でない場合は null
例外:: IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - この ID に関係が関連付けられていない場合

isRelation

String isRelation(ObjectName objectName)
                  throws IllegalArgumentException

MBean が関係として関係サービスに追加されている場合、指定された ObjectName に関連付けられる関係 ID を返します。

パラメータ:: objectName - 仮定された関係の ObjectName
戻り値:: 関係 ID (String)。 ObjectName が関係サービスによって処理される関係でない場合は null
例外:: IllegalArgumentException - パラメータが null の場合

hasRelation

Boolean hasRelation(String relationId)
                    throws IllegalArgumentException

関係サービス内に指定された関係 ID で識別される関係があるかどうかをチェックします。

パラメータ:: relationId - 関係を識別する関係 ID
戻り値:: boolean 型。関係が存在する場合は true、存在しない場合は false
例外:: IllegalArgumentException - パラメータが null の場合

getAllRelationIds

List<String> getAllRelationIds()

関係サービスによって処理されるすべての関係のすべての関係 ID を返します。

戻り値:: String の ArrayList

checkRoleReading

Integer checkRoleReading(String roleName,
                         String relationTypeName)
                         throws IllegalArgumentException,
                                RelationTypeNotFoundException

指定された型の関係で、指定された Role の読み取りが可能かどうかをチェックします。

パラメータ:

roleName - チェックされるロールの名前

relationTypeName - 関係型の名前

戻り値:

発生の可能性がある問題に対応する整数型 (RoleUnresolved 内の定数で表される) をラップする Integer

- ロールの読み取りが可能な場合は 0

- RoleStatus.NO_ROLE_WITH_NAME に対応する整数型

- RoleStatus.ROLE_NOT_READABLE に対応する整数型

例外:

IllegalArgumentException - パラメータが null の場合

RelationTypeNotFoundException - 関係サービスにとって未知の関係型である場合

checkRoleWriting

Integer checkRoleWriting(Role role,
                         String relationTypeName,
                         Boolean initFlag)
                         throws IllegalArgumentException,
                                RelationTypeNotFoundException

指定された型の関係で、指定された Role の設定が可能かどうかをチェックします。

パラメータ:

role - チェックされるロール

relationTypeName - 関係型の名前

initFlag - ロールの初期化のためにチェックが行われたことを示すフラグ。書き込みアクセスの検証は行われない

戻り値:

発生の可能性がある問題に対応する整数型 (RoleUnresolved 内の定数で表される) をラップする Integer

- ロールの設定が可能な場合は 0

- RoleStatus.NO_ROLE_WITH_NAME に対応する整数型

- RoleStatus.ROLE_NOT_WRITABLE の整数型

- RoleStatus.LESS_THAN_MIN_ROLE_DEGREE の整数型

- RoleStatus.MORE_THAN_MAX_ROLE_DEGREE の整数型

- RoleStatus.REF_MBEAN_OF_INCORRECT_CLASS の整数型

- RoleStatus.REF_MBEAN_NOT_REGISTERED の整数型

例外:

IllegalArgumentException - パラメータが null の場合

RelationTypeNotFoundException - 未知の関係型の場合

sendRelationCreationNotification

void sendRelationCreationNotification(String relationId)
                                      throws IllegalArgumentException,
                                             RelationNotFoundException

関係作成の通知 (RelationNotification) を送信します。通知型は次のとおりです。

- RelationNotification.RELATION_BASIC_CREATION。関係が関係サービスの内部オブジェクトである場合

- RelationNotification.RELATION_MBEAN_CREATION。関係が関係として追加された MBean である場合

ソースオブジェクトは関係サービス自体です。

関係サービスの createRelation() メソッドおよび addRelation() メソッドで呼び出されます。

パラメータ:: relationId - 更新された関係の関係識別子
例外:: IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - 指定された関係 ID の関係が存在しない場合

sendRoleUpdateNotification

void sendRoleUpdateNotification(String relationId,
                                Role newRole,
                                List<ObjectName> oldRoleValue)
                                throws IllegalArgumentException,
                                       RelationNotFoundException

指定された関係内のロール更新の通知 (RelationNotification) を送信します。通知型は次のとおりです。

- RelationNotification.RELATION_BASIC_UPDATE。関係が関係サービスの内部オブジェクトである場合

- RelationNotification.RELATION_MBEAN_UPDATE。関係が関係として追加された MBean である場合

ソースオブジェクトは関係サービス自体です。

関係 MBean の setRole() メソッド (指定されたロール用) および setRoles() メソッド (各ロール用) で呼び出されます。この実装は RelationSupport クラスで提供されます。

関係サービスの setRole() メソッド (指定されたロール用) および setRoles() メソッド (各ロール用) でも呼び出せます。

パラメータ:: relationId - 更新された関係の関係識別子; newRole - 新しいロール (名前と新しい値); oldRoleValue - 古いロール値 (ObjectName オブジェクトの List)
例外:: IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - 指定された関係 ID の関係が存在しない場合

sendRelationRemovalNotification

void sendRelationRemovalNotification(String relationId,
                                     List<ObjectName> unregMBeanList)
                                     throws IllegalArgumentException,
                                            RelationNotFoundException

関係削除の通知 (RelationNotification) を送信します。通知型は次のとおりです。

- RelationNotification.RELATION_BASIC_REMOVAL。関係が関係サービスの内部オブジェクトである場合

- RelationNotification.RELATION_MBEAN_REMOVAL。関係が関係として追加された MBean である場合

ソースオブジェクトは関係サービス自体です。

関係サービスの removeRelation() メソッドで呼び出されます。

パラメータ:: relationId - 更新された関係の関係識別子; unregMBeanList - 関係の削除の結果、登録解除される MBean の ObjectName のリスト (null も可)
例外:: IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - 指定された関係 ID の関係が存在しない場合

updateRoleMap

void updateRoleMap(String relationId,
                   Role newRole,
                   List<ObjectName> oldRoleValue)
                   throws IllegalArgumentException,
                          RelationServiceNotRegisteredException,
                          RelationNotFoundException

指定された関係内の指定されたロールを更新するため、関係サービスロールマップの更新を処理します。

関係サービスの setRole() メソッド (指定されたロール用) および setRoles() メソッド (各ロール用) でも呼び出せます。

関係サービスが MBean の登録解除時も整合性を確保し、クエリーを実行できるようにするには、ロールの更新時にこのメソッドを呼び出す必要があります。

パラメータ:: relationId - 更新された関係の関係識別子; newRole - 新しいロール (名前と新しい値); oldRoleValue - 古いロール値 (ObjectName オブジェクトの List)
例外:: IllegalArgumentException - パラメータが null の場合; RelationServiceNotRegisteredException - 関係サービスが MBean サーバーに登録されていない場合; RelationNotFoundException - 指定された ID に対応する関係が存在しない場合

removeRelation

void removeRelation(String relationId)
                    throws RelationServiceNotRegisteredException,
                           IllegalArgumentException,
                           RelationNotFoundException

指定された関係型を関係サービスから削除します。

RelationNotification 通知が送信されます。その型は次のとおりです。

- RelationNotification.RELATION_BASIC_REMOVAL。関係サービス内専用の関係である場合

- RelationNotification.RELATION_MBEAN_REMOVAL。関係が MBean として登録されている場合

こうした関係で参照される MBean の場合、何も行われません。

パラメータ:: relationId - 削除される関係の関係 ID
例外:: RelationServiceNotRegisteredException - 関係サービスが MBean サーバーに登録されていない場合; IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - 指定された関係 ID に対応する関係が存在しない場合

purgeRelations

void purgeRelations()
                    throws RelationServiceNotRegisteredException

関係をパージします。

このメソッドは、purgeFlag 値に依存します。フラグが true に設定されている場合は、関係内の参照対象の MBean の登録解除を知らせる通知を受信したとき自動的に呼び出されます。フラグが false に設定されている場合は呼び出されません。

フラグが false に設定されている場合、関係の整合性を確保するためにこのメソッドを呼び出すかどうかはユーザーが決定します。MBean の登録が解除されたあとただちにパージが行われない場合、ObjectName が再利用され、関係内の参照対象の別の MBean に割り当てられるときにこの purgeRelations() メソッドを手動で呼び出すと、問題が発生します。これは、新しい MBean が認識されず、ObjectName が登録解除された MBean に対応すると見なされるからです。

動作は、登録解除された MBean が参照されるロールのカーディナリティーによって決定されます。

- ロール内の MBean 参照を 1 つ削除したとき参照の数が最小値より少なくなる場合は、関係を削除する必要がある

- MBean 参照を削除したあと残った参照の数がカーディナリティー範囲内である場合は、関係を保持し、handleMBeanUnregistration() コールバックを呼び出して更新する

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

findReferencingRelations

Map<String,List<String>> findReferencingRelations(ObjectName mbeanName,
                                                  String relationTypeName,
                                                  String roleName)
                                                  throws IllegalArgumentException

指定された MBean が参照される関係を取得します。

これは、CIM の「Reference」および「ReferenceName」オペレーションに対応します。

パラメータ:: mbeanName - MBean の ObjectName; relationTypeName - null も可。指定した場合、検索ではその型の関係だけが考慮される。それ以外の場合、すべての関係型が考慮される; roleName - null も可。指定した場合、そのロール内の MBean が参照される関係だけが返される。それ以外の場合、すべてのロールが考慮される
戻り値:: HashMap。キーは、MBean が参照される関係の関係 ID。各キーの値はロール名の ArrayList (MBean は同じ関係の複数のロール内で参照可能)
例外:: IllegalArgumentException - パラメータが null の場合

findAssociatedMBeans

Map<ObjectName,List<String>> findAssociatedMBeans(ObjectName mbeanName,
                                                  String relationTypeName,
                                                  String roleName)
                                                  throws IllegalArgumentException

関係内の指定された MBean に関連付けられた MBean を取得します。

これは、CIM の Associator および AssociatorName オペレーションに対応します。

パラメータ:: mbeanName - MBean の ObjectName; relationTypeName - null も可。指定した場合、検索ではその型の関係だけが考慮される。それ以外の場合、すべての関係型が考慮される; roleName - null も可。指定した場合、そのロール内の MBean が参照される関係だけが考慮される。それ以外の場合、すべてのロールが考慮される
戻り値:: HashMap。キーは指定された MBean に関連付けられた MBean の ObjectName。各キーの値は、キー MBean が指定された MBean に関連付けられている関係の関係 ID から成る ArrayList (これらは複数の異なった関係に関連付け可能)
例外:: IllegalArgumentException - パラメータが null の場合

findRelationsOfType

List<String> findRelationsOfType(String relationTypeName)
                                 throws IllegalArgumentException,
                                        RelationTypeNotFoundException

指定された型の関係の関係 ID を返します。

パラメータ:: relationTypeName - 関係型名
戻り値:: 関係 ID の ArrayList
例外:: IllegalArgumentException - パラメータが null の場合; RelationTypeNotFoundException - その名前の関係型が存在しない場合

getRole

List<ObjectName> getRole(String relationId,
                         String roleName)
                         throws RelationServiceNotRegisteredException,
                                IllegalArgumentException,
                                RelationNotFoundException,
                                RoleNotFoundException

指定された関係に含まれる指定されたロール名のロール値を取得します。

パラメータ:

relationId - 関係 ID

roleName - ロール名

戻り値:

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

例外:

RelationServiceNotRegisteredException - 関係サービスが未登録の場合

IllegalArgumentException - パラメータが null の場合

RelationNotFoundException - 指定された ID に対応する関係が存在しない場合

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

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

または

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

getRoles

RoleResult getRoles(String relationId,
                    String[] roleNameArray)
                    throws RelationServiceNotRegisteredException,
                           IllegalArgumentException,
                           RelationNotFoundException

指定された関係に含まれる指定された名前のロールの値を取得します。

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

getAllRoles

RoleResult getAllRoles(String relationId)
                       throws IllegalArgumentException,
                              RelationNotFoundException,
                              RelationServiceNotRegisteredException

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

パラメータ:: relationId - 関係 ID
戻り値:: RoleResult オブジェクト。取得に成功したロールの RoleList と読み取れなかったロールの RoleUnresolvedList を含む
例外:: IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - 指定された ID に対応する関係が存在しない場合; RelationServiceNotRegisteredException - 関係サービスが MBean サーバーに登録されていない場合

getRoleCardinality

Integer getRoleCardinality(String relationId,
                           String roleName)
                           throws IllegalArgumentException,
                                  RelationNotFoundException,
                                  RoleNotFoundException

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

パラメータ:: relationId - 関係 ID; roleName - ロール名
戻り値:: ロール内の現在参照されている MBean の数
例外:: IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - 指定された ID に対応する関係が存在しない場合; RoleNotFoundException - 指定された名前のロールが存在しない場合

setRole

void setRole(String relationId,
             Role role)
             throws RelationServiceNotRegisteredException,
                    IllegalArgumentException,
                    RelationNotFoundException,
                    RoleNotFoundException,
                    InvalidRoleValueException,
                    RelationTypeNotFoundException

指定された関係内の指定されたロールを設定します。

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

関係サービスは、関係の整合性を確保するため、参照対象の MBean の登録解除を処理することにより、変更を追跡します。

パラメータ:

relationId - 関係 ID

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

例外:

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

IllegalArgumentException - パラメータが null の場合

RelationNotFoundException - 指定された ID に対応する関係が存在しない場合

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

- 内部関係

および

- ロールが存在しないか、書き込み不可

InvalidRoleValueException - ロールに対して提供された内部関係および値が無効な場合:

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

または

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

または

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

または

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

RelationTypeNotFoundException - 未知の関係型の場合

setRoles

RoleResult setRoles(String relationId,
                    RoleList roleList)
                    throws RelationServiceNotRegisteredException,
                           IllegalArgumentException,
                           RelationNotFoundException

指定された関係内の指定されたロールを設定します。

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

関係サービスは、関係の整合性を確保するため、参照対象の MBean の登録解除を処理することにより、変更を追跡します。

パラメータ:: relationId - 関係 ID; roleList - 設定されるロールのリスト
戻り値:: RoleResult オブジェクト。設定に成功したロールの RoleList と設定されなかったロールの RoleUnresolvedList を含む
例外:: RelationServiceNotRegisteredException - 関係サービスが MBean サーバーに登録されていない場合; IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - 指定された ID に対応する関係が存在しない場合
関連項目:: getRoles(java.lang.String, java.lang.String[])

getReferencedMBeans

Map<ObjectName,List<String>> getReferencedMBeans(String relationId)
                                                 throws IllegalArgumentException,
                                                        RelationNotFoundException

関係のさまざまなロールで参照される MBean を取得します。

パラメータ:: relationId - 関係 ID
戻り値:: HashMap マッピング:
ObjectName → String (ロール名) から成る ArrayList
例外:: IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - 指定された関係 ID に対応する関係が存在しない場合

getRelationTypeName

String getRelationTypeName(String relationId)
                           throws IllegalArgumentException,
                                  RelationNotFoundException

指定された関係の関係型の名前を返します。

パラメータ:: relationId - 関係 ID
戻り値:: 関連付けられた関係型の名前
例外:: IllegalArgumentException - パラメータが null の場合; RelationNotFoundException - 指定された関係 ID に対応する関係が存在しない場合