Class SetRAEntityStoppingPriorityTask

  • All Implemented Interfaces:
    SubTask

    public class SetRAEntityStoppingPriorityTask
    extends RAEntityBasedTask

    A Rhino management sub task for setting the stopping priority of a Resource Adaptor Entity.

    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 update.

    Yes.

    priority

    The new stopping priority for the resource adaptor entity. Must be between -128 and 127. Higher priority values have precedence over lower priority values.

    Yes.

    NonFatalBuildException throw conditions
    • This task will never throw a NonFatalBuildException. It will always fail (throw a BuildException) on errors.

    • Constructor Detail

      • SetRAEntityStoppingPriorityTask

        public SetRAEntityStoppingPriorityTask()
    • 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
      • setPriority

        public void setPriority​(byte priority)