Package org.apache.catalina.ant.jmx
Class JMXAccessorGetTask
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.JMXAccessorGetTask
- All Implemented Interfaces:
- Cloneable
Access JMX JSR 160 MBeans Server.
 
- Get Mbeans attributes
- Show Get result as Ant console log
- Bind Get result as Ant properties
 Examples:
 
 Get an Mbean IDataSender attribute nrOfRequests and create a new ant property IDataSender.9025.nrOfRequests
 
   <jmx:get
           ref="jmx.server"
           name="Catalina:type=IDataSender,host=localhost,senderAddress=192.168.1.2,senderPort=9025"
           attribute="nrOfRequests"
           resultproperty="IDataSender.9025.nrOfRequests"
           echo="false">
       />
 
 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 TypeMethodDescriptionjmxExecute(MBeanServerConnection jmxServerConnection) Execute the specified command, based on the configured properties.protected StringjmxGet(MBeanServerConnection jmxServerConnection, String name) Get property value.voidsetAttribute(String attribute) 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- 
JMXAccessorGetTaskpublic JMXAccessorGetTask()
 
- 
- 
Method Details- 
getAttribute- Returns:
- Returns the attribute.
 
- 
setAttribute- Parameters:
- attribute- The attribute 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
 
- 
jmxGetGet property value.- Parameters:
- jmxServerConnection- Connection to the JMX server
- name- The MBean name
- Returns:
- The error message if any
- Throws:
- Exception- An error occurred
 
 
-