Interface AbstractMonitorMBean

All Superinterfaces:
Runnable, Shutdownable
All Known Subinterfaces:
ClasspathMonitorMBean, ConnectionMonitorMBean, ResourcepathMonitorMBean
All Known Implementing Classes:
AbstractMonitor, AbstractStatistic, ClasspathMonitor, ConnectionMonitor, ResourcepathMonitor, SqlStatistic
public interface AbstractMonitorMBean extends Shutdownable
Some common interface methods for a monitor MBean are listed here. Originally this interface was part of the PatternTesting project.
Author:
oliver

  • Method Summary

    Modifier and Type
    Method
    Description
    File
    dumpMe()
    This operation dumps the different MBean attributes to a temporary file with a common prefix (the name of the class, e.g.
    void
    dumpMe(String dirname)
    This operation dumps the different MBean attributes to the given directory.
    File
    getDumpDir()
    This operations gives you the directory where the different MBeans attributes are dumped to.
    void
    logMe()
    Prints the different MBean attributes to the log output.

    Methods inherited from interface Runnable

    run

    Methods inherited from interface Shutdownable

    addMeAsShutdownHook, isShutdownHook, removeMeAsShutdownHook
    Modifier and Type
    Method
    Description
    void
    addMeAsShutdownHook()
    To be able to register the instance as shutdown hook you can use this (non static) method.
    boolean
    isShutdownHook()
    Here you can ask if the instance was already registeres ad shutdown hook.
    void
    removeMeAsShutdownHook()
    If you want to unregister the instance as shutdown hook you can use this method.

  • Method Details

    • logMe

      @Description("logs all attributes to the log output") void logMe()
      Prints the different MBean attributes to the log output.

    • dumpMe

      @Description("dumps all attributes to a temporary file") File dumpMe() throws IOException
      This operation dumps the different MBean attributes to a temporary file with a common prefix (the name of the class, e.g. ClasspathMonitor) and the extension ".txt".

      To be able to see the name of the temporary file in the 'jconsole' it should be returned as value.

      Returns:
      the temporary file
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • dumpMe

      @Description("dumps all attributs to the given directory") void dumpMe(String dirname) throws IOException
      This operation dumps the different MBean attributes to the given directory.
      Parameters:
      dirname - the directory name
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • getDumpDir

      @Description("gets the directory where the attributes are dumped to") File getDumpDir()
      This operations gives you the directory where the different MBeans attributes are dumped to.
      Returns:
      the dump directory
      Since:
      2.3