Class SetServiceMetricsRecordingEnabledTask

  • All Implemented Interfaces:
    SubTask

    public class SetServiceMetricsRecordingEnabledTask
    extends ComponentBasedTask

    A Rhino management sub task for updating the SBB metrics recording status of a service.

    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.

    enabled

    Boolean flag indicating if SBB metrics recording should be enabled (true) or disabled (false).

    Yes.

    Parameters available as nested elements
    Element Description Required

    component

    Identifies the service to update. See SleeComponentElement

    Yes.

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

    • Constructor Detail

      • SetServiceMetricsRecordingEnabledTask

        public SetServiceMetricsRecordingEnabledTask()
    • 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
      • setEnabled

        public void setEnabled​(boolean enabled)