UndeployComponentTask (Rhino 3.1 Ant Management)

java.lang.Object
- com.opencloud.slee.mlet.ant.tasks.AbstractBaseTask
- - com.opencloud.slee.mlet.ant.tasks.ComponentBasedTask
  - - com.opencloud.slee.mlet.ant.tasks.UndeployComponentTask

All Implemented Interfaces:: SubTask

public class UndeployComponentTask
extends ComponentBasedTask

A Rhino management sub task for undeploying a component across the cluster.

Ant Parameters
Attribute	Description	Required
failonerror	Flag to control failure behaviour. If 'true', the sub task will throw a `BuildException` when an error is encountered. If 'false', the sub task will throw a `NonFatalBuildException` instead of a `BuildException` under specific circumstances. See below for conditions (if any) which will cause a `NonFatalBuildException`.	No. default value is taken from the Rhino management parent task.

Parameters available as nested elements
Element	Description	Required
component	Identifies the component to undeploy. See `SleeComponentElement`	Yes.

NonFatalBuildException throw conditions

The task is run targeting a component that is not currently deployed.

- Field Summary
  - Fields inherited from class com.opencloud.slee.mlet.ant.tasks.ComponentBasedTask
    component
  - Fields inherited from class com.opencloud.slee.mlet.ant.tasks.AbstractBaseTask
    client, failOnError
- Constructor Summary
  
  Constructors
  Constructor Description
  
  UndeployComponentTask()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  protected void execute()
  
  protected void validateParameters()
  - Methods inherited from class com.opencloud.slee.mlet.ant.tasks.ComponentBasedTask
    addComponent, findComponent
  - Methods inherited from class com.opencloud.slee.mlet.ant.tasks.AbstractBaseTask
    getExceptionAndMessage, getFailOnError, getMessage, getOverrideFailOnError, getParent, getProject, log, run, setFailOnError
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - UndeployComponentTask
```
public UndeployComponentTask()
```
- Method Detail
  - validateParameters
```
protected void validateParameters()
                           throws org.apache.tools.ant.BuildException
```
    Specified by:
    
    validateParameters in class AbstractBaseTask
    
    Throws:
    
    org.apache.tools.ant.BuildException
  - execute
```
protected void execute()
                throws org.apache.tools.ant.BuildException
```
    Specified by:
    
    execute in class AbstractBaseTask
    
    Throws:
    
    org.apache.tools.ant.BuildException