Class DeactivateRAEntityTask

  • All Implemented Interfaces:
    SubTask

    public class DeactivateRAEntityTask
    extends RAEntityBasedTask

    A Rhino management sub task for deactivating Resource Adaptor Entities.

    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.

    entityname

    Name of the resource adaptor entity to deactivate.

    Yes.

    nodes

    Comma-separated list of node IDs on which the resource adaptor entity should be deactivated.

    No. If omitted an attempt is made to deactivate the resource adaptor entity on all current cluster members.

    NonFatalBuildException throw conditions
    • The task is run targeting an already deactivated entity.

    • The task is run targeting a non-existant entity.

    • Constructor Detail

      • DeactivateRAEntityTask

        public DeactivateRAEntityTask()
    • Method Detail

      • 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
      • setNodes

        public void setNodes​(String nodes)