Package org.apache.logging.log4j.core.impl

Record Class CoreProperties.ConfigurationProperties

java.lang.Object
java.lang.Record
org.apache.logging.log4j.core.impl.CoreProperties.ConfigurationProperties
Record Components:
allowedProtocols - The protocols allowed for the configuration location.
clock - A custom Clock implementation to use to timestamp log events. The supported values are:
  • SystemMillisClock
  • CachedClock
  • CoarseCachedClock

If null, the system clock will be used.

factory - The ConfigurationFactory to use or null for the default one.
level - The default level of the root logger.
location - The location (file path or URI) of the configuration file. If null a standard set of locations is used.
mergeStrategy - The MergeStrategy to use if multiple configuration files are present.
reliabilityStrategy - The ReliabilityStrategy to use during the reconfiguration process.
usePreciseClock - If true a clock with nanosecond precision will be used whenever available.
waitMillisBeforeStopOldConfig - The number of milliseconds to wait for the old configuration to stop.
Enclosing class:
CoreProperties
@Log4jProperty(name="configuration") public static record CoreProperties.ConfigurationProperties(String allowedProtocols, @Nullable String clock, @Nullable Class<? extends ConfigurationFactory> factory, org.apache.logging.log4j.Level level, @Nullable String location, @Nullable Class<? extends MergeStrategy> mergeStrategy, String reliabilityStrategy, boolean usePreciseClock, long waitMillisBeforeStopOldConfig) extends Record
Properties related to the retrieval of a configuration.

  • Constructor Details

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • allowedProtocols

      public String allowedProtocols()
      Returns the value of the allowedProtocols record component.
      Returns:
      the value of the allowedProtocols record component

    • clock

      public @Nullable String clock()
      Returns the value of the clock record component.
      Returns:
      the value of the clock record component

    • factory

      public @Nullable Class<? extends ConfigurationFactory> factory()
      Returns the value of the factory record component.
      Returns:
      the value of the factory record component

    • level

      public org.apache.logging.log4j.Level level()
      Returns the value of the level record component.
      Returns:
      the value of the level record component

    • location

      public @Nullable String location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component

    • mergeStrategy

      public @Nullable Class<? extends MergeStrategy> mergeStrategy()
      Returns the value of the mergeStrategy record component.
      Returns:
      the value of the mergeStrategy record component

    • reliabilityStrategy

      public String reliabilityStrategy()
      Returns the value of the reliabilityStrategy record component.
      Returns:
      the value of the reliabilityStrategy record component

    • usePreciseClock

      public boolean usePreciseClock()
      Returns the value of the usePreciseClock record component.
      Returns:
      the value of the usePreciseClock record component

    • waitMillisBeforeStopOldConfig

      public long waitMillisBeforeStopOldConfig()
      Returns the value of the waitMillisBeforeStopOldConfig record component.
      Returns:
      the value of the waitMillisBeforeStopOldConfig record component