org.apache.catalina.ant.jmx
Class JMXAccessorCondition

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

All Implemented Interfaces:

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"/>
       </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 (&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.

Since:

5.5.10

Version:

$Id: JMXAccessorCondition.java 1058260 2011-01-12 18:13:47Z markt $

Author:

Peter Rossbach

Field Summary

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

description, location, project

Constructor Summary

JMXAccessorCondition()

Method Summary

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

JMXAccessorCondition

public JMXAccessorCondition()

Method Detail

getInfo

public String getInfo()

Return descriptive information about this implementation and the corresponding version number, in the format <description>/<version>.

getOperation

public String getOperation()

Returns:

Returns the operation.

setOperation

public void setOperation(String operation)

Parameters:

operation - The operation to set.

getType

public String getType()

Returns:

Returns the type.

setType

public void setType(String type)

Parameters:

type - The type to set.

getAttribute

public String getAttribute()

Returns:

Returns the attribute.

setAttribute

public void setAttribute(String attribute)

Parameters:

attribute - The attribute to set.

getHost

public String getHost()

Returns:

Returns the host.

setHost

public void setHost(String host)

Parameters:

host - The host to set.

getName

public String getName()

Returns:

Returns the name.

setName

public void setName(String objectName)

Parameters:

objectName - The name to set.

getPassword

public String getPassword()

Returns:

Returns the password.

setPassword

public void setPassword(String password)

Parameters:

password - The password to set.

getPort

public String getPort()

Returns:

Returns the port.

setPort

public void setPort(String port)

Parameters:

port - The port to set.

getUrl

public String getUrl()

Returns:

Returns the url.

setUrl

public void setUrl(String url)

Parameters:

url - The url to set.

getUsername

public String getUsername()

Returns:

Returns the username.

setUsername

public void setUsername(String username)

Parameters:

username - The username to set.

getValue

public String getValue()

Returns:

Returns the value.

setValue

public void setValue(String value)

getRef

public String getRef()

Returns:

Returns the ref.

setRef

public void setRef(String refId)

Parameters:

refId - The ref to set.

getIf

public String getIf()

Returns:

Returns the ifCondition.

setIf

public void setIf(String c)

Only execute if a property of the given name exists in the current project.

Parameters:

c - property name

getUnless

public String getUnless()

Returns:

Returns the unlessCondition.

setUnless

public void setUnless(String c)

Only execute if a property of the given name does not exist in the current project.

Parameters:

c - property name

getJMXConnection

protected MBeanServerConnection getJMXConnection()
                                          throws MalformedURLException,
                                                 IOException

Get JMXConnection (default look at jmx.server project reference from jmxOpen Task)

Returns:

active JMXConnection

Throws:

MalformedURLException

IOException

accessJMXValue

protected String accessJMXValue()

Get value from MBeans attribute

Returns:

The value

testIfCondition

protected boolean testIfCondition()

test the if condition

Returns:

true if there is no if condition, or the named property exists

testUnlessCondition

protected boolean testUnlessCondition()

test the unless condition

Returns:

true if there is no unless condition, or there is a named property but it doesn't exist

eval

public boolean eval()

This method evaluates the condition It support for operation ">,>=,<,<=" the types long and double.

Specified by:

eval in interface org.apache.tools.ant.taskdefs.condition.Condition

Returns:

expression jmxValue operation value