Class DeactivateServiceTask

  • All Implemented Interfaces:
    SubTask

    public class DeactivateServiceTask
    extends ServiceActivationTask

    A Rhino management sub task for deactivating Services.

    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.

    serviceid

    Canonical name of the service to deactivate.

    Only required/allowed if the component nested element is not present.

    nodes

    Comma-separated list of node IDs on which the service should be deactivated.

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

    Parameters available as nested elements
    Element Description Required

    component

    Identifies the service to deactivate. See SleeComponentElement

    Only required/allowed if the serviceid attribute is not present.

    NonFatalBuildException throw conditions
    • The task is run targeting a service which is not active.

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

    • Constructor Detail

      • DeactivateServiceTask

        public DeactivateServiceTask()
    • Method Detail

      • execute

        protected void execute()
                        throws org.apache.tools.ant.BuildException
        Specified by:
        execute in class AbstractBaseTask
        Throws:
        org.apache.tools.ant.BuildException