Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM copyright notice field.

  See Also:

  Constant Field Values

Constructor Detail

• LogConfigurationTask

  public LogConfigurationTask()
  

  This is the default constructor for this class. It calls the constructor from the superclass.

Method Detail

• execute

  public void execute()
               throws org.apache.tools.ant.BuildException
  

  This method initializes the EC log and trace configuration.

  Overrides:

  execute in class org.apache.tools.ant.Task

  Throws:

  org.apache.tools.ant.BuildException - This is thrown if there is an error when configuring logging and trace.

  See Also:

  Task.execute()

• getConfigurationFile

  public java.lang.String getConfigurationFile()
  

  This method gets the configuration file that contains the log system configuration.

  Returns:

  This method returns the configuration file.

• getFileDateStamped

  public java.lang.String getFileDateStamped()
  

  This method gets whether the file should be created with a date stamp.

  Returns:

  This method returns true if a date stamp is required.

• getLogFile

  public java.lang.String getLogFile()
  

  This method gets the name of the log file.

  Returns:

  This method returns the name of the log file.

• getLogFileSize

  public java.lang.String getLogFileSize()
  

  This method gets the maximum size of the log file.

  Returns:

  This method returns the maximum size of the log file.

• getLogSeverity

  public java.lang.String getLogSeverity()
  

  This method gets the log severities to record.

  Returns:

  This method returns the log severities. This is a comma separated list that contains all the log severities to record.

• getNotificationClassName

  public java.lang.String getNotificationClassName()
  

  This method gets the notification class name.

  Returns:

  This method returns the notification class name.

• getNotificationEnabled

  public java.lang.String getNotificationEnabled()
  

  This method gets whether notification is enabled.

  Returns:

  This method returns true if notification is enabled.

• getTraceComponents

  public java.lang.String getTraceComponents()
  

  This method gets the different tracing component to trace.

  Returns:

  This method returns the enabled tracing components. This is a comma separated list that contains all the tracing components to enable.

• getTraceFile

  public java.lang.String getTraceFile()
  

  This method gets the name of the trace file.

  Returns:

  This method returns the name of the trace file.

• getTraceFileSize

  public java.lang.String getTraceFileSize()
  

  This method gets the maximum size of the trace file.

  Returns:

  This method returns the maximum size of the trace file.

• setConfigurationFile

  public void setConfigurationFile(java.lang.String configurationFile)
  

  This method sets the name of the configuration file that contains the log system configuration.

  Parameters:

  configurationFile - This is the name configuration file.

• setFileDateStamped

  public void setFileDateStamped(java.lang.String fileDateStamped)
  

  This method sets whether the date should be appended when the file is created.

  Parameters:

  fileDateStamped - This is a boolean value; true if the date should be appended and false otherwise.

• setLogFile

  public void setLogFile(java.lang.String logFile)
  

  This method sets the name of the log file.

  Parameters:

  logFile - This is the name of the log file.

• setLogFileSize

  public void setLogFileSize(java.lang.String fileSize)
  

  This method sets the maximum log file size.

  Parameters:

  fileSize - This is the maxiumum log file size.

• setLogSeverity

  public void setLogSeverity(java.lang.String logSeverity)
  

  This method sets the log severities to record.

  Parameters:

  logSeverity - This is the log severity. This is a comma separated list that contains all the log severities to record.

• setNotificationClassName

  public void setNotificationClassName(java.lang.String notificationClassName)
  

  This method sets the notification class name that is used to send notifications.

  Parameters:

  notificationClassName - This is the notification class name.

• setNotificationEnabled

  public void setNotificationEnabled(java.lang.String enabled)
  

  This method sets whether notification is enabled.

  Parameters:

  enabled - This is a boolean value; true if notification is enabled and false otherwise.

• setTraceComponents

  public void setTraceComponents(java.lang.String traceComponents)
  

  This method sets the tracing components to enable.

  Parameters:

  traceComponents - This is an object that represents the tracing components. This is a comma separated list that contains all the tracing components to enable.

• setTraceFile

  public void setTraceFile(java.lang.String traceFile)
  

  This method sets the name of the trace file.

  Parameters:

  traceFile - This is the trace file name.

• setTraceFileSize

  public void setTraceFileSize(java.lang.String traceFileSize)
  

  This method sets the maximum size of the trace file.

  Parameters:

  traceFileSize - This is the maximum trace file size.