public class StringMatchFilter extends Filter
The filter admits two options StringToMatch and AcceptOnMatch. If there is a match between the value of
the StringToMatch option and the message of the LoggingEvent
, then the
decide(LoggingEvent)
method returns Filter.ACCEPT
if the AcceptOnMatch
option value is true, if it is false then Filter.DENY
is returned. If there is no match,
Filter.NEUTRAL
is returned.
Modifier and Type | Field and Description |
---|---|
static String |
ACCEPT_ON_MATCH_OPTION
Deprecated.
Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be
removed in the near term.
|
static String |
STRING_TO_MATCH_OPTION
Deprecated.
Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be
removed in the near term.
|
Constructor and Description |
---|
StringMatchFilter() |
Modifier and Type | Method and Description |
---|---|
int |
decide(LoggingEvent event)
Returns
Filter.NEUTRAL is there is no string match. |
boolean |
getAcceptOnMatch() |
String[] |
getOptionStrings()
Deprecated.
We now use JavaBeans introspection to configure components. Options strings are no longer needed.
|
String |
getStringToMatch() |
void |
setAcceptOnMatch(boolean acceptOnMatch) |
void |
setOption(String key,
String value)
Deprecated.
Use the setter method for the option directly instead of the generic
setOption method. |
void |
setStringToMatch(String s) |
activateOptions, getNext, setNext
@Deprecated public static final String STRING_TO_MATCH_OPTION
@Deprecated public static final String ACCEPT_ON_MATCH_OPTION
public int decide(LoggingEvent event)
Filter.NEUTRAL
is there is no string match.public boolean getAcceptOnMatch()
@Deprecated public String[] getOptionStrings()
public String getStringToMatch()
public void setAcceptOnMatch(boolean acceptOnMatch)
@Deprecated public void setOption(String key, String value)
setOption
method.public void setStringToMatch(String s)
Copyright © 1999-2022 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.