モジュール java.management
パッケージ javax.management.modelmbean

クラスModelMBeanOperationInfo

java.lang.Object
javax.management.MBeanFeatureInfo
javax.management.MBeanOperationInfo
javax.management.modelmbean.ModelMBeanOperationInfo
すべての実装されたインタフェース:
Serializable, Cloneable, DescriptorAccess, DescriptorRead
public class ModelMBeanOperationInfo
extends MBeanOperationInfo
implements DescriptorAccess

ModelMBeanOperationInfoオブジェクトは、ModelMBeanの管理オペレーションを記述します。 これは、関連Descriptorを持ち、DescriptorAccessインタフェースを実装したMBeanOperationInfoのサブクラスです。

記述子内のフィールドは次のように定義済みですが、この内容に限定されません。 この表で型がNumberである場合は、Longの10進数表現であるStringを使用することもできます。

ModelMBeanOperationInfoフィールド
名前型意味
nameString オペレーション名。
descriptorTypeString 必ずoperation。
classString メソッドが定義されたクラス(完全修飾)。
roleString 必ずoperation、getter、またはsetter。
targetObjectObject メソッドはこのオブジェクトに対して実行される。
targetTypeString targetObjectのオブジェクト参照型。 次のうちのいずれか: ObjectReference、Handle、EJBHandle、IOR、RMIReference。
valueObject オペレーションのキャッシュ値。
displayNameString 人間が読める形式のオペレーションの表示名。
currencyTimeLimitNumber キャッシュ値の有効期間。
lastUpdatedTimeStampNumber キャッシュ値が設定された時刻。
visibilityNumber 1 - 4の値のうち1: 常に可視4:ほとんど不可視。
presentationStringString オペレーションの表現方法を説明するためのXML形式の文字列

デフォルトの記述子は、name、descriptorType、displayName、およびroleフィールドを設定します。 nameおよびdisplayNameフィールドのデフォルト値は、オペレーションの名前です。

注: 以前のバージョンの仕様との不整合があるため、currencyTimeLimitにはゼロ以下の値を使用しないようにしてください。 キャッシュに入った値が有効でないことを示す場合は、currencyTimeLimitフィールドを省略します。 この値が常に有効であることを示す場合は、このフィールドに非常に大きい値を指定します。

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

