Package org.owasp.esapi.logging.appender

Class LogPrefixAppender

  • All Implemented Interfaces:
    LogAppender
    public class LogPrefixAppender
extends java.lang.Object
implements LogAppender
    LogAppender Implementation which can prefix the common logger information for EventType, Client data, and server data.

    • Constructor Summary

      Constructors 
      Constructor Description
      LogPrefixAppender​(boolean logUserInfo, boolean logClientInfo, boolean logServerIp, boolean logApplicationName, java.lang.String appName)
      Ctr.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String appendTo​(java.lang.String logName, Logger.EventType eventType, java.lang.String message)
      Creates a replacement Log Message and returns it to the caller.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • LogPrefixAppender

        public LogPrefixAppender​(boolean logUserInfo,
                         boolean logClientInfo,
                         boolean logServerIp,
                         boolean logApplicationName,
                         java.lang.String appName)
        Ctr.
        Parameters:
        logUserInfo - Whether or not to record user information
        logClientInfo - Whether or not to record client information
        logServerIp - Whether or not to record server ip information
        logApplicationName - Whether or not to record application name
        appName - Application Name to record.

    • Method Detail

      • appendTo

        public java.lang.String appendTo​(java.lang.String logName,
                                 Logger.EventType eventType,
                                 java.lang.String message)
        Description copied from interface: LogAppender
        Creates a replacement Log Message and returns it to the caller.
        Specified by:
        appendTo in interface LogAppender
        Parameters:
        logName - name of the logger.
        eventType - EventType of the log event being processed.
        message - The original message.
        Returns:
        Updated replacement message.