org.eclipse.rdf4j.common.app.logging.logback

## Class LogbackConfiguration

- java.lang.Object
- - org.eclipse.rdf4j.common.app.logging.base.AbstractLogConfiguration
  - - org.eclipse.rdf4j.common.app.logging.logback.LogbackConfiguration

- All Implemented Interfaces:
    Configuration, LogConfiguration

      public class LogbackConfiguration
      extends AbstractLogConfiguration

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `LOGGING_DIR_PROPERTY`

    - ### Fields inherited from interface org.eclipse.rdf4j.common.app.logging.LogConfiguration

      `ADMIN_EVENT_LOG_FILE, ADMIN_EVENT_LOGGER_NAME, LOG_FILE, LOGGING_DIR, USER_EVENT_LOG_FILE, USER_EVENT_LOGGER_NAME`

    - ### Fields inherited from interface org.eclipse.rdf4j.common.app.config.Configuration

      `DEFAULT_RESOURCES_LOCATION, DIR, RESOURCES_LOCATION`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `LogbackConfiguration()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `destroy()` Clean up configuration resources.
    `LogReader` | `getDefaultLogReader()` Default (fallback) LogReader instance.
    `LogReader` | `getLogReader(String appender)` A reader that can read logging information as stored by the specific logger's appender.
    `void` | `init()` Initialize the configuration settings.
    `void` | `load()` Load the configuration settings.
    `void` | `save()` Store configuration settings.

    - ### Methods inherited from class org.eclipse.rdf4j.common.app.logging.base.AbstractLogConfiguration

      `getAppConfiguration, getBaseDir, getConfDir, getLoggingDir, getPackages, isDebugLoggingEnabled, setAppConfiguration, setBaseDir, setDebugLoggingEnabled`

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### LOGGING_DIR_PROPERTY

          public static final String LOGGING_DIR_PROPERTY

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### LogbackConfiguration

          public LogbackConfiguration()
                               throws IOException

      Throws:
        `IOException`

  - ### Method Detail

    - #### init

          public void init()
                    throws IOException

      Description copied from interface: `Configuration`
      Initialize the configuration settings.
      Throws:
        `IOException` - if the configuration settings could not be initialized because of an I/O problem.

    - #### load

          public void load()
                    throws IOException

      Description copied from interface: `Configuration`
      Load the configuration settings. Settings will be loaded from a user and application specific location first. If no such settings exists, an attempt will be made to retrieve settings from a resource on the classpath. If no such settings exist either, settings will be loaded from a default resource on the classpath.
      Throws:
        `IOException` - if the configuration settings could not be loaded due to an I/O problem.

    - #### save

          public void save()
                    throws IOException

      Description copied from interface: `Configuration`
      Store configuration settings. Settings will be stored in a user and application specific location.
      Throws:
        `IOException` - if the configuration settings could not be saved due to an I/O problem.

    - #### destroy

          public void destroy()

      Description copied from interface: `Configuration`
      Clean up configuration resources.

    - #### getLogReader

          public LogReader getLogReader(String appender)

      Description copied from interface: `LogConfiguration`
      A reader that can read logging information as stored by the specific logger's appender.
      Parameters:
        `appender` - Name of the appender to which the LogReader is attached
      Returns:
        a reader that can read logging information as stored by the logger configured through this LogConfiguration

    - #### getDefaultLogReader

          public LogReader getDefaultLogReader()

      Description copied from interface: `LogConfiguration`
      Default (fallback) LogReader instance.
      Returns:
        default (fallback) LogReader instance.

Copyright © 2015-2022 Eclipse Foundation. All Rights Reserved.