JMXAccessorCondition (Tomcat API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.catalina.ant.jmx
Class JMXAccessorCondition

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.catalina.ant.jmx.JMXAccessorCondition

All Implemented Interfaces:: java.lang.Cloneable, org.apache.tools.ant.taskdefs.condition.Condition

public class JMXAccessorCondition
extends org.apache.tools.ant.ProjectComponent
implements org.apache.tools.ant.taskdefs.condition.Condition

Definition:

 
   <path id="catalina_ant">
       <fileset dir="${catalina.home}/server/lib">
           <include name="catalina-ant.jar"/>
           <include name="catalina-ant-jmx.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 (>)
>= greater than or equals (>=)
< lesser than (<)
<= lesser than or equals (<=)

NOTE: For numeric expressions the type must be set and use xml entities as operations.
As type we currently support long and double.

Since:: 5.5.10
Version:: $Id: JMXAccessorCondition.java 939523 2010-04-30 00:28:42Z kkolinko $
Author:: Peter Rossbach

Field Summary

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary
`JMXAccessorCondition()`

Method Summary
`protected java.lang.String`	`accessJMXValue()` Get value from MBeans attribute
`boolean`	`eval()` This method evaluates the condition It support for operation ">,>=,<,<=" the types `long` and `double`.
`java.lang.String`	`getAttribute()`
`java.lang.String`	`getHost()`
`java.lang.String`	`getIf()`
`java.lang.String`	`getInfo()` Return descriptive information about this implementation and the corresponding version number, in the format `<description>/<version>`.
`protected javax.management.MBeanServerConnection`	`getJMXConnection()` Get JMXConnection (default look at jmx.server project reference from jmxOpen Task)
`java.lang.String`	`getName()`
`java.lang.String`	`getOperation()`
`java.lang.String`	`getPassword()`
`java.lang.String`	`getPort()`
`java.lang.String`	`getRef()`
`java.lang.String`	`getType()`
`java.lang.String`	`getUnless()`
`java.lang.String`	`getUrl()`
`java.lang.String`	`getUsername()`
`java.lang.String`	`getValue()`
`void`	`setAttribute(java.lang.String attribute)`
`void`	`setHost(java.lang.String host)`
`void`	`setIf(java.lang.String c)` Only execute if a property of the given name exists in the current project.
`void`	`setName(java.lang.String objectName)`
`void`	`setOperation(java.lang.String operation)`
`void`	`setPassword(java.lang.String password)`
`void`	`setPort(java.lang.String port)`
`void`	`setRef(java.lang.String refId)`
`void`	`setType(java.lang.String type)`
`void`	`setUnless(java.lang.String c)` Only execute if a property of the given name does not exist in the current project.
`void`	`setUrl(java.lang.String url)`
`void`	`setUsername(java.lang.String username)`
`void`	`setValue(java.lang.String value)`
`protected boolean`	`testIfCondition()` test the if condition
`protected boolean`	`testUnlessCondition()` test the unless condition

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail