Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.ant
Class JMX

java.lang.Object
  extended byTask
      extended byorg.jboss.ant.JMX
public class JMX
extends Task

JMX.java. An ant plugin to call managed operations and set attributes on mbeans in a jboss jmx mbean server. To use this plugin with Ant, place the jbossjmx-ant.jar together with the jboss jars jboss-j2ee.jar and jboss-common-client.jar, and the sun jnet.jar in the ant/lib directory you wish to use. Here is an example from an ant build file. Created: Tue Jun 11 20:17:44 2002

See Also:
Serialized Form

Nested Class Summary
static class JMX.Getter (src)
          The class Getter specifies getting an attribute value of an mbean.
static class JMX.Invoke (src)
          The class Invoke specifies the invocation of a managed operation.
static interface JMX.Operation (src)
          The interface Operation provides a common interface for the sub-tasks..
static class JMX.Param (src)
          The class Param is used to represent a object by means of a string representation of its value and its type.
static class JMX.PropertyEditorHolder (src)
          The class PropertyEditorHolder allows you to add a PropertyEditor to the default set.
static class JMX.Setter (src)
          The class Setter specifies setting an attribute value on an mbean.
 
Constructor Summary
JMX()
          Creates a new JMX instance.
 
Method Summary
 void addGetAttribute(JMX.Getter (src)  getter)
          Use the addGetAttribute method to add a get-attribute operation.
 void addInvoke(JMX.Invoke (src)  invoke)
          Use the addInvoke method to add an operation.
 void addPropertyEditor(JMX.PropertyEditorHolder (src)  peh)
          Use the addPropertyEditor method to make a PropertyEditor available for values.
 void addSetAttribute(JMX.Setter (src)  setter)
          Use the addSetAttribute method to add a set-attribute operation.
 void execute()
          The execute method is called by ant to execute the task.
 void setAdapterName(java.lang.String adapterName)
          Use the setAdapterName method to set the name the adapter mbean is bound under in jndi.
 void setServerURL(java.lang.String serverURL)
          Use the setServerURL method to set the URL of the server you wish to connect to.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JMX

public JMX()
    throws java.lang.Exception
Creates a new JMX instance. Provides a default adapterName for the current server, so you only need to set it to talk to a remote server.

Throws:
java.lang.Exception - if an error occurs
Method Detail

setServerURL

public void setServerURL(java.lang.String serverURL)
Use the setServerURL method to set the URL of the server you wish to connect to.

Parameters:
serverURL - a String value

setAdapterName

public void setAdapterName(java.lang.String adapterName)
Use the setAdapterName method to set the name the adapter mbean is bound under in jndi.

Parameters:
adapterName - a String value

addInvoke

public void addInvoke(JMX.Invoke (src)  invoke)
Use the addInvoke method to add an operation. Include as attributes the target ObjectName and operation name. Include as sub-elements parameters: see addParameter in the Invoke class.

Parameters:
invoke - an Invoke value

addSetAttribute

public void addSetAttribute(JMX.Setter (src)  setter)
Use the addSetAttribute method to add a set-attribute operation. Include as attributes the target ObjectName and the the attribute name. Include the value as a nested value tag following the parameter syntax.

Parameters:
setter - a Setter value

addGetAttribute

public void addGetAttribute(JMX.Getter (src)  getter)
Use the addGetAttribute method to add a get-attribute operation. Include as attributes the target ObjectName, the the attribute name, and a property name to hold the result of the get-attribute operation.

Parameters:
getter - a Getter value

addPropertyEditor

public void addPropertyEditor(JMX.PropertyEditorHolder (src)  peh)
Use the addPropertyEditor method to make a PropertyEditor available for values. Include attributes for the type and editor fully qualified class name.

Parameters:
peh - a PropertyEditorHolder value

execute

public void execute()
             throws BuildException
The execute method is called by ant to execute the task.

Throws:
BuildException - if an error occurs
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD