Wombat::Logger::FileLogger - file logger class

- NAME
- SYNOPSIS
- DESCRIPTION
- CONSTRUCTOR
- ACCESSOR METHODS
- PUBLIC METHODS
- LIFECYCLE METHODS
- SEE ALSO
- AUTHOR

# NAME

Wombat::Logger::FileLogger - file logger class

# SYNOPSIS

      my $logger = Wombat::Logger::FileLogger->new();
      $logger->setFileName("/var/log/wombat/wombat.log");
      $logger->log("this will show up in the log file");

# DESCRIPTION

Convenience base class for logger implementations. The only method that must be implemented is `write()`, plus any accessor methods required for configuration.

# CONSTRUCTOR

`new()`
  Construct and return a Wombat::Logger::FileLogger instance, initializing fields appropriately. If subclasses override the constructor, they must be sure to call

        $self->SUPER::new();

# ACCESSOR METHODS

`getFilename()`
  Return the name of the file that is the log destination.

`setFilename($filename)`
  Set the name of the file that is the log destination.

  Parameters:

  $filename
    the name of the file

# PUBLIC METHODS

`write($string)`
  Write the specified string to the log destination. The default implementation does nothing. Subclasses must override this method.

  Parameters:

  $string
    the string to write to the log destination

# LIFECYCLE METHODS

`start()`
  Prepare for the beginning of active use of this Logger by opening the file.

  Throws:

  Wombat::LifecycleException
    if the file cannot be opened

`stop()`
  Gracefully terminate the active use of this Logger by closing the file.

  Throws:

  Wombat::LifecycleException
    if the file cannot be closed

# SEE ALSO

the Servlet::Util::Exception manpage, the Wombat::Logger::LoggerBase manpage

# AUTHOR

Brian Moseley, bcm@maz.org