Package com.ibm.di.plugin.log

Class PWSyncLog

  • public class PWSyncLog
extends java.lang.Object
    This is the common log class used by all of the Proxy Components.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.ibm.icu.text.DateFormat dateFormat  
      protected boolean debug  
      protected java.io.PrintWriter log  
      protected boolean logOpen  

    • Constructor Summary

      Constructors 
      Constructor Description
      PWSyncLog​(java.io.OutputStream os, java.lang.String charSet, boolean debug)
      Creates a instance of the PWSyncLog class.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()  
      void debug​(java.lang.String msg)  
      void debug​(java.lang.String prefix, java.lang.String msg)  
      void error​(java.lang.String msg)  
      void error​(java.lang.String prefix, java.lang.String msg)  
      void error​(java.lang.String prefix, java.lang.String msg, java.lang.Throwable error)  
      void error​(java.lang.String msg, java.lang.Throwable error)  
      protected java.lang.String getDateTime()  
      static PWSyncLog getLogForFile​(java.lang.String file, java.lang.String charSet, boolean debug)
      Open the specified file for logging.
      static PWSyncLog getLogForFile​(java.lang.String file, java.lang.String charSet, boolean debug, java.lang.String rotatePattern)
      Open the specified file for logging.
      java.io.PrintWriter getPrintWriter()  
      void info​(java.lang.String msg)  
      void info​(java.lang.String prefix, java.lang.String msg)  
      boolean isOpen()  
      protected void log​(java.lang.String prefix, java.lang.String level, java.lang.String msg)  
      void plain​(java.lang.String msg)  
      protected void printStackTrace​(java.lang.Throwable error)  
      void setDebug​(boolean debug)  
      void warn​(java.lang.String msg)  
      void warn​(java.lang.String prefix, java.lang.String msg)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • debug

        protected boolean debug

      • log

        protected java.io.PrintWriter log

      • logOpen

        protected boolean logOpen

      • dateFormat

        protected com.ibm.icu.text.DateFormat dateFormat

    • Constructor Detail

      • PWSyncLog

        public PWSyncLog​(java.io.OutputStream os,
                 java.lang.String charSet,
                 boolean debug)
        Creates a instance of the PWSyncLog class.
        Parameters:
        os - the output stream to which to log. If this is null no attempt to open a stream will be made.
        charSet - the character set name used for encoding the stream.
        debug - "To Debug, Or Not? ...That is the question.

    • Method Detail

      • getDateTime

        protected java.lang.String getDateTime()

      • log

        protected void log​(java.lang.String prefix,
                   java.lang.String level,
                   java.lang.String msg)

      • plain

        public void plain​(java.lang.String msg)

      • error

        public void error​(java.lang.String prefix,
                  java.lang.String msg)

      • error

        public void error​(java.lang.String msg)

      • error

        public void error​(java.lang.String prefix,
                  java.lang.String msg,
                  java.lang.Throwable error)

      • error

        public void error​(java.lang.String msg,
                  java.lang.Throwable error)

      • debug

        public void debug​(java.lang.String prefix,
                  java.lang.String msg)

      • debug

        public void debug​(java.lang.String msg)

      • info

        public void info​(java.lang.String prefix,
                 java.lang.String msg)

      • info

        public void info​(java.lang.String msg)

      • warn

        public void warn​(java.lang.String prefix,
                 java.lang.String msg)

      • warn

        public void warn​(java.lang.String msg)

      • close

        public void close()

      • isOpen

        public boolean isOpen()

      • setDebug

        public void setDebug​(boolean debug)

      • getLogForFile

        public static PWSyncLog getLogForFile​(java.lang.String file,
                                      java.lang.String charSet,
                                      boolean debug)
                               throws java.io.FileNotFoundException
        Open the specified file for logging.
        Parameters:
        file - the file path to use.
        charSet - the encoding to output to. If this is null the default encoding would be used ()
        debug - if true more verbose messages will be printed
        Returns:
        an instance of the PWSyncLog class.
        Throws:
        java.io.FileNotFoundException - if the file path could not be resolved.

      • getPrintWriter

        public java.io.PrintWriter getPrintWriter()

      • printStackTrace

        protected void printStackTrace​(java.lang.Throwable error)

      • getLogForFile

        public static PWSyncLog getLogForFile​(java.lang.String file,
                                      java.lang.String charSet,
                                      boolean debug,
                                      java.lang.String rotatePattern)
                               throws java.io.FileNotFoundException
        Open the specified file for logging.
        Parameters:
        file - the file path to use.
        charSet - the encoding to output to. If this is null the default encoding would be used ()
        debug - if true more verbose messages will be printed
        rotatePattern - The pattern used for rotating logs.
        Returns:
        an instance of the PWSyncLog class.
        Throws:
        java.io.FileNotFoundException - if the file path could not be resolved.