Package csw.logging.client.javadsl

Class JLoggingSystemFactory$

  • public class JLoggingSystemFactory$
extends java.lang.Object

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static JLoggingSystemFactory$ MODULE$
      Static reference to the singleton instance of this Scala object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      csw.logging.client.internal.LoggingSystem forTestingOnly​(akka.actor.typed.ActorSystem<akka.actor.typed.SpawnProtocol.Command> actorSystem)  
      csw.logging.client.internal.LoggingSystem start()
      The factory used to create the LoggingSystem.
      csw.logging.client.internal.LoggingSystem start​(java.lang.String name, java.lang.String version, java.lang.String hostName, akka.actor.typed.ActorSystem<akka.actor.typed.SpawnProtocol.Command> actorSystem)
      The factory used to create the LoggingSystem.
      csw.logging.client.internal.LoggingSystem start​(java.lang.String name, java.lang.String version, java.lang.String hostName, akka.actor.typed.ActorSystem<akka.actor.typed.SpawnProtocol.Command> actorSystem, java.util.List<LogAppenderBuilder> appenders)
      The factory used to create the LoggingSystem.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • MODULE$

        public static final JLoggingSystemFactory$ MODULE$
        Static reference to the singleton instance of this Scala object.

    • Constructor Detail

      • JLoggingSystemFactory$

        public JLoggingSystemFactory$()

    • Method Detail

      • start

        public csw.logging.client.internal.LoggingSystem start​(java.lang.String name,
                                                       java.lang.String version,
                                                       java.lang.String hostName,
                                                       akka.actor.typed.ActorSystem<akka.actor.typed.SpawnProtocol.Command> actorSystem)
        The factory used to create the LoggingSystem. LoggingSystem should be started once in an app.

        Parameters:
        name - The name of the logging system. If there is a file appender configured, then a file with this name is created on local machine.
        version - the version of the csw which will be a part of log statements
        hostName - the host address which will be a part of log statements
        actorSystem - the ActorSystem used to create LogActor from LoggingSystem
        Returns:
        the instance of LoggingSystem

      • start

        public csw.logging.client.internal.LoggingSystem start()
        The factory used to create the LoggingSystem. LoggingSystem should be started once in an app.

        Note that it is recommended to use this method only for testing

        Returns:
        the instance of LoggingSystem

      • start

        public csw.logging.client.internal.LoggingSystem start​(java.lang.String name,
                                                       java.lang.String version,
                                                       java.lang.String hostName,
                                                       akka.actor.typed.ActorSystem<akka.actor.typed.SpawnProtocol.Command> actorSystem,
                                                       java.util.List<LogAppenderBuilder> appenders)
        The factory used to create the LoggingSystem. LoggingSystem should be started once in an app.

        Note that it is recommended to use this method only for testing

        Parameters:
        name - The name of the logging system. If there is a file appender configured, then a file with this name is created on local machine.
        version - the version of the csw which will be a part of log statements
        hostName - the host address which will be a part of log statements
        actorSystem - the ActorSystem used to create LogActor from LoggingSystem
        appenders - the list of appenders given programmatically
        Returns:
        the instance of LoggingSystem

      • forTestingOnly

        public csw.logging.client.internal.LoggingSystem forTestingOnly​(akka.actor.typed.ActorSystem<akka.actor.typed.SpawnProtocol.Command> actorSystem)