Class RemoveAppenderRefTask

  • All Implemented Interfaces:
    SubTask

    public class RemoveAppenderRefTask
    extends AbstractBaseTask

    A Rhino management sub task for removing an appender from a log key.

    Ant Parameters
    Attribute Description Required

    logkey

    Name of the log key to remove the appender from.

    Yes.

    appendername

    Name of the appender to remove.

    Yes.

    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.

    NonFatalBuildException throw conditions
    • This task will throw a NonFatalBuildException if the appender cannot be remove from the log key, eg. the appender is not attached to the log key.

    • Constructor Detail

      • RemoveAppenderRefTask

        public RemoveAppenderRefTask()
    • 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
      • setLogKey

        public void setLogKey​(String logKey)
      • getLogKey

        public String getLogKey()
      • setAppenderName

        public void setAppenderName​(String name)
      • getAppenderName

        public String getAppenderName()