All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.catalina.ant.jmx.JMXAccessorCondition Maven / Gradle / Ivy

There is a newer version: 11.0.0-M26
Show newest version
/*
 * 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 java.io.IOException;
import java.net.MalformedURLException;

import javax.management.MBeanServerConnection;
import javax.management.ObjectName;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.ProjectComponent;
import org.apache.tools.ant.taskdefs.condition.Condition;

/**
 *
 * Definition:
 * 
 
 *   <path id="catalina_ant">
 *       <fileset dir="${catalina.home}/server/lib">
 *           <include name="catalina-ant.jar"/>
 *       </fileset>
 *   </path>
 *
 *   <typedef
 *       name="jmxCondition"
 *       classname="org.apache.catalina.ant.jmx.JMXAccessorCondition"
 *       classpathref="catalina_ant"/>
 *   <taskdef
 *       name="jmxOpen"
 *       classname="org.apache.catalina.ant.jmx.JMXAccessorTask"
 *       classpathref="catalina_ant"/>
 * 
* * Usage: Wait for start backup node *
 *     <target name="wait">
 *       <jmxOpen
 *               host="${jmx.host}" port="${jmx.port}" username="${jmx.username}" password="${jmx.password}" />
 *        <waitfor maxwait="${maxwait}" maxwaitunit="second" timeoutproperty="server.timeout" >
 *           <and>
 *               <socket server="${server.name}" port="${server.port}"/>
 *               <http url="${url}"/>
 *               <jmxCondition
 *                   name="Catalina:type=IDataSender,host=localhost,senderAddress=192.168.111.1,senderPort=9025"
 *                   operation="==" 
 *                   attribute="connected" value="true"
 *               />
 *               <jmxCondition
 *                   operation="&lt;"
 *                   name="Catalina:j2eeType=WebModule,name=//${tomcat.application.host}${tomcat.application.path},J2EEApplication=none,J2EEServer=none"
 *                   attribute="startupTime" value="250"
 *               />
 *           </and>
 *       </waitfor>
 *       <fail if="server.timeout" message="Server ${url} don't answer inside ${maxwait} sec" />
 *       <echo message="Server ${url} alive" />
 *   </target>
 *
 * 
* Allowed operation between jmx attribute and reference value: *
    *
  • == equals
  • *
  • != not equals
  • *
  • > greater than (&gt;)
  • *
  • >= greater than or equals (&gt;=)
  • *
  • < lesser than (&lt;)
  • *
  • <= lesser than or equals (&lt;=)
  • *
* NOTE: For numeric expressions the type must be set and use xml entities as operations.
* As type we currently support long and double. * @author Peter Rossbach * @since 5.5.10 */ public class JMXAccessorCondition extends ProjectComponent implements Condition { // ----------------------------------------------------- Instance Variables private String url = null; private String host = "localhost"; private String port = "8050"; private String password = null; private String username = null; private String name = null; private String attribute; private String value; private String operation = "==" ; private String type = "long" ; private String ref = "jmx.server"; private String unlessCondition; private String ifCondition; // ----------------------------------------------------- Instance Info /** * Descriptive information describing this implementation. */ private static final String info = "org.apache.catalina.ant.JMXAccessorCondition/1.1"; /** * Return descriptive information about this implementation and the * corresponding version number, in the format * <description>/<version>. */ public String getInfo() { return (info); } // ----------------------------------------------------- Properties /** * @return Returns the operation. */ public String getOperation() { return operation; } /** * @param operation The operation to set. */ public void setOperation(String operation) { this.operation = operation; } /** * @return Returns the type. */ public String getType() { return type; } /** * @param type The type to set. */ public void setType(String type) { this.type = type; } /** * @return Returns the attribute. */ public String getAttribute() { return attribute; } /** * @param attribute The attribute to set. */ public void setAttribute(String attribute) { this.attribute = attribute; } /** * @return Returns the host. */ public String getHost() { return host; } /** * @param host The host to set. */ public void setHost(String host) { this.host = host; } /** * @return Returns the name. */ public String getName() { return name; } /** * @param objectName The name to set. */ public void setName(String objectName) { this.name = objectName; } /** * @return Returns the password. */ public String getPassword() { return password; } /** * @param password The password to set. */ public void setPassword(String password) { this.password = password; } /** * @return Returns the port. */ public String getPort() { return port; } /** * @param port The port to set. */ public void setPort(String port) { this.port = port; } /** * @return Returns the url. */ public String getUrl() { return url; } /** * @param url The url to set. */ public void setUrl(String url) { this.url = url; } /** * @return Returns the username. */ public String getUsername() { return username; } /** * @param username The username to set. */ public void setUsername(String username) { this.username = username; } /** * @return Returns the value. */ public String getValue() { return value; } // The setter for the "value" attribute public void setValue(String value) { this.value = value; } /** * @return Returns the ref. */ public String getRef() { return ref; } /** * @param refId The ref to set. */ public void setRef(String refId) { this.ref = refId; } /** * @return Returns the ifCondition. */ public String getIf() { return ifCondition; } /** * Only execute if a property of the given name exists in the current project. * @param c property name */ public void setIf(String c) { ifCondition = c; } /** * @return Returns the unlessCondition. */ public String getUnless() { return unlessCondition; } /** * Only execute if a property of the given name does not * exist in the current project. * @param c property name */ public void setUnless(String c) { unlessCondition = c; } /** * Get JMXConnection (default look at jmx.server project reference from jmxOpen Task) * @return active JMXConnection * @throws MalformedURLException * @throws IOException */ protected MBeanServerConnection getJMXConnection() throws MalformedURLException, IOException { return JMXAccessorTask.accessJMXConnection( getProject(), getUrl(), getHost(), getPort(), getUsername(), getPassword(), ref); } /** * Get value from MBeans attribute * @return The value */ protected String accessJMXValue() { try { Object result = getJMXConnection().getAttribute( new ObjectName(name), attribute); if(result != null) return result.toString(); } catch (Exception e) { // ignore access or connection open errors } return null; } /** * test the if condition * @return true if there is no if condition, or the named property exists */ protected boolean testIfCondition() { if (ifCondition == null || "".equals(ifCondition)) { return true; } return getProject().getProperty(ifCondition) != null; } /** * test the unless condition * @return true if there is no unless condition, * or there is a named property but it doesn't exist */ protected boolean testUnlessCondition() { if (unlessCondition == null || "".equals(unlessCondition)) { return true; } return getProject().getProperty(unlessCondition) == null; } /** * This method evaluates the condition * It support for operation ">,>=,<,<=" the types long and double. * @return expression jmxValue operation value */ @Override public boolean eval() { if (operation == null) { throw new BuildException("operation attribute is not set"); } if (value == null) { throw new BuildException("value attribute is not set"); } if ((name == null || attribute == null)) { throw new BuildException( "Must specify a 'attribute', name for equals condition"); } if (testIfCondition() && testUnlessCondition()) { String jmxValue = accessJMXValue(); if (jmxValue != null) { String op = getOperation(); if ("==".equals(op)) { return jmxValue.equals(value); } else if ("!=".equals(op)) { return !jmxValue.equals(value); } else { if ("long".equals(type)) { long jvalue = Long.parseLong(jmxValue); long lvalue = Long.parseLong(value); if (">".equals(op)) { return jvalue > lvalue; } else if (">=".equals(op)) { return jvalue >= lvalue; } else if ("<".equals(op)) { return jvalue < lvalue; } else if ("<=".equals(op)) { return jvalue <= lvalue; } } else if ("double".equals(type)) { double jvalue = Double.parseDouble(jmxValue); double dvalue = Double.parseDouble(value); if (">".equals(op)) { return jvalue > dvalue; } else if (">=".equals(op)) { return jvalue >= dvalue; } else if ("<".equals(op)) { return jvalue < dvalue; } else if ("<=".equals(op)) { return jvalue <= dvalue; } } } } return false; } return true; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy