DefaultPropertiesLoader (ppm-logging 1.0.0 API)

java.lang.Object
- com.ppm.logging.configuration.DefaultPropertiesLoader

All Implemented Interfaces:: PropertiesLoader

public class DefaultPropertiesLoader
extends java.lang.Object
implements PropertiesLoader

Default Configuration Properties Loader

Constructor Summary

Constructors
Constructor and Description

DefaultPropertiesLoader()

DefaultPropertiesLoader(java.util.Properties properties)

Constructors
Constructor and Description
`DefaultPropertiesLoader()`
`DefaultPropertiesLoader(java.util.Properties properties)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getConsoleIgnoreExceptions()` Should Console Logging Ignore Exceptions?
`org.apache.logging.log4j.Level`	`getConsoleLevel()` Get Console Log Level It can be: ALL TRACE DEBUG INFO WARN ERROR FATAL OFF - Custom log levels will be disabled at this project moment.
`java.util.List<java.lang.String>`	`getConsolePackages()` Get a List of Packages to configure the Log Hierarchy.
`java.lang.String`	`getConsolePatternLayout()` Gets Console Pattern Layout.
`java.lang.String`	`getConsoleTarget()` Output Stream for Console Logger. Can be Either "SYSTEM_OUT" or "SYSTEM_ERR".
`java.lang.Boolean`	`getCreateFileOnDemand()` Get the Create File On Demand property.
`java.lang.Boolean`	`getFileAppend()` Get the file append property.
`org.apache.logging.log4j.Level`	`getFileLevel()` Get File Log Level It can be: ALL TRACE DEBUG INFO WARN ERROR FATAL OFF - Custom log levels will be disabled at this project moment.
`java.util.List<java.lang.String>`	`getFilePackages()` Get a List of Packages to configure the Log Hierarchy.
`java.lang.String`	`getFilePattern()` Get the file archiving pattern.
`java.lang.String`	`getFilePatternLayout()` Gets File Pattern Layout.
`org.apache.logging.log4j.Level`	`getRemoteLevel()` Get Remote Log Level It can be: ALL TRACE DEBUG INFO WARN ERROR FATAL OFF - Custom log levels will be disabled at this project moment.
`java.util.List<java.lang.String>`	`getRemotePackages()` Get a List of Packages to configure the Log Hierarchy.
`java.lang.String`	`getRemotePatternLayout()` Gets Remote Pattern Layout.
`org.apache.logging.log4j.Level`	`getRootLevel()` Get Root Log Level It can be: ALL TRACE DEBUG INFO WARN ERROR FATAL OFF - Custom log levels will be disabled at this project moment.
`java.lang.Boolean`	`isConsoleEnabled()` It Should console logging be enabled?
`java.lang.Boolean`	`isFileEnabled()` It Should console logging be enabled?
`java.lang.Boolean`	`isRemoteEnabled()` It Should Remote logging be enabled?

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ppm.logging.configuration.PropertiesLoader
get

- Constructor Detail
  - DefaultPropertiesLoader
```
public DefaultPropertiesLoader()
```
  - DefaultPropertiesLoader
```
public DefaultPropertiesLoader(java.util.Properties properties)
```
- Method Detail
  - getRootLevel
```
public org.apache.logging.log4j.Level getRootLevel()
```
    Description copied from interface: PropertiesLoader
    
    Get Root Log Level
    
    It can be: ALL TRACE DEBUG INFO WARN ERROR FATAL OFF - Custom log levels will be disabled at this project moment.
    
    Specified by:
    
    getRootLevel in interface PropertiesLoader
    
    Returns:
    
    an Event Level.
    
    See Also:
    
    log4j/2.0/manual/architecture.html
  - isConsoleEnabled
```
public java.lang.Boolean isConsoleEnabled()
```
    Description copied from interface: PropertiesLoader
    
    It Should console logging be enabled?
    
    Specified by:
    
    isConsoleEnabled in interface PropertiesLoader
    
    Returns:
    
    true or false
  - getConsoleLevel
```
public org.apache.logging.log4j.Level getConsoleLevel()
```
    Description copied from interface: PropertiesLoader
    
    Get Console Log Level
    
    It can be: ALL TRACE DEBUG INFO WARN ERROR FATAL OFF - Custom log levels will be disabled at this project moment.
    
    Specified by:
    
    getConsoleLevel in interface PropertiesLoader
    
    Returns:
    
    an Event Level.
    
    See Also:
    
    log4j/2.0/manual/architecture.html
  - getConsolePackages
