Class JMXAccessorGetTask

  • All Implemented Interfaces:
    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 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
    • Constructor Detail

      • JMXAccessorGetTask

        public JMXAccessorGetTask()
    • Method Detail

      • getAttribute

        public String getAttribute()
        Returns:
        Returns the attribute.
      • setAttribute

        public void setAttribute​(String attribute)
        Parameters:
        attribute - The attribute to set.
      • jmxExecute

        public String jmxExecute​(MBeanServerConnection jmxServerConnection)
                          throws Exception
        Description copied from class: JMXAccessorTask
        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
        Parameters:
        jmxServerConnection - The JMX connection that should be used
        Returns:
        An error message string in some situations
        Throws:
        Exception - if an error occurs
      • jmxGet

        protected String jmxGet​(MBeanServerConnection jmxServerConnection,
                                String name)
                         throws Exception
        Get property value.
        Parameters:
        jmxServerConnection - Connection to the JMX server
        name - The MBean name
        Returns:
        The error message if any
        Throws:
        Exception - An error occurred