Class JMXAccessorUnregisterTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.catalina.ant.BaseRedirectorHelperTask
org.apache.catalina.ant.jmx.JMXAccessorTask
org.apache.catalina.ant.jmx.JMXAccessorUnregisterTask
All Implemented Interfaces:
Cloneable
public class JMXAccessorUnregisterTask extends JMXAccessorTask
unregister an MBean at JMX JSR 160 MBeans Server.
  • unregister Mbeans

Examples:
unregister an existing Mbean at jmx.server connection 

   <jmx:unregister
           ref="jmx.server"
           name="Catalina:type=MBeanFactory" />

WARNINGNot all Tomcat MBeans can successfully unregister remotely. The mbean unregistration don't remove valves, realm, .. from parent class. Please, use the MBeanFactory operation to remove valves and realms.

First call to a remote MBeanserver save the JMXConnection a reference jmx.server

These tasks require Ant 1.6 or later interface.
Since:
5.5.12
Author:
Peter Rossbach

  • Constructor Details

    • JMXAccessorUnregisterTask

      public JMXAccessorUnregisterTask()

  • Method Details

    • jmxExecute

      public String jmxExecute(MBeanServerConnection jmxServerConnection) throws Exception
      Description copied from class: JMXAccessorTask
      Execute the specified command, based on the configured properties. The input stream will be closed upon completion of this task, whether it was executed successfully or not.
      Overrides:
      jmxExecute in class JMXAccessorTask
      Parameters:
      jmxServerConnection - The JMX connection that should be used
      Returns:
      An error message string in some situations
      Throws:
      Exception - if an error occurs

    • jmxUuregister

      protected String jmxUuregister(MBeanServerConnection jmxServerConnection, String name) throws Exception
      Unregister MBean.
      Parameters:
      jmxServerConnection - Connection to the JMX server
      name - The MBean name
      Returns:
      null (no error message to report other than exception)
      Throws:
      Exception - An error occurred