導入されたバージョン:
1.5
関連項目:
直列化された形式

  • コンストラクタの詳細

    • ModelMBeanOperationInfo

      public ModelMBeanOperationInfo​(String description, Method operationMethod)
      デフォルトの記述子でModelMBeanOperationInfoオブジェクトを構築します。 構築されたオブジェクトのDescriptorには、DescriptorKeyメタ注釈を含むMethodオブジェクト上の注釈が寄与するフィールドが含まれます。
      パラメータ:
      operationMethod - MBeanオペレーションを記述するjava.lang.reflect.Methodオブジェクト。
      description - 人間が読める形式のオペレーションの説明。

    • ModelMBeanOperationInfo

      public ModelMBeanOperationInfo​(String description, Method operationMethod, Descriptor descriptor)
      ModelMBeanOperationInfoオブジェクトを構築します。 構築されたオブジェクトのDescriptorには、DescriptorKeyメタ注釈を含むMethodオブジェクト上の注釈が寄与するフィールドが含まれます。
      パラメータ:
      operationMethod - MBeanオペレーションを記述するjava.lang.reflect.Methodオブジェクト。
      description - 人間が読める形式のオペレーションの説明。
      descriptor - このModelMBeanOperationInfoインスタンス用として適切なメタデータを含むDescriptorインスタンス。 nullの場合、デフォルトの記述子が作成される。 記述子にdisplayNameフィールドまたはroleフィールドが含まれない場合、見つからないフィールドがデフォルト値で追加される。
      例外:
      RuntimeOperationsException - IllegalArgumentExceptionをラップする。 記述子が無効である場合、記述子フィールドnameがオペレーション名と等しくない場合、記述子フィールドDescriptorTypeがoperationと等しくない場合、または記述子のオプション・フィールドroleが存在するが、operation、getter、またはsetterと等しくない場合。

    • ModelMBeanOperationInfo

      public ModelMBeanOperationInfo​(String name, String description, MBeanParameterInfo[] signature, String type, int impact)
      デフォルトの記述子でModelMBeanOperationInfoオブジェクトを構築します。
      パラメータ:
      name - メソッドの名前。
      description - 人間が読める形式のオペレーションの説明。
      signature - メソッドのパラメータ(引数)を記述するMBeanParameterInfoオブジェクト。
      type - メソッドの戻り値の型。
      impact - メソッドの影響。INFO、ACTION、ACTION_INFO、UNKNOWNのいずれか。

    • ModelMBeanOperationInfo

      public ModelMBeanOperationInfo​(String name, String description, MBeanParameterInfo[] signature, String type, int impact, Descriptor descriptor)
      ModelMBeanOperationInfoオブジェクトを構築します。
      パラメータ:
      name - メソッドの名前。
      description - 人間が読める形式のオペレーションの説明。
      signature - メソッドのパラメータ(引数)を記述するMBeanParameterInfoオブジェクト。
      type - メソッドの戻り値の型。
      impact - メソッドの影響。INFO、ACTION、ACTION_INFO、UNKNOWNのいずれか。
      descriptor - このMBeanOperationInfoインスタンス用として適切なメタデータを含むDescriptorインスタンス。 nullの場合、デフォルトの記述子が作成される。 記述子にdisplayNameフィールドまたはroleフィールドが含まれない場合、見つからないフィールドがデフォルト値で追加される。
      例外:
      RuntimeOperationsException - IllegalArgumentExceptionをラップする。 記述子が無効である場合、記述子フィールドnameがオペレーション名と等しくない場合、記述子フィールドDescriptorTypeがoperationと等しくない場合、または記述子のオプション・フィールドroleが存在するが、operation、getter、またはsetterと等しくない場合。

    • ModelMBeanOperationInfo

      public ModelMBeanOperationInfo​(ModelMBeanOperationInfo inInfo)
      このModelMBeanOperationオブジェクトから新しいModelMBeanOperationInfoオブジェクトを構築します。
      パラメータ:
      inInfo - 複製されるModelMBeanOperationInfo

  • メソッドの詳細

    • clone

      public Object clone()
      このModelMBeanOperationInfoを複製して新しいModelMBeanOperationInfoを作成し、返します。
      オーバーライド:
      clone、クラス: MBeanOperationInfo
      戻り値:
      このインスタンスの複製。
      関連項目:
      Cloneable

    • getDescriptor

      public Descriptor getDescriptor()
      ModelMBeanOperationInfoに関連付けられたDescriptorのコピーを返します。
      定義:
      getDescriptor、インタフェース: DescriptorRead
      オーバーライド:
      getDescriptor、クラス: MBeanFeatureInfo
      戻り値:
      ModelMBeanOperationInfoオブジェクトに関連付けられたDescriptor。
      関連項目:
      setDescriptor(javax.management.Descriptor)

    • setDescriptor

      public void setDescriptor​(Descriptor inDescriptor)
      ModelMBeanOperationInfoに関連付けられたDescriptor (完全置換)を設定します。新しいDescriptorがnullの場合、関連付けられたDescriptorはデフォルトの記述子に戻ります。 Descriptorの割当て前には、妥当性検査が行われます。 新しいDescriptorが無効である場合、IllegalArgumentExceptionをラップするRuntimeOperationsExceptionがスローされます。
      定義:
      setDescriptor、インタフェース: DescriptorAccess
      パラメータ:
      inDescriptor - ModelMBeanOperationに関連付けられたDescriptorを置換する。
      例外:
      RuntimeOperationsException - 記述子が無効な場合、IllegalArgumentExceptionをラップする。
      関連項目:
      getDescriptor()

    • toString

      public String toString()
      人間が読める形式のModelMBeanOperationInfoのコンテンツ全体を含む文字列を返します。
      オーバーライド:
      toString 、クラス:  Object
      戻り値:
      このオブジェクトの文字列表現。