| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| package org.apache.catalina.ant.jmx; |
| |
| import javax.management.MBeanServerConnection; |
| import javax.management.ObjectName; |
| |
| import org.apache.tools.ant.BuildException; |
| |
| /** |
| * unregister a MBean at <em>JMX</em> JSR 160 MBeans Server. |
| * <ul> |
| * <li>unregister Mbeans</li> |
| * </ul> |
| * <p> |
| * Examples: |
| * <br/> |
| * unregister an existing Mbean at jmx.server connection |
| * <pre> |
| * <jmx:unregister |
| * ref="jmx.server" |
| * name="Catalina:type=MBeanFactory" /> |
| * </pre> |
| * </p> |
| * <p> |
| * <b>WARNING</b>Not 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. |
| * </p> |
| * <p> |
| * First call to a remote MBeanserver save the JMXConnection a reference <em>jmx.server</em> |
| * </p> |
| * These tasks require Ant 1.6 or later interface. |
| * |
| * @author Peter Rossbach |
| * @version $Revision$ |
| * @since 5.5.12 |
| */ |
| public class JMXAccessorUnregisterTask extends JMXAccessorTask { |
| |
| // ----------------------------------------------------- Instance Info |
| |
| /** |
| * Descriptive information describing this implementation. |
| */ |
| private static final String info = "org.apache.catalina.ant.JMXAccessorUnregisterTask/1.0"; |
| |
| /** |
| * Return descriptive information about this implementation and the |
| * corresponding version number, in the format |
| * <code><description>/<version></code>. |
| * @return Returns the class info. |
| */ |
| public String getInfo() { |
| |
| return (info); |
| |
| } |
| // ------------------------------------------------------ protected Methods |
| |
| /** |
| * 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. |
| * |
| * @exception Exception |
| * if an error occurs |
| */ |
| public String jmxExecute(MBeanServerConnection jmxServerConnection) |
| throws Exception { |
| |
| if (getName() == null) { |
| throw new BuildException("Must specify a 'name'"); |
| } |
| return jmxUuregister(jmxServerConnection, getName()); |
| } |
| |
| |
| /** |
| * Unregister Mbean |
| * @param jmxServerConnection |
| * @param name |
| * @return The value of the given named attribute |
| * @throws Exception |
| */ |
| protected String jmxUuregister(MBeanServerConnection jmxServerConnection,String name) throws Exception { |
| String error = null; |
| if(isEcho()) { |
| handleOutput("Unregister MBean " + name ); |
| } |
| jmxServerConnection.unregisterMBean( |
| new ObjectName(name)); |
| return error; |
| } |
| |
| } |