javax.management.modelmbean

Class ModelMBeanOperationInfo

Table des matières
  • All Implemented Interfaces:
    Serializable, Cloneable, DescriptorAccess, DescriptorRead

    public class ModelMBeanOperationInfo
extends MBeanOperationInfo
implements DescriptorAccess

    The ModelMBeanOperationInfo object describes a management operation of the ModelMBean. It is a subclass of MBeanOperationInfo with the addition of an associated Descriptor and an implementation of the DescriptorAccess interface.

    The fields in the descriptor are defined, but not limited to, the following. Note that when the Type in this table is Number, a String that is the decimal representation of a Long can also be used.

    NameTypeMeaning
    nameString Operation name.
    descriptorTypeString Must be "operation".
    classString Class where method is defined (fully qualified).
    roleString Must be "operation", "getter", or "setter".
    targetObjectObject Object on which to execute this method.
    targetTypeString type of object reference for targetObject. Can be: ObjectReference | Handle | EJBHandle | IOR | RMIReference.
    valueObject Cached value for operation.
    displayNameString Human readable display name of the operation.
    currencyTimeLimitNumber How long cached value is valid.
    lastUpdatedTimeStampNumber When cached value was set.
    visibilityNumber 1-4 where 1: always visible 4: rarely visible.
    presentationStringString XML formatted string to describe how to present operation

      

    The default descriptor will have name, descriptorType, displayName and role fields set. The default value of the name and displayName fields is the operation name.

    Note: because of inconsistencies in previous versions of this specification, it is recommended not to use negative or zero values for currencyTimeLimit. To indicate that a cached value is never valid, omit the currencyTimeLimit field. To indicate that it is always valid, use a very large number for this field.

    The serialVersionUID of this class is 6532732096650090465L.

    Since:
    1.5
    See Also:
    Serialized Form

    • Constructor Detail

      • ModelMBeanOperationInfo

        public ModelMBeanOperationInfo(String description,
                       Method operationMethod)
        Constructs a ModelMBeanOperationInfo object with a default descriptor. The Descriptor of the constructed object will include fields contributed by any annotations on the Method object that contain the DescriptorKey meta-annotation.
        Parameters:
        operationMethod - The java.lang.reflect.Method object describing the MBean operation.
        description - A human readable description of the operation.

      • ModelMBeanOperationInfo

        public ModelMBeanOperationInfo(String description,
                       Method operationMethod,
                       Descriptor descriptor)
        Constructs a ModelMBeanOperationInfo object. The Descriptor of the constructed object will include fields contributed by any annotations on the Method object that contain the DescriptorKey meta-annotation.
        Parameters:
        operationMethod - The java.lang.reflect.Method object describing the MBean operation.
        description - A human readable description of the operation.
        descriptor - An instance of Descriptor containing the appropriate metadata for this instance of the ModelMBeanOperationInfo. If it is null a default descriptor will be created. If the descriptor does not contain the fields "displayName" or "role", the missing ones are added with their default values.
        Throws:
        RuntimeOperationsException - Wraps an IllegalArgumentException. The descriptor is invalid; or descriptor field "name" is not equal to operation name; or descriptor field "DescriptorType" is not equal to "operation"; or descriptor optional field "role" is present but not equal to "operation", "getter", or "setter".

      • ModelMBeanOperationInfo

        public ModelMBeanOperationInfo(String name,
                       String description,
                       MBeanParameterInfo[] signature,
                       String type,
                       int impact)
        Constructs a ModelMBeanOperationInfo object with a default descriptor.
        Parameters:
        name - The name of the method.
        description - A human readable description of the operation.
        signature - MBeanParameterInfo objects describing the parameters(arguments) of the method.
        type - The type of the method's return value.
        impact - The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.

      • ModelMBeanOperationInfo

        public ModelMBeanOperationInfo(String name,
                       String description,
                       MBeanParameterInfo[] signature,
                       String type,
                       int impact,
                       Descriptor descriptor)
        Constructs a ModelMBeanOperationInfo object.
        Parameters:
        name - The name of the method.
        description - A human readable description of the operation.
        signature - MBeanParameterInfo objects describing the parameters(arguments) of the method.
        type - The type of the method's return value.
        impact - The impact of the method, one of INFO, ACTION, ACTION_INFO, UNKNOWN.
        descriptor - An instance of Descriptor containing the appropriate metadata for this instance of the MBeanOperationInfo. If it is null then a default descriptor will be created. If the descriptor does not contain fields "displayName" or "role", the missing ones are added with their default values.
        Throws:
        RuntimeOperationsException - Wraps an IllegalArgumentException. The descriptor is invalid; or descriptor field "name" is not equal to operation name; or descriptor field "DescriptorType" is not equal to "operation"; or descriptor optional field "role" is present but not equal to "operation", "getter", or "setter".

      • ModelMBeanOperationInfo

        public ModelMBeanOperationInfo(ModelMBeanOperationInfo inInfo)
        Constructs a new ModelMBeanOperationInfo object from this ModelMBeanOperation Object.
        Parameters:
        inInfo - the ModelMBeanOperationInfo to be duplicated

    • Method Detail

      • clone

        public Object clone()
        Creates and returns a new ModelMBeanOperationInfo which is a duplicate of this ModelMBeanOperationInfo.
        Overrides:
        clone in class MBeanOperationInfo
        Returns:
        a clone of this instance.
        See Also:
        Cloneable

      • setDescriptor

        public void setDescriptor(Descriptor inDescriptor)
        Sets associated Descriptor (full replace) for the ModelMBeanOperationInfo If the new Descriptor is null, then the associated Descriptor reverts to a default descriptor. The Descriptor is validated before it is assigned. If the new Descriptor is invalid, then a RuntimeOperationsException wrapping an IllegalArgumentException is thrown.
        Specified by:
        setDescriptor in interface DescriptorAccess
        Parameters:
        inDescriptor - replaces the Descriptor associated with the ModelMBeanOperation.
        Throws:
        RuntimeOperationsException - Wraps an IllegalArgumentException for invalid Descriptor.
        See Also:
        getDescriptor()

      • toString

        public String toString()
        Returns a string containing the entire contents of the ModelMBeanOperationInfo in human readable form.
        Overrides:
        toString in class MBeanOperationInfo
        Returns:
        a string representation of the object.

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

29/12/2024 12:37:52 Cette version de la page est en cache (à la date du 29/12/2024 12:37:52) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.

Document créé le 18/12/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/management/modelmbean/ModelMBeanOperationInfo.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com, ModelMBeanOperationInfo

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut