Package co.ecg.alpaca.toolkit

Class AlpacaLogger

  • public class AlpacaLogger
extends Object
    Logger Factory for Alpaca Loggers. User Loggers allow logging based on the UserID of the signed in BroadWorks user. This allows status updates to be available on a per user basis.
    Author:
    Matthew Keathley on 6/5/15

    • Field Detail

      • CLIENT

        public static final ch.qos.logback.classic.Level CLIENT

    • Constructor Detail

      • AlpacaLogger

        public AlpacaLogger()

    • Method Detail

      • addAppenderToSessionLogger

        public static void addAppenderToSessionLogger​(ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent> appender,
                                              BroadWorksServer bws)
        Adds the given appender to the logger for the BroadWorks session.
        Parameters:
        appender - The appender to attach
        bws - The BroadWorksServer for the session

      • getSessionLogger

        public static org.slf4j.Logger getSessionLogger​(BroadWorksServer bws)
        Get a logger for the specified BroadWorksServer connection
        Parameters:
        bws - The BroadWorksServer connection to retrieve the logger
        Returns:
        The session logger for the connection

      • getSessionLogger

        public static org.slf4j.Logger getSessionLogger​(BroadWorksServer bws,
                                                Class<?> clazz)
        Get a logger for the specified BroadWorksServer connection and Java class
        Parameters:
        bws - The BroadWorksServer connection to retrieve the logger
        clazz - The Class sublogger specification
        Returns:
        The session logger for the connection

      • getSessionLogger

        public static org.slf4j.Logger getSessionLogger​(String sessionId)
        Get a logger for the specified sessionId -- This can be for the BroadWorksServer or for a web server. It is intended to be unique to allow for client side status logging.
        Parameters:
        sessionId - The sessionId to retrieve the logger
        Returns:
        The session logger

      • getSessionLogger

        public static org.slf4j.Logger getSessionLogger​(String sessionId,
                                                Class<?> clazz)
        Get a logger for the specified sessionId -- This can be for the BroadWorksServer or for a web server. It is intended to be unique to allow for client side status logging.
        Parameters:
        sessionId - The sessionId to retrieve the logger
        clazz - The Class sublogger specification
        Returns:
        The session logger

      • removeAppenderFromSessionLogger

        public static void removeAppenderFromSessionLogger​(ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent> appender,
                                                   BroadWorksServer bws)
        Removes the given appender from the logger for the BroadWorks session.
        Parameters:
        appender - The appender to attach
        bws - The BroadWorksServer for the session