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:
Cloneable
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.JMXAccessorTask
JMX_SERVICE_PREFIX, JMX_SERVICE_SUFFIXFields inherited from class org.apache.catalina.ant.BaseRedirectorHelperTask
alwaysLog, failOnError, redirectErrStream, redirector, redirectorConfigured, redirectorElement, redirectOutput, redirectOutStreamFields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapperFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected StringgetMBeanAttributeType(MBeanServerConnection jmxServerConnection, String name, String attribute) Get MBean Attribute from Mbean ServergetType()getValue()booleanjmxExecute(MBeanServerConnection jmxServerConnection) Execute the specified command, based on the configured properties.protected StringjmxSet(MBeanServerConnection jmxServerConnection, String name) Set property value.voidsetAttribute(String attribute) voidsetConvert(boolean convert) voidvoidMethods 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, testUnlessConditionMethods 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, setOutputpropertyMethods 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, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Constructor Details
-
JMXAccessorSetTask
public JMXAccessorSetTask()
-
-
Method Details
-
getAttribute
- Returns:
- Returns the attribute.
-
setAttribute
- Parameters:
attribute- The attribute to set.
-
getValue
- Returns:
- Returns the value.
-
setValue
- Parameters:
value- The value to set.
-
getType
- Returns:
- Returns the type.
-
setType
- 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
Description 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 classJMXAccessorTask- Parameters:
jmxServerConnection- The JMX connection that should be used- Returns:
- An error message string in some situations
- Throws:
Exception- if an error occurs
-
jmxSet
Set property value.- Parameters:
jmxServerConnection- Connection to the JMX servername- The MBean name- Returns:
- null (no error message to report other than exception)
- Throws:
Exception- An error occurred
-
getMBeanAttributeType
protected String getMBeanAttributeType(MBeanServerConnection jmxServerConnection, String name, String attribute) throws Exception Get MBean Attribute from Mbean Server- Parameters:
jmxServerConnection- The JMX connection namename- The MBean nameattribute- The attribute name- Returns:
- The type of the attribute
- Throws:
Exception- An error occurred
-