Package org.apache.catalina.ant.jmx
Class JMXAccessorInvokeTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.catalina.ant.BaseRedirectorHelperTask
org.apache.catalina.ant.jmx.JMXAccessorTask
org.apache.catalina.ant.jmx.JMXAccessorInvokeTask
- All Implemented Interfaces:
- Cloneable
Access JMX JSR 160 MBeans Server.
 
- open more then one JSR 160 rmi connection
- Get/Set Mbeans attributes
- Call Mbean Operation with arguments
- Argument values can be converted from string to int,long,float,double,boolean,ObjectName or InetAddress
- Query Mbeans
- Show Get, Call, Query result at Ant console log
- Bind Get, Call, Query result at Ant properties
- 
 Get a session attribute hello from session with ref ${sessionid.0} form
 app Catalina:type=Manager,context=/ClusterTest,host=localhost
 <jmx:invoke name="Catalina:type=Manager,context=/ClusterTest,host=localhost" operation="getSessionAttribute" resultproperty="hello"> <arg value="${sessionid.0}"/> <arg value="Hello"/> </jmx:invoke>
- 
 Create new AccessLogger at localhost
 <jmx:invoke name="Catalina:type=MBeanFactory" operation="createAccessLoggerValve" resultproperty="accessLoggerObjectName" > <arg value="Catalina:type=Host,host=localhost"/> </jmx:invoke>
- 
 Remove existing AccessLogger at localhost
 <jmx:invoke name="Catalina:type=MBeanFactory" operation="removeValve" > <arg value="Catalina:type=Valve,name=AccessLogValve,host=localhost"/> </jmx:invoke>
First call to a remote MBeanserver save the JMXConnection a referenz jmx.server
These tasks require Ant 1.6 or later interface.- Since:
- 5.5.10
- Author:
- Peter Rossbach
- 
Field SummaryFields inherited from class org.apache.catalina.ant.jmx.JMXAccessorTaskJMX_SERVICE_PREFIX, JMX_SERVICE_SUFFIXFields inherited from class org.apache.catalina.ant.BaseRedirectorHelperTaskalwaysLog, failOnError, redirectErrStream, redirector, redirectorConfigured, redirectorElement, redirectOutput, redirectOutStreamFields inherited from class org.apache.tools.ant.Tasktarget, taskName, taskType, wrapperFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidgetArgs()jmxExecute(MBeanServerConnection jmxServerConnection) Execute the specified command, based on the configured properties.protected StringjmxInvoke(MBeanServerConnection jmxServerConnection, String name) Invoke specified operation.voidvoidsetOperation(String operation) Methods inherited from class org.apache.catalina.ant.jmx.JMXAccessorTaskaccessJMXConnection, convertStringToType, createJMXConnection, createProperty, createProperty, echoResult, execute, getDelimiter, getHost, getIf, getJMXConnection, getName, getPassword, getPort, getProperty, getRef, getResultproperty, getUnless, getUrl, getUsername, isEcho, isSeparatearrayresults, isUseRef, setDelimiter, setEcho, setHost, setIf, setName, setPassword, setPort, setProperty, setRef, setResultproperty, setSeparatearrayresults, setUnless, setUrl, setUsername, testIfCondition, testUnlessConditionMethods inherited from class org.apache.catalina.ant.BaseRedirectorHelperTaskaddConfiguredRedirector, closeRedirector, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, handleOutput, isFailOnError, openRedirector, setAlwaysLog, setAppend, setCreateEmptyFiles, setError, setErrorProperty, setFailonerror, setLogError, setOutput, setOutputpropertyMethods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleInput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Constructor Details- 
JMXAccessorInvokeTaskpublic JMXAccessorInvokeTask()
 
- 
- 
Method Details- 
getOperation- Returns:
- Returns the operation.
 
- 
setOperation- Parameters:
- operation- The operation to set.
 
- 
addArg
- 
getArgs- Returns:
- Returns the args.
 
- 
setArgs- Parameters:
- args- The args to set.
 
- 
jmxExecuteDescription copied from class:JMXAccessorTaskExecute 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.- Overrides:
- jmxExecutein class- JMXAccessorTask
- Parameters:
- jmxServerConnection- The JMX connection that should be used
- Returns:
- An error message string in some situations
- Throws:
- Exception- if an error occurs
 
- 
jmxInvokeInvoke specified operation.- Parameters:
- jmxServerConnection- Connection to the JMX server
- name- The MBean name
- Returns:
- null (no error message to report other than exception)
- Throws:
- Exception- An error occurred
 
 
-