@Plugin(name="ScriptFilter", category="Core", elementType="filter", printObject=true) public final class ScriptFilter extends AbstractFilter
Filter.Result
LifeCycle.State
Modifier and Type | Field and Description |
---|---|
private Configuration |
configuration |
private static Logger |
logger |
private AbstractScript |
script |
onMatch, onMismatch
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
ELEMENT_TYPE
Modifier | Constructor and Description |
---|---|
private |
ScriptFilter(AbstractScript script,
Configuration configuration,
Filter.Result onMatch,
Filter.Result onMismatch) |
Modifier and Type | Method and Description |
---|---|
static ScriptFilter |
createFilter(AbstractScript script,
Filter.Result match,
Filter.Result mismatch,
Configuration configuration)
Creates the ScriptFilter.
|
Filter.Result |
filter(LogEvent event)
Context Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
Message msg,
java.lang.Throwable t)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.Object msg,
java.lang.Throwable t)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object... params)
Appender Filter method.
|
java.lang.String |
toString() |
equalsImpl, filter, filter, filter, filter, filter, filter, filter, filter, filter, filter, getOnMatch, getOnMismatch, hashCodeImpl
getState, getStatusLogger, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, stop, stop
private static Logger logger
private final AbstractScript script
private final Configuration configuration
private ScriptFilter(AbstractScript script, Configuration configuration, Filter.Result onMatch, Filter.Result onMismatch)
public Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object... params)
AbstractFilter
filter
in interface Filter
filter
in class AbstractFilter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.params
- An array of parameters or null.public Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.Object msg, java.lang.Throwable t)
AbstractFilter
filter
in interface Filter
filter
in class AbstractFilter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.t
- A throwable or null.public Filter.Result filter(Logger logger, Level level, Marker marker, Message msg, java.lang.Throwable t)
AbstractFilter
filter
in interface Filter
filter
in class AbstractFilter
logger
- the Logger.level
- The logging Level.marker
- The Marker, if any.msg
- The message, if present.t
- A throwable or null.public Filter.Result filter(LogEvent event)
AbstractFilter
filter
in interface Filter
filter
in class AbstractFilter
event
- The LogEvent.public java.lang.String toString()
toString
in class AbstractFilter
@PluginFactory public static ScriptFilter createFilter(@PluginElement(value="Script") AbstractScript script, @PluginAttribute(value="onMatch") Filter.Result match, @PluginAttribute(value="onMismatch") Filter.Result mismatch, @PluginConfiguration Configuration configuration)
script
- The script to run. The script must return a boolean value. Either script or scriptFile must be
provided.match
- The action to take if a match occurs.mismatch
- The action to take if no match occurs.configuration
- the configuration