org.apache.catalina.ant.JMXSetTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tomcat-catalina-ant
Tomcat Ant tasks for remote management
There is a newer version: 11.0.1
/*
 * 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;


import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;

import org.apache.tools.ant.BuildException;


/**
 * Ant task that implements the JMX Set command (/jmxproxy/?set) supported by the Tomcat manager
 * application.
 *
 * @author Vivek Chopra
 */
public class JMXSetTask extends AbstractCatalinaTask {

    // Properties

    /**
     * The full bean name
     */
    protected String bean = null;

    /**
     * The attribute you wish to alter
     */
    protected String attribute = null;

    /**
     * The new value for the attribute
     */
    protected String value = null;

    // Public Methods

    /**
     * Get method for the bean name
     *
     * @return Bean name
     */
    public String getBean() {
        return this.bean;
    }

    /**
     * Set method for the bean name
     *
     * @param bean Bean name
     */
    public void setBean(String bean) {
        this.bean = bean;
    }

    /**
     * Get method for the attribute name
     *
     * @return Attribute name
     */
    public String getAttribute() {
        return this.attribute;
    }

    /**
     * Set method for the attribute name
     *
     * @param attribute Attribute name
     */
    public void setAttribute(String attribute) {
        this.attribute = attribute;
    }

    /**
     * Get method for the attribute value
     *
     * @return Attribute value
     */
    public String getValue() {
        return this.value;
    }

    /**
     * Set method for the attribute value.
     *
     * @param value Attribute value
     */
    public void setValue(String value) {
        this.value = value;
    }

    /**
     * Execute the requested operation.
     *
     * @exception BuildException if an error occurs
     */
    @Override
    public void execute() throws BuildException {
        super.execute();
        if (bean == null || attribute == null || value == null) {
            throw new BuildException("Must specify 'bean', 'attribute' and 'value' attributes");
        }
        log("Setting attribute " + attribute + " in bean " + bean + " to " + value);
        try {
            execute("/jmxproxy/?set=" + URLEncoder.encode(bean, getCharset()) + "&att=" +
                    URLEncoder.encode(attribute, getCharset()) + "&val=" + URLEncoder.encode(value, getCharset()));
        } catch (UnsupportedEncodingException e) {
            throw new BuildException("Invalid 'charset' attribute: " + getCharset());
        }
    }
}