Package org.apache.tomcat.util.modeler

Class OperationInfo

  • All Implemented Interfaces:
    java.io.Serializable
    public class OperationInfo
extends FeatureInfo

    Internal configuration information for an Operation descriptor.

    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String impact
      Impact of the operation.
      protected ParameterInfo[] parameters
      Array of parameters.
      protected java.util.concurrent.locks.ReadWriteLock parametersLock
      Lock for parameter access.
      protected java.lang.String role
      Role of the operation.

    • Constructor Summary

      Constructors 
      Constructor Description
      OperationInfo()
      Standard zero-arguments constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addParameter​(ParameterInfo parameter)
      Add a new parameter to the set of arguments for this operation.
      java.lang.String getImpact()
      Returns the "impact" of this operation, which should be a (case-insensitive) string value "ACTION", "ACTION_INFO", "INFO", or "UNKNOWN".
      protected javax.management.MBeanParameterInfo[] getMBeanParameterInfo()
      Creates an array of MBeanParameterInfo from the operation parameters.
      java.lang.String getReturnType()
      Returns the fully qualified Java class name of the return type for this operation.
      java.lang.String getRole()
      Returns the role of this operation ("getter", "setter", "operation", or "constructor").
      ParameterInfo[] getSignature()
      Returns the array of parameters for this operation.
      void setImpact​(java.lang.String impact)
      Sets the impact of this operation.
      void setReturnType​(java.lang.String returnType)
      Sets the return type of this operation.
      void setRole​(java.lang.String role)
      Sets the role of this operation.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • impact

        protected java.lang.String impact
        Impact of the operation.

      • role

        protected java.lang.String role
        Role of the operation.

      • parametersLock

        protected final java.util.concurrent.locks.ReadWriteLock parametersLock
        Lock for parameter access.

      • parameters

        protected ParameterInfo[] parameters
        Array of parameters.

    • Constructor Detail

      • OperationInfo

        public OperationInfo()
        Standard zero-arguments constructor.

    • Method Detail

      • getImpact

        public java.lang.String getImpact()
        Returns the "impact" of this operation, which should be a (case-insensitive) string value "ACTION", "ACTION_INFO", "INFO", or "UNKNOWN".
        Returns:
        The impact of this operation

      • setImpact

        public void setImpact​(java.lang.String impact)
        Sets the impact of this operation.
        Parameters:
        impact - The impact value

      • getRole

        public java.lang.String getRole()
        Returns the role of this operation ("getter", "setter", "operation", or "constructor").
        Returns:
        The role of this operation

      • setRole

        public void setRole​(java.lang.String role)
        Sets the role of this operation.
        Parameters:
        role - The role value

      • getReturnType

        public java.lang.String getReturnType()
        Returns the fully qualified Java class name of the return type for this operation.
        Returns:
        The return type

      • setReturnType

        public void setReturnType​(java.lang.String returnType)
        Sets the return type of this operation.
        Parameters:
        returnType - The return type

      • getSignature

        public ParameterInfo[] getSignature()
        Returns the array of parameters for this operation.
        Returns:
        The parameter array

      • addParameter

        public void addParameter​(ParameterInfo parameter)
        Add a new parameter to the set of arguments for this operation.
        Parameters:
        parameter - The new parameter descriptor

      • getMBeanParameterInfo

        protected javax.management.MBeanParameterInfo[] getMBeanParameterInfo()
        Creates an array of MBeanParameterInfo from the operation parameters.
        Returns:
        The MBean parameter info array