Package org.apache.log4j.filter
Class LoggerMatchFilter
- java.lang.Object
-
- org.apache.log4j.spi.Filter
-
- org.apache.log4j.filter.LoggerMatchFilter
-
- All Implemented Interfaces:
org.apache.log4j.spi.OptionHandler
public class LoggerMatchFilter extends org.apache.log4j.spi.Filter
This is a very simple filter based on logger name matching.The filter admits two options LoggerToMatch and AcceptOnMatch. If there is an exact match between the value of the LoggerToMatch option and the logger of the
LoggingEvent
, then thedecide(org.apache.log4j.spi.LoggingEvent)
method returnsFilter.ACCEPT
in case the AcceptOnMatch option value is set totrue
, if it isfalse
thenFilter.DENY
is returned. If there is no match,Filter.NEUTRAL
is returned. A loggerToMatch of "root" matches both the root logger and a logger named "root".
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
acceptOnMatch
Do we return ACCEPT when a match occurs.private java.lang.String
loggerToMatch
Logger name, may be null or empty in which case it matches root.
-
Constructor Summary
Constructors Constructor Description LoggerMatchFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
decide(org.apache.log4j.spi.LoggingEvent event)
boolean
getAcceptOnMatch()
Gets whether a match should result in acceptance.java.lang.String
getLoggerToMatch()
Gets logger name.void
setAcceptOnMatch(boolean acceptOnMatch)
Sets whether a match should result in acceptance.void
setLoggerToMatch(java.lang.String logger)
Sets logger name.
-
-
-
Method Detail
-
setLoggerToMatch
public void setLoggerToMatch(java.lang.String logger)
Sets logger name.- Parameters:
logger
- logger name.
-
getLoggerToMatch
public java.lang.String getLoggerToMatch()
Gets logger name.- Returns:
- logger name.
-
setAcceptOnMatch
public void setAcceptOnMatch(boolean acceptOnMatch)
Sets whether a match should result in acceptance.- Parameters:
acceptOnMatch
- if true, accept if logger name matches, otherwise reject.
-
getAcceptOnMatch
public boolean getAcceptOnMatch()
Gets whether a match should result in acceptance.- Returns:
- true if event is accepted if logger name matches.
-
decide
public int decide(org.apache.log4j.spi.LoggingEvent event)
- Specified by:
decide
in classorg.apache.log4j.spi.Filter
-
-