Module jakarta.mail
Package jakarta.mail

Class MailLogger

java.lang.Object
jakarta.mail.MailLogger

final class MailLogger extends Object
A simplified logger used by Jakarta Mail to handle logging to a PrintStream and logging through a java.util.logging.Logger. If debug is set, messages are written to the PrintStream and prefixed by the specified prefix (which is not included in Logger messages). Messages are logged by the Logger based on the configuration of the logging system.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final boolean
    Produce debug output?
    private final Logger
    For log messages.
    private final PrintStream
    Stream for debug output.
    private final String
    For debug output.
  • Constructor Summary

    Constructors
    Constructor
    Description
    MailLogger(Class<?> clazz, String prefix, boolean debug, PrintStream out)
    Construct a new MailLogger using the specified class' package name as the Logger name, debug prefix (e.g., "DEBUG"), debug flag, and PrintStream.
    MailLogger(Class<?> clazz, String prefix, Session session)
    Deprecated.
    MailLogger(Class<?> clazz, String subname, String prefix, boolean debug, PrintStream out)
    Construct a new MailLogger using the specified class' package name combined with the specified subname as the Logger name, debug prefix (e.g., "DEBUG"), debug flag, and PrintStream.
    MailLogger(String name, String prefix, boolean debug, PrintStream out)
    Construct a new MailLogger using the specified Logger name, debug prefix (e.g., "DEBUG"), debug flag, and PrintStream.
    MailLogger(String name, String prefix, Session session)
    Deprecated.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Log a message at the CONFIG level.
    private void
    Common formatting for debug output.
    void
    fine(String msg)
    Log a message at the FINE level.
    void
    Log a message at the FINER level.
    void
    Log a message at the FINEST level.
    getLogger(Class<?> clazz, String prefix)
    Create a MailLogger using the specified class' package name as the Logger name and the specified prefix.
    getLogger(String name, String prefix)
    Create a MailLogger that uses a Logger with the specified name and prefix.
    getSubLogger(String subname, String prefix)
    Create a MailLogger that uses a Logger whose name is composed of this MailLogger's name plus the specified sub-name, separated by a dot.
    getSubLogger(String subname, String prefix, boolean debug)
    Create a MailLogger that uses a Logger whose name is composed of this MailLogger's name plus the specified sub-name, separated by a dot.
    private void
    Common code to conditionally log debug statements.
    A disadvantage of not being able to use Logger directly in Jakarta Mail code is that the "source class" information that Logger guesses will always refer to this class instead of our caller.
    boolean
    If "debug" is set, or our embedded Logger is loggable at the given level, return true.
    private boolean
    Frames to ignore as part of the MailLogger to JUL bridge.
    void
    log(Level level, String msg)
    Log the message at the specified level.
    void
    log(Level level, String msg, Object param1)
    Log the message at the specified level.
    void
    log(Level level, String msg, Object... params)
    Log the message at the specified level.
    void
    log(Level level, String msg, Throwable thrown)
    Log the message at the specified level.
    void
    logf(Level level, String msg, Object... params)
    Log the message at the specified level using a format string.
    private String
    packageOf(Class<?> clazz)
    Return the package name of the class.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • logger

      private final Logger logger
      For log messages.
    • prefix

      private final String prefix
      For debug output.
    • debug

      private final boolean debug
      Produce debug output?
    • out

      private final PrintStream out
      Stream for debug output.
  • Constructor Details

    • MailLogger

      public MailLogger(String name, String prefix, boolean debug, PrintStream out)
      Construct a new MailLogger using the specified Logger name, debug prefix (e.g., "DEBUG"), debug flag, and PrintStream.
      Parameters:
      name - the Logger name
      prefix - the prefix for debug output, or null for none
      debug - if true, write to PrintStream
      out - the PrintStream to write to
    • MailLogger

      public MailLogger(Class<?> clazz, String prefix, boolean debug, PrintStream out)
      Construct a new MailLogger using the specified class' package name as the Logger name, debug prefix (e.g., "DEBUG"), debug flag, and PrintStream.
      Parameters:
      clazz - the Logger name is the package name of this class
      prefix - the prefix for debug output, or null for none
      debug - if true, write to PrintStream
      out - the PrintStream to write to
    • MailLogger

      public MailLogger(Class<?> clazz, String subname, String prefix, boolean debug, PrintStream out)
      Construct a new MailLogger using the specified class' package name combined with the specified subname as the Logger name, debug prefix (e.g., "DEBUG"), debug flag, and PrintStream.
      Parameters:
      clazz - the Logger name is the package name of this class
      subname - the Logger name relative to this Logger name
      prefix - the prefix for debug output, or null for none
      debug - if true, write to PrintStream
      out - the PrintStream to write to
    • MailLogger

      @Deprecated public MailLogger(String name, String prefix, Session session)
      Deprecated.
      Construct a new MailLogger using the specified Logger name and debug prefix (e.g., "DEBUG"). Get the debug flag and PrintStream from the Session.
      Parameters:
      name - the Logger name
      prefix - the prefix for debug output, or null for none
      session - where to get the debug flag and PrintStream
    • MailLogger

      @Deprecated public MailLogger(Class<?> clazz, String prefix, Session session)
      Deprecated.
      Construct a new MailLogger using the specified class' package name as the Logger name and the specified debug prefix (e.g., "DEBUG"). Get the debug flag and PrintStream from the Session.
      Parameters:
      clazz - the Logger name is the package name of this class
      prefix - the prefix for debug output, or null for none
      session - where to get the debug flag and PrintStream
  • Method Details

    • getLogger

      public MailLogger getLogger(String name, String prefix)
      Create a MailLogger that uses a Logger with the specified name and prefix. The new MailLogger uses the same debug flag and PrintStream as this MailLogger.
      Parameters:
      name - the Logger name
      prefix - the prefix for debug output, or null for none
      Returns:
      a MailLogger for the given name and prefix.
    • getLogger

      public MailLogger getLogger(Class<?> clazz, String prefix)
      Create a MailLogger using the specified class' package name as the Logger name and the specified prefix. The new MailLogger uses the same debug flag and PrintStream as this MailLogger.
      Parameters:
      clazz - the Logger name is the package name of this class
      prefix - the prefix for debug output, or null for none
      Returns:
      a MailLogger for the given name and prefix.
    • getSubLogger

      public MailLogger getSubLogger(String subname, String prefix)
      Create a MailLogger that uses a Logger whose name is composed of this MailLogger's name plus the specified sub-name, separated by a dot. The new MailLogger uses the new prefix for debug output. This is used primarily by the protocol trace code that wants a different prefix (none).
      Parameters:
      subname - the Logger name relative to this Logger name
      prefix - the prefix for debug output, or null for none
      Returns:
      a MailLogger for the given name and prefix.
    • getSubLogger

      public MailLogger getSubLogger(String subname, String prefix, boolean debug)
      Create a MailLogger that uses a Logger whose name is composed of this MailLogger's name plus the specified sub-name, separated by a dot. The new MailLogger uses the new prefix for debug output. This is used primarily by the protocol trace code that wants a different prefix (none).
      Parameters:
      subname - the Logger name relative to this Logger name
      prefix - the prefix for debug output, or null for none
      debug - the debug flag for the sub-logger
      Returns:
      a MailLogger for the given name and prefix.
    • log

      public void log(Level level, String msg)
      Log the message at the specified level.
      Parameters:
      level - the log level.
      msg - the message.
    • log

      public void log(Level level, String msg, Object param1)
      Log the message at the specified level.
      Parameters:
      level - the log level.
      msg - the message.
      param1 - the additional parameter.
    • log

      public void log(Level level, String msg, Object... params)
      Log the message at the specified level.
      Parameters:
      level - the log level.
      msg - the message.
      params - the message parameters.
    • logf

      public void logf(Level level, String msg, Object... params)
      Log the message at the specified level using a format string.
      Parameters:
      level - the log level.
      msg - the message format string.
      params - the message parameters.
      Since:
      JavaMail 1.5.4
    • log

      public void log(Level level, String msg, Throwable thrown)
      Log the message at the specified level.
      Parameters:
      level - the log level.
      msg - the message.
      thrown - the throwable to log.
    • config

      public void config(String msg)
      Log a message at the CONFIG level.
      Parameters:
      msg - the message.
    • fine

      public void fine(String msg)
      Log a message at the FINE level.
      Parameters:
      msg - the message.
    • finer

      public void finer(String msg)
      Log a message at the FINER level.
      Parameters:
      msg - the message.
    • finest

      public void finest(String msg)
      Log a message at the FINEST level.
      Parameters:
      msg - the message.
    • isLoggable

      public boolean isLoggable(Level level)
      If "debug" is set, or our embedded Logger is loggable at the given level, return true.
      Parameters:
      level - the log level.
      Returns:
      true if loggable.
    • ifDebugOut

      private void ifDebugOut(String msg)
      Common code to conditionally log debug statements.
      Parameters:
      msg - the message to log.
    • debugOut

      private void debugOut(String msg)
      Common formatting for debug output.
      Parameters:
      msg - the message to log.
    • packageOf

      private String packageOf(Class<?> clazz)
      Return the package name of the class. Sometimes there will be no Package object for the class, e.g., if the class loader hasn't created one (see Class.getPackage()).
      Parameters:
      clazz - the class source.
      Returns:
      the package name or an empty string.
    • inferCaller

      private StackTraceElement inferCaller()
      A disadvantage of not being able to use Logger directly in Jakarta Mail code is that the "source class" information that Logger guesses will always refer to this class instead of our caller. This method duplicates what Logger does to try to find *our* caller, so that Logger doesn't have to do it (and get the wrong answer), and because our caller is what's wanted.
      Returns:
      StackTraceElement that logged the message. Treat as read-only.
    • isLoggerImplFrame

      private boolean isLoggerImplFrame(String cname)
      Frames to ignore as part of the MailLogger to JUL bridge.
      Parameters:
      cname - the class name.
      Returns:
      true if the class name is part of the MailLogger bridge.