Interface Mbean

All Superinterfaces:
org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.Named, org.jvnet.hk2.config.types.PropertyBag

public interface Mbean extends org.jvnet.hk2.config.ConfigBeanProxy, org.glassfish.api.admin.config.Named, org.jvnet.hk2.config.types.PropertyBag
Note on the Name of the MBean : It is a String that represents the name of the MBean. It is required that the name is valid to represent a "value" of a property in the property-list of MBean ObjectName. The name must be specified and is a primary key for an MBean. An invalid name implies failure of operation.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the value of the description property.
    Gets the value of the enabled property.
    @NotNull String
    Gets the value of the implClassName property.
    Gets the value of the objectName property.
    Gets the value of the objectType property.
    List<org.jvnet.hk2.config.types.Property>
    Properties as per PropertyBag
    void
    Sets the value of the description property.
    void
    Sets the value of the enabled property.
    void
    Sets the value of the implClassName property.
    void
    Sets the value of the objectName property.
    void
    Sets the value of the objectType property.

    Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

    createChild, deepCopy, getParent, getParent

    Methods inherited from interface org.glassfish.api.admin.config.Named

    getName, setName

    Methods inherited from interface org.jvnet.hk2.config.types.PropertyBag

    addProperty, getProperty, getPropertyValue, getPropertyValue, lookupProperty, removeProperty, removeProperty
  • Method Details

    • getObjectType

      String getObjectType()
      Gets the value of the objectType property. A String representing whether it is a user-defined MBean or System MBean.
      Returns:
      possible object is String
    • setObjectType

      void setObjectType(String value) throws PropertyVetoException
      Sets the value of the objectType property.
      Parameters:
      value - allowed object is String
      Throws:
      PropertyVetoException
    • getImplClassName

      @NotNull @NotNull String getImplClassName()
      Gets the value of the implClassName property. A String that represents fully qualified class name of MBean implementation. This is read-only.
      Returns:
      possible object is String
    • setImplClassName

      void setImplClassName(String value) throws PropertyVetoException
      Sets the value of the implClassName property.
      Parameters:
      value - allowed object is String
      Throws:
      PropertyVetoException
    • getObjectName

      String getObjectName()
      Gets the value of the objectName property. A String that represents a system-generated Object Name for this MBean.
      Returns:
      possible object is String
    • setObjectName

      void setObjectName(String value) throws PropertyVetoException
      Sets the value of the objectName property.
      Parameters:
      value - allowed object is String
      Throws:
      PropertyVetoException
    • getEnabled

      String getEnabled()
      Gets the value of the enabled property.
      Returns:
      possible object is String
    • setEnabled

      void setEnabled(String value) throws PropertyVetoException
      Sets the value of the enabled property.
      Parameters:
      value - allowed object is String
      Throws:
      PropertyVetoException
    • getDescription

      String getDescription()
      Gets the value of the description property.
      Returns:
      possible object is String
    • setDescription

      void setDescription(String value) throws PropertyVetoException
      Sets the value of the description property.
      Parameters:
      value - allowed object is String
      Throws:
      PropertyVetoException
    • getProperty

      @ToDo(priority=IMPORTANT, details="Provide PropertyDesc for legal props") @PropertiesDesc(props={}) List<org.jvnet.hk2.config.types.Property> getProperty()
      Properties as per PropertyBag
      Specified by:
      getProperty in interface org.jvnet.hk2.config.types.PropertyBag