Class LogReformatter

  • All Implemented Interfaces:
    Reformatter

    public class LogReformatter
    extends java.lang.Object
    implements Reformatter
    LogReformatter can produce a formatted log message using a set of context data. The available formatting strings are:
    %user,%node,%command,%level,%message. Each string maps to the same string in the input context, e.g. %user to "user". The special "%message" context item will be replaced with the input message.
    Example format string: [%user@%node %command][%level] %message
    • Constructor Summary

      Constructors 
      Constructor Description
      LogReformatter​(java.lang.String format, MapGenerator<java.lang.String,​java.lang.String> generator)
      Create a LogFormatter with specified format and object to generate context data
      LogReformatter​(java.lang.String format, java.util.Map<java.lang.String,​java.lang.String> data)
      Create a LogFormatter with specified format and static context data.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getHead()  
      java.lang.String getTail()  
      java.lang.String reformat​(java.util.Map<java.lang.String,​java.lang.String> context, java.lang.String message)
      Combines the context data, and the local static or dynamic context data, and reformats the message
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • LogReformatter

        public LogReformatter​(java.lang.String format,
                              java.util.Map<java.lang.String,​java.lang.String> data)
        Create a LogFormatter with specified format and static context data.
        Parameters:
        format - the format string
        data - the data
      • LogReformatter

        public LogReformatter​(java.lang.String format,
                              MapGenerator<java.lang.String,​java.lang.String> generator)
        Create a LogFormatter with specified format and object to generate context data
        Parameters:
        format - the format string
        generator - generator of the data
    • Method Detail

      • getTail

        public java.lang.String getTail()
        Specified by:
        getTail in interface Reformatter
      • getHead

        public java.lang.String getHead()
        Specified by:
        getHead in interface Reformatter
      • reformat

        public java.lang.String reformat​(java.util.Map<java.lang.String,​java.lang.String> context,
                                         java.lang.String message)
        Combines the context data, and the local static or dynamic context data, and reformats the message
        Specified by:
        reformat in interface Reformatter
        Parameters:
        context - input data
        message - message string
        Returns:
        reformatted message string