Interface Logger

All Known Implementing Classes:
LoggerImpl

public interface Logger
Logging utilities class
Since:
2.0.7.0
  • Method Details

    • getChannel

      LoggerChannel getChannel(String name)
      Create a normal logging channel. Multiple calls to this method with the same name parameter results in different channels.
      Parameters:
      name - Name of LoggerChannel
      Returns:
      a new LoggerChannel
      Since:
      2.0.7.0
    • getTimeStampedChannel

      LoggerChannel getTimeStampedChannel(String name)
      Create a timestamped logging channel. Multiple calls to this method with the same name parameter results in different channels.
      Parameters:
      name - Name of LoggerChannel
      Returns:
      a new LoggerChannel
      Since:
      2.3.0.0
    • getNullChannel

      LoggerChannel getNullChannel(String name)
      Create a logger channel that doesn't output to the standard AZ log. Add listeners to it if output needs to be routed somewhere. Multiple calls to this method with the same name parameter results in different channels
      Parameters:
      name - Name of LoggerChannel
      Returns:
      a new LoggerChannel
      Since:
      2.3.0.0
    • getChannels

      LoggerChannel[] getChannels()
      Retrieve all the channels that have been created for all plugins.
      Returns:
      Array of LoggerChannel objects
      Since:
      2.1.0.0
    • getPluginInterface

      PluginInterface getPluginInterface()
      Retrieve the PluginInterface
      Returns:
      PluginInterface object
      Since:
      2.3.0.0
    • addAlertListener

      void addAlertListener(LoggerAlertListener listener)
      Add LoggerAlertListener for all alerts raised. It might be a better idea to use addAlertListener(LogAlertListener), as it is more flexible.
      Parameters:
      listener - Listener to add
      Since:
      2.3.0.6
      See Also:
    • removeAlertListener

      void removeAlertListener(LoggerAlertListener listener)
      Remove previously added AlertListener.
      Parameters:
      listener - LoggerAlertListener to remove
      Since:
      2.3.0.6
    • addAlertListener

      void addAlertListener(LogAlertListener listener)
      Add a listener to be informed of any alerts to be displayed to users.
      Since:
      3.1.1.1
    • removeAlertListener

      void removeAlertListener(LogAlertListener listener)
      Remove a previously added alert listener.
      Since:
      3.1.1.1
    • addFileLoggingListener

      void addFileLoggingListener(FileLoggerAdapter listener)
    • removeFileLoggingListener

      void removeFileLoggingListener(FileLoggerAdapter listener)