```
public java.util.List<java.lang.String> getConsolePackages()
```
    Description copied from interface: PropertiesLoader
    
    Get a List of Packages to configure the Log Hierarchy.
    By default The logger engine will consider the same pattern from log4j.
    For example, the LoggerConfig named "com.foo" is a parent of the LoggerConfig named "com.foo.Bar". Similarly,"java" is a parent of "java.util" and an ancestor of "java.util.Vector".
    This naming scheme should be familiar to most developers.
    
    Specified by:
    
    getConsolePackages in interface PropertiesLoader
    
    Returns:
    
    a List of String representing packages Namespaces
    
    See Also:
    
    log4j/2.x/manual/architecture.html
  - getConsolePatternLayout
```
public java.lang.String getConsolePatternLayout()
```
    Description copied from interface: PropertiesLoader
    
    Gets Console Pattern Layout.
    More often than not, users wish to customize not only the output destination but also the output format. This is accomplished by associating a Layout with an Appender. The Layout is responsible for formatting the LogEvent according to the user's wishes, whereas an appender takes care of sending the formatted output to its destination.
    
    Specified by:
    
    getConsolePatternLayout in interface PropertiesLoader
    
    Returns:
    
    a Pattern Layout String
    
    See Also:
    
    log4j/2.x/manual/layouts.html
  - getConsoleIgnoreExceptions
```
public java.lang.String getConsoleIgnoreExceptions()
```
    Description copied from interface: PropertiesLoader
    
    Should Console Logging Ignore Exceptions?
    The default is true, causing exceptions encountered while appending events to be internally logged and then ignored. When set to false exceptions will be propagated to the caller, instead. You must set this to false when wrapping this Appender in a FailoverAppender.
    
    Specified by:
    
    getConsoleIgnoreExceptions in interface PropertiesLoader
    
    Returns:
    
    Return a String "true" or "false" values, if you return something different from "true" or "false" the DefaultConfigurationFactory will consider as "true".
  - getConsoleTarget
```
public java.lang.String getConsoleTarget()
```
    Description copied from interface: PropertiesLoader
    
    Output Stream for Console Logger.
    Can be Either "SYSTEM_OUT" or "SYSTEM_ERR". The default is "SYSTEM_OUT".
    
    Specified by:
    
    getConsoleTarget in interface PropertiesLoader
    
    Returns:
    
    a String
  - isFileEnabled
```
public java.lang.Boolean isFileEnabled()
```
    Description copied from interface: PropertiesLoader
    
    It Should console logging be enabled?
    
    Specified by:
    
    isFileEnabled in interface PropertiesLoader
    
    Returns:
    
    true or false
  - getFileLevel
```
public org.apache.logging.log4j.Level getFileLevel()
```
    Description copied from interface: PropertiesLoader
    
    Get File Log Level
    
    It can be: ALL TRACE DEBUG INFO WARN ERROR FATAL OFF - Custom log levels will be disabled at this project moment.
    
    Specified by:
    
    getFileLevel in interface PropertiesLoader
    
    Returns:
    
    an Event Level.
    
    See Also:
    
    log4j/2.0/manual/architecture.html
  - getFilePackages
```
public java.util.List<java.lang.String> getFilePackages()
```
    Description copied from interface: PropertiesLoader
    
    Get a List of Packages to configure the Log Hierarchy.
    By default The logger engine will consider the same pattern from log4j.
    For example, the LoggerConfig named "com.foo" is a parent of the LoggerConfig named "com.foo.Bar". Similarly,"java" is a parent of "java.util" and an ancestor of "java.util.Vector".
    This naming scheme should be familiar to most developers.
    
    Specified by:
    
    getFilePackages in interface PropertiesLoader
    
    Returns:
    
    a List of String representing packages Namespaces
    
    See Also:
    
    log4j/2.x/manual/architecture.html
  - getFilePatternLayout
