Interface MonitoringService

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

public interface MonitoringService extends org.glassfish.api.admin.config.ConfigExtension, org.jvnet.hk2.config.types.PropertyBag
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
     
  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.glassfish.api.monitoring.ContainerMonitoring>
    Get the monitoring configuration for containers that used the default ContainerMonitoring.
    default org.glassfish.api.monitoring.ContainerMonitoring
    Return the monitoring configuration for a container by the provided name, assuming the named container used the default ContainerMonitoring to express its monitoring configuration.
    Gets the value of the dtrace-enabled attribute.
    Gets the value of the mbean-enabled attribute.
    Gets the value of the moduleMonitoringLevels property.
    Gets the value of the monitoring-enabled attribute.
    List<org.glassfish.api.monitoring.MonitoringItem>
    Get the monitoring configuration for other types of containers that used custom monitoring configuration.
    default String
     
    List<org.jvnet.hk2.config.types.Property>
    Properties as per PropertyBag
    default boolean
     
    void
    setDtraceEnabled(String dtraceEnabled)
    Sets the value of the dtrace-enabled attribute.
    void
    setMbeanEnabled(String mbeanEnabled)
    Sets the value of the mbean-enabled attribute.
    void
    Sets the value of the moduleMonitoringLevels property.
    void
    setMonitoringEnabled(String monitoringEnabled)
    Sets the value of the monitoring-enabled attribute.
    default boolean
    setMonitoringLevel(String moduleName, String level)
     

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

    createChild, deepCopy, getParent, getParent

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

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

    • getModuleMonitoringLevels

      @NotNull @NotNull ModuleMonitoringLevels getModuleMonitoringLevels()
      Gets the value of the moduleMonitoringLevels property.
      Returns:
      possible object is ModuleMonitoringLevels
    • setModuleMonitoringLevels

      void setModuleMonitoringLevels(ModuleMonitoringLevels moduleMonitoringLevels) throws PropertyVetoException
      Sets the value of the moduleMonitoringLevels property.
      Parameters:
      moduleMonitoringLevels - allowed object is ModuleMonitoringLevels
      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
    • getMbeanEnabled

      String getMbeanEnabled()
      Gets the value of the mbean-enabled attribute.

      This boolean attribute determines whether monitoring mbeans are enabled or disabled. When disabled, all monitoring activity will be disabled.

      Returns:
      present monitoring activity status
    • setMbeanEnabled

      void setMbeanEnabled(String mbeanEnabled) throws PropertyVetoException
      Sets the value of the mbean-enabled attribute.
      Parameters:
      mbeanEnabled - allowed object is a String
      Throws:
      PropertyVetoException
    • getMonitoringEnabled

      String getMonitoringEnabled()
      Gets the value of the monitoring-enabled attribute.

      This boolean attribute determines whether monitoring mebans are enabled or disabled. When disabled, all monitoring activity will be disabled.

      Returns:
      present monitoring activity status
    • setMonitoringEnabled

      void setMonitoringEnabled(String monitoringEnabled) throws PropertyVetoException
      Sets the value of the monitoring-enabled attribute.
      Parameters:
      monitoringEnabled - allowed object is String
      Throws:
      PropertyVetoException
    • getDtraceEnabled

      String getDtraceEnabled()
      Gets the value of the dtrace-enabled attribute.
      Returns:
      present dtrace status
    • setDtraceEnabled

      void setDtraceEnabled(String dtraceEnabled) throws PropertyVetoException
      Sets the value of the dtrace-enabled attribute.
      Parameters:
      dtraceEnabled - allowed object is String.
      Throws:
      PropertyVetoException
    • getContainerMonitoring

      List<org.glassfish.api.monitoring.ContainerMonitoring> getContainerMonitoring()
      Get the monitoring configuration for containers that used the default ContainerMonitoring.
      Returns:
      list of container monitoring configurations (default)
    • getMonitoringItems

      List<org.glassfish.api.monitoring.MonitoringItem> getMonitoringItems()
      Get the monitoring configuration for other types of containers that used custom monitoring configuration.
      Returns:
      list of container monitoring configurations
    • getContainerMonitoring

      default org.glassfish.api.monitoring.ContainerMonitoring getContainerMonitoring(String name)
      Return the monitoring configuration for a container by the provided name, assuming the named container used the default ContainerMonitoring to express its monitoring configuration.
      Parameters:
      name - name of the container to return the configuration for
      Returns:
      the container configuration or null if not found
    • getMonitoringLevel

      default String getMonitoringLevel(String moduleName)
    • setMonitoringLevel

      default boolean setMonitoringLevel(String moduleName, String level) throws org.jvnet.hk2.config.TransactionFailure, PropertyVetoException
      Throws:
      org.jvnet.hk2.config.TransactionFailure
      PropertyVetoException
    • isAnyModuleOn

      default boolean isAnyModuleOn()