Package org.apache.catalina.ant.jmx
Class JMXAccessorSetTask
- 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.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 an 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,context="/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
 
- 
- 
Field Summary- 
Fields inherited from class org.apache.catalina.ant.jmx.JMXAccessorTaskJMX_SERVICE_PREFIX, JMX_SERVICE_SUFFIX
 - 
Fields inherited from class org.apache.catalina.ant.BaseRedirectorHelperTaskalwaysLog, failOnError, redirectErrStream, redirector, redirectorConfigured, redirectorElement, redirectOutput, redirectOutStream
 
- 
 - 
Constructor SummaryConstructors Constructor Description JMXAccessorSetTask()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetAttribute()protected java.lang.StringgetMBeanAttributeType(javax.management.MBeanServerConnection jmxServerConnection, java.lang.String name, java.lang.String attribute)Get MBean Attribute from Mbean Serverjava.lang.StringgetType()java.lang.StringgetValue()booleanisConvert()java.lang.StringjmxExecute(javax.management.MBeanServerConnection jmxServerConnection)Execute the specified command, based on the configured properties.protected java.lang.StringjmxSet(javax.management.MBeanServerConnection jmxServerConnection, java.lang.String name)Set property value.voidsetAttribute(java.lang.String attribute)voidsetConvert(boolean convert)voidsetType(java.lang.String valueType)voidsetValue(java.lang.String value)- 
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, testUnlessCondition
 - 
Methods inherited from class org.apache.catalina.ant.BaseRedirectorHelperTaskaddConfiguredRedirector, 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.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleInput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
- 
 
- 
- 
- 
Method Detail- 
getAttributepublic java.lang.String getAttribute() - Returns:
- Returns the attribute.
 
 - 
setAttributepublic void setAttribute(java.lang.String attribute) - Parameters:
- attribute- The attribute to set.
 
 - 
getValuepublic java.lang.String getValue() - Returns:
- Returns the value.
 
 - 
setValuepublic void setValue(java.lang.String value) - Parameters:
- value- The value to set.
 
 - 
getTypepublic java.lang.String getType() - Returns:
- Returns the type.
 
 - 
setTypepublic void setType(java.lang.String valueType) - Parameters:
- valueType- The type to set.
 
 - 
isConvertpublic boolean isConvert() - Returns:
- Returns the convert.
 
 - 
setConvertpublic void setConvert(boolean convert) - Parameters:
- convert- The convert to set.
 
 - 
jmxExecutepublic java.lang.String jmxExecute(javax.management.MBeanServerConnection jmxServerConnection) throws java.lang.ExceptionDescription 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:
- java.lang.Exception- if an error occurs
 
 - 
jmxSetprotected java.lang.String jmxSet(javax.management.MBeanServerConnection jmxServerConnection, java.lang.String name) throws java.lang.ExceptionSet property value.- Parameters:
- jmxServerConnection- Connection to the JMX server
- name- The MBean name
- Returns:
- null (no error message to report other than exception)
- Throws:
- java.lang.Exception- An error occurred
 
 - 
getMBeanAttributeTypeprotected java.lang.String getMBeanAttributeType(javax.management.MBeanServerConnection jmxServerConnection, java.lang.String name, java.lang.String attribute) throws java.lang.ExceptionGet MBean Attribute from Mbean Server- Parameters:
- jmxServerConnection- The JMX connection name
- name- The MBean name
- attribute- The attribute name
- Returns:
- The type of the attribute
- Throws:
- java.lang.Exception- An error occurred
 
 
- 
 
-