Package com.acrolinx.sidebar.utils

Class LoggingUtils

  • public final class LoggingUtils
extends java.lang.Object
    Set up the integration's logging.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String getLogFileLocation()
      Retrieve the current path to the integrations log file.
      static void resetLoggingContext()
      Resets the current Logging Context.
      static void setupLogging​(java.lang.String applicationName)
      Call this method on your integration's startup.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • setupLogging

        public static void setupLogging​(java.lang.String applicationName)
                         throws java.io.IOException,
                                ch.qos.logback.core.joran.spi.JoranException
        Call this method on your integration's startup. This will initialize the logs as specified in the Acrolinx Coding Guidance.
        Parameters:
        applicationName - the integration's name e.g. AcrolinxForEditorName
        Throws:
        java.io.IOException
        ch.qos.logback.core.joran.spi.JoranException

      • getLogFileLocation

        public static java.lang.String getLogFileLocation()
        Retrieve the current path to the integrations log file. The path is OS-specific.
        Returns:
        path to the integrations logging file.

      • resetLoggingContext

        public static void resetLoggingContext()
        Resets the current Logging Context.