Home » apache-tomcat-6.0.26-src » org.apache » catalina » ant » [javadoc | source]
org.apache.catalina.ant
abstract public class: BaseRedirectorHelperTask [javadoc | source]
java.lang.Object
   org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
         org.apache.catalina.ant.BaseRedirectorHelperTask

All Implemented Interfaces:
    Cloneable

Abstract base class to add output redirection support for Catalina Ant tasks. These tasks require Ant 1.5 or later.
WARNING: due to depends chain, Ant could call a Task more than once and this can affect the output redirection when configured. If you are collecting the output in a property, it will collect the output of only the first run, since Ant properties are immutable and once created they cannot be changed.
If you are collecting output in a file the file will be overwritten with the output of the last run, unless you set append="true", in which case each run will append it's output to the file.
Field Summary
protected  Redirector redirector    Redirector helper 
protected  RedirectorElement redirectorElement    Redirector element for this task 
protected  OutputStream redirectOutStream    The stream for info output 
protected  OutputStream redirectErrStream    The stream for error output 
 PrintStream redirectOutPrintStream    The print stream for info output 
 PrintStream redirectErrPrintStream    The print stream for error output 
protected  boolean failOnError    Whether to fail (with a BuildException) if ManagerServlet returns an error. The default behavior is to do so. This flag does not control parameters checking. If the task is called with wrong or invalid parameters, it will throw BuildException independently from the setting of this flag. 
protected  boolean redirectOutput    true true when output redirection is requested for this task . Default is to log on Ant log. 
protected  boolean redirectorConfigured    will be set to true when the configuration of the Redirector is complete. 
protected  boolean alwaysLog    Flag which indicates that, if redirected, output should also be always sent to the log. Default is that otput is sent only to redirected streams. 
Fields inherited from org.apache.tools.ant.Task:
target,  taskName,  taskType,  wrapper
Fields inherited from org.apache.tools.ant.ProjectComponent:
project,  location,  description
Method from org.apache.catalina.ant.BaseRedirectorHelperTask Summary:
addConfiguredRedirector,   closeRedirector,   handleErrorFlush,   handleErrorOutput,   handleFlush,   handleFlush,   handleOutput,   handleOutput,   isFailOnError,   openRedirector,   setAlwaysLog,   setAppend,   setCreateEmptyFiles,   setError,   setErrorProperty,   setFailonerror,   setLogError,   setOutput,   setOutputproperty
Methods from org.apache.tools.ant.Task:
bindToOwner,   execute,   getOwningTarget,   getRuntimeConfigurableWrapper,   getTaskName,   getTaskType,   getWrapper,   handleErrorFlush,   handleErrorOutput,   handleFlush,   handleInput,   handleOutput,   init,   isInvalid,   log,   log,   log,   log,   markInvalid,   maybeConfigure,   perform,   reconfigure,   setOwningTarget,   setRuntimeConfigurableWrapper,   setTaskName,   setTaskType
Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.catalina.ant.BaseRedirectorHelperTask Detail:
 public  void addConfiguredRedirector(RedirectorElement redirectorElement) 
    Add a RedirectorElement to this task.
 protected  void closeRedirector() 
    Ask redirector to close all the streams. It is necessary to call this method before leaving the Task to have the Streams flush their contents. If you are collecting output in a property, it will be created only if this method is called, otherwise you'll find it unset.
 protected  void handleErrorFlush(String output) 
    Handles error output with the ERR priority and flushes the stream.
 protected  void handleErrorOutput(String output) 
    Handles error output with the ERR priority.
 protected  void handleFlush(String output) 
    Handles output with the INFO priority and flushes the stream.
 protected  void handleFlush(String output,
    int priority) 
    Handles output with ERR priority to error stream and all other pritorities to output stream, then flushes the stream.
 protected  void handleOutput(String output) 
    Handles output with the INFO priority.
 protected  void handleOutput(String output,
    int priority) 
    Handles output with ERR priority to error stream and all other pritorities to output stream.
 public boolean isFailOnError() 
    Returns the value of the failOnError property.
 protected  void openRedirector() 
    Set up properties on the Redirector and create output streams.
 public  void setAlwaysLog(boolean alwaysLog) 
    If true, (error and non-error) output will be redirected as specified while being sent to Ant's logging mechanism as if no redirection had taken place. Defaults to false.
    Actually handled internally, with Ant 1.6.3 it will be handled by the Redirector itself.
 public  void setAppend(boolean append) 
    If true, append output to existing file.
 public  void setCreateEmptyFiles(boolean createEmptyFiles) 
    Whether output and error files should be created even when empty. Defaults to true.
 public  void setError(File error) 
    File the error output of the task is redirected to.
 public  void setErrorProperty(String errorProperty) 
    Property name whose value should be set to the error of the task..
 public  void setFailonerror(boolean fail) 
    Whether to fail (with a BuildException) if ManagerServlet returns an error. The default behavior is to do so.
 public  void setLogError(boolean logError) 
    Controls whether error output is logged. This is only useful when output is being redirected and error output is desired in the Ant log
 public  void setOutput(File out) 
    File the output of the task is redirected to.
 public  void setOutputproperty(String outputProperty) 
    Property name whose value should be set to the output of the task.