org.apache.catalina.ant.jmx
Class JMXAccessorSetTask
java.lang.Object
   org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.ProjectComponent
       org.apache.tools.ant.Task
org.apache.tools.ant.Task
           org.apache.catalina.ant.BaseRedirectorHelperTask
org.apache.catalina.ant.BaseRedirectorHelperTask
               org.apache.catalina.ant.jmx.JMXAccessorTask
org.apache.catalina.ant.jmx.JMXAccessorTask
                   org.apache.catalina.ant.jmx.JMXAccessorSetTask
org.apache.catalina.ant.jmx.JMXAccessorSetTask
- All Implemented Interfaces: 
- java.lang.Cloneable
- public class JMXAccessorSetTask 
- 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:
 Set a Mbean Manager attribute maxActiveSessions.
 Set this attribute with fresh jmx connection without save reference 
 
   <jmx:set
           host="127.0.0.1"
           port="9014"
           ref=""
           name="Catalina:type=Manager,path="/ClusterTest",host=localhost" 
           attribute="maxActiveSessions"
           value="100"
           type="int"
           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
 
 
 
| 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 | 
 
 
| Method Summary | 
|  java.lang.String | getAttribute()
 | 
|  java.lang.String | getInfo()Return descriptive information about this implementation and the
 corresponding version number, in the format
 <description>/<version>. | 
| protected  java.lang.String | getMBeanAttributeType(javax.management.MBeanServerConnection jmxServerConnection,
                      java.lang.String name,
                      java.lang.String attribute)Get MBean Attriute from Mbean Server
 | 
|  java.lang.String | getType()
 | 
|  java.lang.String | getValue()
 | 
|  boolean | isConvert()
 | 
|  java.lang.String | jmxExecute(javax.management.MBeanServerConnection jmxServerConnection)Execute the specified command, based on the configured properties.
 | 
| protected  java.lang.String | jmxSet(javax.management.MBeanServerConnection jmxServerConnection,
       java.lang.String name)
 | 
|  void | setAttribute(java.lang.String attribute)
 | 
|  void | setConvert(boolean convert)
 | 
|  void | setType(java.lang.String valueType)
 | 
|  void | setValue(java.lang.String value)
 | 
 
| Methods inherited from class org.apache.catalina.ant.jmx.JMXAccessorTask | 
| accessJMXConnection, convertStringToType, createJMXConnection, createProperty, createProperty, echoResult, execute, getDelimiter, getHost, getIf, getJMXConnection, getName, getPassword, getPort, getProperties, 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, 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 | 
 
JMXAccessorSetTask
public JMXAccessorSetTask()
getInfo
public java.lang.String getInfo()
- Return descriptive information about this implementation and the
 corresponding version number, in the format
 <description>/<version>.
 
- 
- Overrides:
- getInfoin 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.
 
getValue
public java.lang.String getValue()
- 
- Returns:
- Returns the value.
 
setValue
public void setValue(java.lang.String value)
- 
- Parameters:
- value- The value to set.
 
getType
public java.lang.String getType()
- 
- Returns:
- Returns the type.
 
setType
public void setType(java.lang.String valueType)
- 
- Parameters:
- valueType- The type to set.
 
isConvert
public boolean isConvert()
- 
- Returns:
- Returns the convert.
 
setConvert
public void setConvert(boolean convert)
- 
- Parameters:
- convert- The convert 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:
- jmxExecutein class- JMXAccessorTask
 
- 
- Throws:
- java.lang.Exception- if an error occurs
 
jmxSet
protected java.lang.String jmxSet(javax.management.MBeanServerConnection jmxServerConnection,
                                  java.lang.String name)
                           throws java.lang.Exception
- 
- Parameters:
- jmxServerConnection-
- name-
- Throws:
- java.lang.Exception
 
getMBeanAttributeType
protected java.lang.String getMBeanAttributeType(javax.management.MBeanServerConnection jmxServerConnection,
                                                 java.lang.String name,
                                                 java.lang.String attribute)
                                          throws java.lang.Exception
- Get MBean Attriute from Mbean Server
 
- 
- Parameters:
- jmxServerConnection-
- name-
- attribute-
- Returns:
- The type
- Throws:
- java.lang.Exception
 
Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.