JMXAccessorGetTask (Apache Tomcat 7.0.67 API Documentation)

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:

java.lang.Cloneable
```
public class JMXAccessorGetTask
extends JMXAccessorTask
```
Access JMX JSR 160 MBeans Server.
- Get Mbeans attributes
- Show Get result as Ant console log
- Bind Get result as Ant properties
Examples:
Get a 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 Summary
- Fields inherited from class org.apache.catalina.ant.jmx.JMXAccessorTask
  JMX_SERVICE_PREFIX, JMX_SERVICE_SUFFIX
- Fields inherited from class org.apache.catalina.ant.BaseRedirectorHelperTask
  alwaysLog, failOnError, redirectErrStream, redirector, redirectorConfigured, redirectorElement, redirectOutput, redirectOutStream
- Fields inherited from class org.apache.tools.ant.Task
  target, taskName, taskType, wrapper
- Fields inherited from class org.apache.tools.ant.ProjectComponent
  description, location, project

Constructor Summary

Constructors
Constructor and Description

JMXAccessorGetTask()

Constructors
Constructor and Description
`JMXAccessorGetTask()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttribute()`
`java.lang.String`	`getInfo()` Return descriptive information about this implementation and the corresponding version number, in the format `<description>/<version>`.
`java.lang.String`	`jmxExecute(javax.management.MBeanServerConnection jmxServerConnection)` Execute the specified command, based on the configured properties.
`protected java.lang.String`	`jmxGet(javax.management.MBeanServerConnection jmxServerConnection, java.lang.String name)`
`void`	`setAttribute(java.lang.String attribute)`

Methods inherited from class org.apache.catalina.ant.jmx.JMXAccessorTask
accessJMXConnection, 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, testUnlessCondition

Methods inherited from class org.apache.catalina.ant.BaseRedirectorHelperTask
addConfiguredRedirector, closeRedirector, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, handleOutput, isFailOnError, openRedirector, setAlwaysLog, setAppend, setCreateEmptyFiles, setError, setErrorProperty, setFailonerror, setLogError, setOutput, setOutputproperty

Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleInput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JMXAccessorGetTask
```
public JMXAccessorGetTask()
```
- Method Detail
  - getInfo
```
public java.lang.String getInfo()
```
    Return descriptive information about this implementation and the corresponding version number, in the format <description>/<version>.
    
    Overrides:
    
    getInfo in class JMXAccessorTask
  - getAttribute
```
public java.lang.String getAttribute()
```
    Returns:
    Returns the attribute.
  - setAttribute
```
public void setAttribute(java.lang.String attribute)
```
    Parameters:
    attribute - The attribute to set.
  - jmxExecute
```
public java.lang.String jmxExecute(javax.management.MBeanServerConnection jmxServerConnection)
                            throws java.lang.Exception
```
    Execute 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:
    
    jmxExecute in class JMXAccessorTask
    
    Throws:
    
    org.apache.tools.ant.BuildException - if an error occurs
    
    java.lang.Exception - if an error occurs
  - jmxGet
```
protected java.lang.String jmxGet(javax.management.MBeanServerConnection jmxServerConnection,
                      java.lang.String name)
                           throws java.lang.Exception
```
    Parameters:
    jmxServerConnection -
    name -
    
    Returns:
    The value of the given named attribute
    
    Throws:
    
    java.lang.Exception

Class JMXAccessorGetTask

Field Summary

Fields inherited from class org.apache.catalina.ant.jmx.JMXAccessorTask

Fields inherited from class org.apache.catalina.ant.BaseRedirectorHelperTask

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

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.ant.jmx.JMXAccessorTask

Methods inherited from class org.apache.catalina.ant.BaseRedirectorHelperTask

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

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

Methods inherited from class java.lang.Object

Constructor Detail

JMXAccessorGetTask

Method Detail

getInfo

getAttribute

setAttribute

jmxExecute

jmxGet