Package org.apache.logging.log4j.core.config

Class LoggerConfig

    • Field Detail

      • appenderRefs

        private java.util.List<AppenderRef> appenderRefs

      • name

        private final java.lang.String name

      • level

        private Level level

      • additive

        private boolean additive

      • includeLocation

        private boolean includeLocation

      • propertiesMap

        private java.util.Map<Property,​java.lang.Boolean> propertiesMap

      • properties

        private final java.util.List<Property> properties

      • propertiesRequireLookup

        private final boolean propertiesRequireLookup

    • Constructor Detail

      • LoggerConfig

        public LoggerConfig()
        Default constructor.

      • LoggerConfig

        public LoggerConfig​(java.lang.String name,
                    Level level,
                    boolean additive)
        Constructor that sets the name, level and additive values.
        Parameters:
        name - The Logger name.
        level - The Level.
        additive - true if the Logger is additive, false otherwise.

      • LoggerConfig

        protected LoggerConfig​(java.lang.String name,
                       java.util.List<AppenderRef> appenders,
                       Filter filter,
                       Level level,
                       boolean additive,
                       Property[] properties,
                       Configuration config,
                       boolean includeLocation)

    • Method Detail

      • containsPropertyRequiringLookup

        private static boolean containsPropertyRequiringLookup​(Property[] properties)

      • getName

        public java.lang.String getName()
        Returns the name of the LoggerConfig.
        Returns:
        the name of the LoggerConfig.

      • setParent

        public void setParent​(LoggerConfig parent)
        Sets the parent of this LoggerConfig.
        Parameters:
        parent - the parent LoggerConfig.

      • getParent

        public LoggerConfig getParent()
        Returns the parent of this LoggerConfig.
        Returns:
        the LoggerConfig that is the parent of this one.

      • addAppender

        public void addAppender​(Appender appender,
                        Level level,
                        Filter filter)
        Adds an Appender to the LoggerConfig.
        Parameters:
        appender - The Appender to add.
        level - The Level to use.
        filter - A Filter for the Appender reference.

      • removeAppender

        public void removeAppender​(java.lang.String name)
        Removes the Appender with the specific name.
        Parameters:
        name - The name of the Appender.

      • getAppenders

        public java.util.Map<java.lang.String,​Appender> getAppenders()
        Returns all Appenders as a Map.
        Returns:
        a Map with the Appender name as the key and the Appender as the value.

      • clearAppenders

        protected void clearAppenders()
        Removes all Appenders.

      • getAppenderRefs

        public java.util.List<AppenderRef> getAppenderRefs()
        Returns the Appender references.
        Returns:
        a List of all the Appender names attached to this LoggerConfig.

      • setLevel

        public void setLevel​(Level level)
        Sets the logging Level.
        Parameters:
        level - The logging Level.

      • getLevel

        public Level getLevel()
        Returns the logging Level.
        Returns:
        the logging Level.

      • getExplicitLevel

        public Level getExplicitLevel()
        Allows callers to determine the Level assigned to this LoggerConfig.
        Returns:
        the Level associated with this LoggerConfig or null if none is set.

      • getLogEventFactory

        public LogEventFactory getLogEventFactory()
        Returns the LogEventFactory.
        Returns:
        the LogEventFactory.

      • setLogEventFactory

        public void setLogEventFactory​(LogEventFactory logEventFactory)
        Sets the LogEventFactory. Usually the LogEventFactory will be this LoggerConfig.
        Parameters:
        logEventFactory - the LogEventFactory.

      • isAdditive

        public boolean isAdditive()
        Returns the valid of the additive flag.
        Returns:
        true if the LoggerConfig is additive, false otherwise.

      • setAdditive

        public void setAdditive​(boolean additive)
        Sets the additive setting.
        Parameters:
        additive - true if the LoggerConfig should be additive, false otherwise.

      • isIncludeLocation

        public boolean isIncludeLocation()
        Returns the value of logger configuration attribute includeLocation, or, if no such attribute was configured, true if logging is synchronous or false if logging is asynchronous.
        Returns:
        whether location should be passed downstream

      • getProperties

        @Deprecated
public java.util.Map<Property,​java.lang.Boolean> getProperties()
        Deprecated.
        use getPropertyList() instead
        Returns an unmodifiable map with the configuration properties, or null if this LoggerConfig does not have any configuration properties.

        For each Property key in the map, the value is true if the property value has a variable that needs to be substituted.

        Returns:
        an unmodifiable map with the configuration properties, or null
        See Also:
        Configuration.getStrSubstitutor(), StrSubstitutor

      • getPropertyList

        public java.util.List<Property> getPropertyList()
        Returns an unmodifiable list with the configuration properties, or null if this LoggerConfig does not have any configuration properties.

        Each Property in the list has an attribute valueNeedsLookup that is true if the property value has a variable that needs to be substituted.

        Returns:
        an unmodifiable list with the configuration properties, or null
        Since:
        2.7
        See Also:
        Configuration.getStrSubstitutor(), StrSubstitutor

      • isPropertiesRequireLookup

        public boolean isPropertiesRequireLookup()

      • log

        public void log​(java.lang.String loggerName,
                java.lang.String fqcn,
                Marker marker,
                Level level,
                Message data,
                java.lang.Throwable t)
        Logs an event.
        Parameters:
        loggerName - The name of the Logger.
        fqcn - The fully qualified class name of the caller.
        marker - A Marker or null if none is present.
        level - The event Level.
        data - The Message.
        t - A Throwable or null.

      • location

        private java.lang.StackTraceElement location​(java.lang.String fqcn)

      • log

        public void log​(java.lang.String loggerName,
                java.lang.String fqcn,
                java.lang.StackTraceElement location,
                Marker marker,
                Level level,
                Message data,
                java.lang.Throwable t)
        Logs an event.
        Parameters:
        loggerName - The name of the Logger.
        fqcn - The fully qualified class name of the caller.
        location - the location of the caller.
        marker - A Marker or null if none is present.
        level - The event Level.
        data - The Message.
        t - A Throwable or null.

      • getProperties

        private java.util.List<Property> getProperties​(java.lang.String loggerName,
                                               java.lang.String fqcn,
                                               Marker marker,
                                               Level level,
                                               Message data,
                                               java.lang.Throwable t)

      • getPropertiesWithLookups

        private java.util.List<Property> getPropertiesWithLookups​(java.lang.String loggerName,
                                                          java.lang.String fqcn,
                                                          Marker marker,
                                                          Level level,
                                                          Message data,
                                                          java.lang.Throwable t,
                                                          java.util.List<Property> props)

      • log

        public void log​(LogEvent event)
        Logs an event.
        Parameters:
        event - The log event.

      • log

        protected void log​(LogEvent event,
                   LoggerConfig.LoggerConfigPredicate predicate)
        Logs an event.
        Parameters:
        event - The log event.
        predicate - predicate for which LoggerConfig instances to append to. A null value is equivalent to a true predicate.

      • getReliabilityStrategy

        public ReliabilityStrategy getReliabilityStrategy()
        Returns the object responsible for ensuring log events are delivered to a working appender, even during or after a reconfiguration.
        Returns:
        the object responsible for delivery of log events to the appender

      • callAppenders

        protected void callAppenders​(LogEvent event)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • includeLocation

        protected static boolean includeLocation​(java.lang.String includeLocationConfigValue)

      • includeLocation

        protected static boolean includeLocation​(java.lang.String includeLocationConfigValue,
                                         Configuration configuration)

      • hasAppenders

        protected final boolean hasAppenders()