javax.management.relation
クラス RoleInfo

java.lang.Object
  javax.management.relation.RoleInfo

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

Serializable

public class RoleInfo
extends Object
implements Serializable

RoleInfo オブジェクトは、関係型に含まれるロールを集計します。

このクラスの serialVersionUID は 2504952983494636987L です。

導入されたバージョン:

1.5

関連項目:

直列化された形式

フィールドの概要

static int

ROLE_CARDINALITY_INFINITY 無制限のカーディナリティーを指定するためです。

コンストラクタの概要

RoleInfo(RoleInfo roleInfo)
コンストラクタをコピーします。

RoleInfo(String roleName, String mbeanClassName)
コンストラクタです。

RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write)
コンストラクタです。

RoleInfo(String roleName, String mbeanClassName, boolean read, boolean write, int min, int max, String descr)
コンストラクタです。

メソッドの概要

boolean	checkMaxDegree(int value) value パラメータが最大値以下の場合は true、そうでない場合は false を返します。
boolean	checkMinDegree(int value) value パラメータが最小値以上の場合は true、そうでない場合は false を返します。
String	getDescription() ロールの説明テキストを返します。
int	getMaxDegree() 対応するロール参照の最大値を返します。
int	getMinDegree() 対応するロール参照の最小値を返します。
String	getName() ロール名を返します。
String	getRefMBeanClassName() 対応するロール内で参照される MBean (複数可) の型名を返します。
boolean	isReadable() ロールの読み取りアクセスモードを返します (読み取り可能な場合は true)。
boolean	isWritable() ロールの書き込みアクセスモードを返します (書き込み可能な場合は true)。
String	toString() ロール情報について説明する文字列を返します。

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

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

フィールドの詳細

ROLE_CARDINALITY_INFINITY

public static final int ROLE_CARDINALITY_INFINITY

無制限のカーディナリティーを指定するためです。

関連項目:

定数フィールド値

コンストラクタの詳細

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName,
                boolean read,
                boolean write,
                int min,
                int max,
                String descr)
         throws IllegalArgumentException,
                InvalidRoleInfoException,
                ClassNotFoundException,
                NotCompliantMBeanException

コンストラクタです。

パラメータ:

roleName - ロール名

mbeanClassName - 対応するロール内で参照される MBean (複数可) のクラス名。MBean M がこのロールに含まれる場合、 MBean サーバーは isInstanceOf(M, mbeanClassName) に対して true を返す必要がある

read - 対応するロールが読み取り可能かどうかを 示すフラグ

write - 対応するロールが設定可能かどうかを 示すフラグ

min - ロールの最小値 (対応するロールに含まれる MBean の最大数)。max 以下でなければならない。数を制限しない場合、ROLE_CARDINALITY_INFINITY

max - ロールの最大値 (対応するロールに 含まれる MBean の最大数)。 min 以上でなければならない。 数を制限しない場合、ROLE_CARDINALITY_INFINITY

descr - ロールの説明 (null も可)

例外:

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

InvalidRoleInfoException - 最小値が最大値より 大きい場合

ClassNotFoundException - JMX 1.2 以降、 この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、 このクラスの宣言に引き続き含まれている

NotCompliantMBeanException - mbeanClassName クラスが MBean クラスでない場合

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName,
                boolean read,
                boolean write)
         throws IllegalArgumentException,
                ClassNotFoundException,
                NotCompliantMBeanException

コンストラクタです。

パラメータ:

roleName - ロール名

mbeanClassName - 対応するロール内で参照される MBean (複数可) のクラス名。MBean M がこのロールに含まれる場合、 MBean サーバーは isInstanceOf(M, mbeanClassName) に対して true を返す必要がある

read - 対応するロールが読み取り可能かどうかを 示すフラグ

write - 対応するロールが設定可能かどうかを 示すフラグ

最小値と最大値のデフォルト値は 1 です。

ロールの説明のデフォルト値は null です。

例外:

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

ClassNotFoundException - JMX 1.2 以降、 この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、 このクラスの宣言に引き続き含まれている

NotCompliantMBeanException - JMX 1.2 以降、 この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、 このクラスの宣言に引き続き含まれている

RoleInfo

public RoleInfo(String roleName,
                String mbeanClassName)
         throws IllegalArgumentException,
                ClassNotFoundException,
                NotCompliantMBeanException

コンストラクタです。

パラメータ:

roleName - ロール名

mbeanClassName - 対応するロール内で参照される MBean (複数可) のクラス名。MBean M がこのロールに含まれる場合、 MBean サーバーは isInstanceOf(M, mbeanClassName) に対して true を返す必要がある

IsReadable と IsWritable のデフォルト値は true です。

最小値と最大値のデフォルト値は 1 です。

ロールの説明のデフォルト値は null です。

例外:

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

ClassNotFoundException - JMX 1.2 以降、 この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、 このクラスの宣言に引き続き含まれている

NotCompliantMBeanException - JMX 1.2 以降、 この例外はスローされなくなる。この例外は、既存のコードとの互換性を確保するため、 このクラスの宣言に引き続き含まれている

RoleInfo

public RoleInfo(RoleInfo roleInfo)
         throws IllegalArgumentException

コンストラクタをコピーします。

パラメータ:

roleInfo - コピーされる RoleInfo インスタンス

例外:

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

メソッドの詳細

getName

public String getName()

ロール名を返します。

戻り値:

ロール名

isReadable

public boolean isReadable()

ロールの読み取りアクセスモードを返します (読み取り可能な場合は true)。

戻り値:

ロールが読み取り可能な場合は true

isWritable

public boolean isWritable()

ロールの書き込みアクセスモードを返します (書き込み可能な場合は true)。

戻り値:

ロールが書き込み可能な場合は true

getDescription

public String getDescription()

ロールの説明テキストを返します。

戻り値:

ロールの説明

getMinDegree

public int getMinDegree()

対応するロール参照の最小値を返します。

戻り値:

最小値

getMaxDegree

public int getMaxDegree()

対応するロール参照の最大値を返します。

戻り値:

最大値

getRefMBeanClassName

public String getRefMBeanClassName()

対応するロール内で参照される MBean (複数可) の型名を返します。

戻り値:

参照型名

checkMinDegree

public boolean checkMinDegree(int value)

value パラメータが最小値以上の場合は true、そうでない場合は false を返します。

パラメータ:

value - チェック対象の値

戻り値:

最小値以上の場合は true、そうでない場合は false

checkMaxDegree

public boolean checkMaxDegree(int value)

value パラメータが最大値以下の場合は true、そうでない場合は false を返します。

パラメータ:

value - チェック対象の値

戻り値:

最大値以下の場合は true、そうでない場合は false

toString

public String toString()

ロール情報について説明する文字列を返します。

オーバーライド:

クラス Object 内の toString

戻り値:

ロール情報の説明