Package org.apache.catalina.ant.jmx
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
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
- 
Field SummaryFields inherited from class org.apache.catalina.ant.jmx.JMXAccessorTaskJMX_SERVICE_PREFIX, JMX_SERVICE_SUFFIXFields inherited from class org.apache.catalina.ant.BaseRedirectorHelperTaskalwaysLog, failOnError, redirectErrStream, redirector, redirectorConfigured, redirectorElement, redirectOutput, redirectOutStreamFields inherited from class org.apache.tools.ant.Tasktarget, taskName, taskType, wrapperFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionjmxExecute(MBeanServerConnection jmxServerConnection) Execute the specified command, based on the configured properties.protected StringjmxUuregister(MBeanServerConnection jmxServerConnection, String name) Unregister MBean.Methods inherited from class org.apache.catalina.ant.jmx.JMXAccessorTaskaccessJMXConnection, convertStringToType, createJMXConnection, createProperty, createProperty, echoResult, execute, getDelimiter, getHost, getIf, getJMXConnection, getName, getPassword, getPort, getProperty, getRef, getResultproperty, getUnless, getUrl, getUsername, isEcho, isSeparatearrayresults, isUseRef, setDelimiter, setEcho, setHost, setIf, setName, setPassword, setPort, setProperty, setRef, setResultproperty, setSeparatearrayresults, setUnless, setUrl, setUsername, testIfCondition, testUnlessConditionMethods inherited from class org.apache.catalina.ant.BaseRedirectorHelperTaskaddConfiguredRedirector, closeRedirector, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, handleOutput, isFailOnError, openRedirector, setAlwaysLog, setAppend, setCreateEmptyFiles, setError, setErrorProperty, setFailonerror, setLogError, setOutput, setOutputpropertyMethods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleInput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Constructor Details- 
JMXAccessorUnregisterTaskpublic JMXAccessorUnregisterTask()
 
- 
- 
Method Details- 
jmxExecuteDescription copied from class:JMXAccessorTaskExecute 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:
- jmxExecutein 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
 
- 
jmxUuregisterprotected 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
 
 
-