Package com.opencloud.slee.mlet.ant.tasks

Class SetRAEntityDesiredStateTask

java.lang.Object

com.opencloud.slee.mlet.ant.tasks.AbstractBaseTask

com.opencloud.slee.mlet.ant.tasks.RAEntityBasedTask

com.opencloud.slee.mlet.ant.tasks.SetRAEntityDesiredStateTask

All Implemented Interfaces:

SubTask

public class SetRAEntityDesiredStateTask
extends RAEntityBasedTask

A Rhino management sub task for setting the desired state of a Resource Adaptor Entity. <p> .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.
raentityname	Resource adaptor entity name	Yes

<p> .Parameters available as nested elements

Element	Description	Required
desiredstate	One or more elements which can identify either the default desired state, or per-node desired state. Valid values for the state attribute are 'active' and 'inactive'. See DesiredStateElement	Yes (at least one)

<p> .NonFatalBuildException throw conditions The task is run targeting an unrecognised resource adaptor entity.

Field Summary

Fields inherited from class com.opencloud.slee.mlet.ant.tasks.RAEntityBasedTask

entityName

Fields inherited from class com.opencloud.slee.mlet.ant.tasks.AbstractBaseTask

client, failOnError

Constructor Summary

Constructors

Constructor	Description
SetRAEntityDesiredStateTask()

Method Summary

Modifier and Type	Method	Description
void	addDesiredState(DesiredStateElement state)	Add a DesiredStateElement, called by ant.
protected void	execute()
protected void	validateParameters()

Methods inherited from class com.opencloud.slee.mlet.ant.tasks.RAEntityBasedTask

resolveRAEntityName, setEntityName

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

SetRAEntityDesiredStateTask

public SetRAEntityDesiredStateTask()

Method Detail

addDesiredState

public void addDesiredState(DesiredStateElement state)

Add a DesiredStateElement, called by ant.

Parameters:

state - the desired state element

execute

protected void execute()
                throws org.apache.tools.ant.BuildException

Specified by:

execute in class AbstractBaseTask

Throws:

org.apache.tools.ant.BuildException

validateParameters

protected void validateParameters()
                           throws org.apache.tools.ant.BuildException

Specified by:

validateParameters in class AbstractBaseTask

Throws:

org.apache.tools.ant.BuildException