```
public java.lang.String getFilePatternLayout()
```
    Description copied from interface: PropertiesLoader
    
    Gets File Pattern Layout.
    More often than not, users wish to customize not only the output destination but also the output format. This is accomplished by associating a Layout with an Appender. The Layout is responsible for formatting the LogEvent according to the user's wishes, whereas an appender takes care of sending the formatted output to its destination.
    
    Specified by:
    
    getFilePatternLayout in interface PropertiesLoader
    
    Returns:
    
    a Pattern Layout String
    
    See Also:
    
    log4j/2.x/manual/layouts.html
  - getFileAppend
```
public java.lang.Boolean getFileAppend()
```
    Description copied from interface: PropertiesLoader
    
    Get the file append property.
    When true - the default, records will be appended to the end of the file. When set to false, the file will be cleared before new records are written.
    
    Specified by:
    
    getFileAppend in interface PropertiesLoader
    
    Returns:
    
    true or false
  - getCreateFileOnDemand
```
public java.lang.Boolean getCreateFileOnDemand()
```
    Description copied from interface: PropertiesLoader
    
    Get the Create File On Demand property.
    The appender creates the file on-demand. The appender only creates the file when a log event passes all filters and is routed to this appender. Defaults to false.
    
    Specified by:
    
    getCreateFileOnDemand in interface PropertiesLoader
    
    Returns:
    
    true or false
  - getFilePattern
```
public java.lang.String getFilePattern()
```
    Description copied from interface: PropertiesLoader
    
    Get the file archiving pattern.
    The pattern of the file name of the archived log file Example: .yyyy-MM-dd This pattern will depends on file systems grow policies.
    
    Specified by:
    
    getFilePattern in interface PropertiesLoader
    
    Returns:
    
    a String representing the pattern
  - isRemoteEnabled
```
public java.lang.Boolean isRemoteEnabled()
```
    Description copied from interface: PropertiesLoader
    
    It Should Remote logging be enabled?
    
    Specified by:
    
    isRemoteEnabled in interface PropertiesLoader
    
    Returns:
    
    true or false
  - getRemoteLevel
```
public org.apache.logging.log4j.Level getRemoteLevel()
```
    Description copied from interface: PropertiesLoader
    
    Get Remote Log Level
    
    It can be: ALL TRACE DEBUG INFO WARN ERROR FATAL OFF - Custom log levels will be disabled at this project moment.
    
    Specified by:
    
    getRemoteLevel in interface PropertiesLoader
    
    Returns:
    
    an Event Level.
    
    See Also:
    
    log4j/2.0/manual/architecture.html
  - getRemotePackages
```
public java.util.List<java.lang.String> getRemotePackages()
```
    Description copied from interface: PropertiesLoader
    
    Get a List of Packages to configure the Log Hierarchy.
    By default The logger engine will consider the same pattern from log4j.
    For example, the LoggerConfig named "com.foo" is a parent of the LoggerConfig named "com.foo.Bar". Similarly,"java" is a parent of "java.util" and an ancestor of "java.util.Vector".
    This naming scheme should be familiar to most developers.
    
    Specified by:
    
    getRemotePackages in interface PropertiesLoader
    
    Returns:
    
    a List of String representing packages Namespaces
    
    See Also:
    
    log4j/2.x/manual/architecture.html
  - getRemotePatternLayout
```
public java.lang.String getRemotePatternLayout()
```
    Description copied from interface: PropertiesLoader
    
    Gets Remote Pattern Layout.
    More often than not, users wish to customize not only the output destination but also the output format. This is accomplished by associating a Layout with an Appender. The Layout is responsible for formatting the LogEvent according to the user's wishes, whereas an appender takes care of sending the formatted output to its destination.
    
    Specified by:
    
    getRemotePatternLayout in interface PropertiesLoader
    
    Returns:
    
    a Pattern Layout String
    
    See Also:
    
    log4j/2.x/manual/layouts.html

Class DefaultPropertiesLoader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.ppm.logging.configuration.PropertiesLoader

Constructor Detail

DefaultPropertiesLoader

DefaultPropertiesLoader

Method Detail

getRootLevel

isConsoleEnabled

getConsoleLevel

getConsolePackages

getConsolePatternLayout

getConsoleIgnoreExceptions

getConsoleTarget

isFileEnabled

getFileLevel

getFilePackages

getFilePatternLayout

getFileAppend

getCreateFileOnDemand

getFilePattern

isRemoteEnabled

getRemoteLevel

getRemotePackages

getRemotePatternLayout