org.apache.tools.ant.taskdefs.optional.jmx
Class CopyMBeanTask

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.optional.jmx.AbstractManagementTask
                    |
                    +--org.apache.tools.ant.taskdefs.optional.jmx.AbstractMBeanTask
                          |
                          +--org.apache.tools.ant.taskdefs.optional.jmx.CopyMBeanTask

public class CopyMBeanTask

extends AbstractMBeanTask

This is an Ant task that allows a JMX mbean and all its attributes to be copied to a new domain, or mbean name. Refer to the user documentation for more information and examples on how to use this task.

Version:

$Id: CopyMBeanTask.java,v 1.3 2003/05/26 10:13:05 bdueck Exp $

Author:

Brian Dueck

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

CopyMBeanTask()

Method Summary

protected void	execute(javax.management.MBeanServer mbserver) Process all nested elements
protected javax.management.ObjectName	getToObjectName() Returns the MBean ObjectName based on the toName.
void	setIfExists(IfExists ifExists) Sets the IfExists attribute.
void	setToName(java.lang.String toName) Sets the toName attribute.
void	setType(java.lang.String type)

Methods inherited from class org.apache.tools.ant.taskdefs.optional.jmx.AbstractMBeanTask

execute, findAttributeInfo, getActiveDomain, getAttributes, getAttributes, getFeatureNames, getJMXServer, getName, getObjectName, removeMBeanIfExists, setMBeanRef, setName, toString

Methods inherited from class org.apache.tools.ant.taskdefs.optional.jmx.AbstractManagementTask

getContext, getFailOnError, getJndiName, getPassword, getProviderUrl, getUser, setContext, setContextRef, setFailOnError, setJndiName, setPassword, setProviderUrl, setServerType, setUser

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CopyMBeanTask

public CopyMBeanTask()

Method Detail

setToName

public void setToName(java.lang.String toName)

Sets the toName attribute.

Parameters:

toName - The name of the new mbean.

setType

public void setType(java.lang.String type)

setIfExists

public void setIfExists(IfExists ifExists)

Sets the IfExists attribute. This attribute controls the behaviour of the copyMBean task when an mbean with the same name as the target mbean already exists.

Parameters:

ifExists - The value for the ifExists attribute.

getToObjectName

protected javax.management.ObjectName getToObjectName()
                                               throws javax.management.MalformedObjectNameException

Returns the MBean ObjectName based on the toName.

execute

protected void execute(javax.management.MBeanServer mbserver)
                throws org.apache.tools.ant.BuildException

Process all nested elements

Overrides:

execute in class AbstractMBeanTask

Parameters:

mbserver - The MBeanServer that hosts the mbean.

Throws:

org.apache.tools.ant.BuildException - When an error occurs.