@Plugin(name="TimeFilter", category="Core", elementType="filter", printObject=true) public final class TimeFilter extends AbstractFilter
AbstractFilter.AbstractFilterBuilder<B extends AbstractFilter.AbstractFilterBuilder<B>>
Filter.Result
LifeCycle.State
Modifier and Type | Field and Description |
---|---|
private static Clock |
CLOCK |
private long |
end
Ending offset from midnight in milliseconds.
|
private static long |
HOUR_MS
Length of hour in milliseconds.
|
private long |
midnightToday |
private long |
midnightTomorrow |
private static long |
MINUTE_MS
Length of minute in milliseconds.
|
private static long |
SECOND_MS
Length of second in milliseconds.
|
private long |
start
Starting offset from midnight in milliseconds.
|
private java.util.TimeZone |
timezone
Timezone.
|
onMatch, onMismatch
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
ELEMENT_TYPE
Modifier | Constructor and Description |
---|---|
private |
TimeFilter(long start,
long end,
java.util.TimeZone tz,
Filter.Result onMatch,
Filter.Result onMismatch) |
Modifier and Type | Method and Description |
---|---|
static TimeFilter |
createFilter(java.lang.String start,
java.lang.String end,
java.lang.String tz,
Filter.Result match,
Filter.Result mismatch)
Creates a TimeFilter.
|
private Filter.Result |
filter() |
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.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0,
java.lang.Object p1)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0,
java.lang.Object p1,
java.lang.Object p2)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0,
java.lang.Object p1,
java.lang.Object p2,
java.lang.Object p3)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0,
java.lang.Object p1,
java.lang.Object p2,
java.lang.Object p3,
java.lang.Object p4)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0,
java.lang.Object p1,
java.lang.Object p2,
java.lang.Object p3,
java.lang.Object p4,
java.lang.Object p5)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0,
java.lang.Object p1,
java.lang.Object p2,
java.lang.Object p3,
java.lang.Object p4,
java.lang.Object p5,
java.lang.Object p6)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0,
java.lang.Object p1,
java.lang.Object p2,
java.lang.Object p3,
java.lang.Object p4,
java.lang.Object p5,
java.lang.Object p6,
java.lang.Object p7)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0,
java.lang.Object p1,
java.lang.Object p2,
java.lang.Object p3,
java.lang.Object p4,
java.lang.Object p5,
java.lang.Object p6,
java.lang.Object p7,
java.lang.Object p8)
Appender Filter method.
|
Filter.Result |
filter(Logger logger,
Level level,
Marker marker,
java.lang.String msg,
java.lang.Object p0,
java.lang.Object p1,
java.lang.Object p2,
java.lang.Object p3,
java.lang.Object p4,
java.lang.Object p5,
java.lang.Object p6,
java.lang.Object p7,
java.lang.Object p8,
java.lang.Object p9)
Appender Filter method.
|
(package private) Filter.Result |
filter(long currentTimeMillis)
Package-protected for tests.
|
(package private) void |
initMidnight(long now)
Initializes the midnight boundaries to midnight in the specified time zone.
|
private static long |
parseTimestamp(java.lang.String timestamp,
long defaultValue) |
java.lang.String |
toString() |
equalsImpl, getOnMatch, getOnMismatch, hashCodeImpl
getState, getStatusLogger, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, start, stop, stop, stop
private static final Clock CLOCK
private static final long HOUR_MS
private static final long MINUTE_MS
private static final long SECOND_MS
private final long start
private final long end
private final java.util.TimeZone timezone
private long midnightToday
private long midnightTomorrow
private TimeFilter(long start, long end, java.util.TimeZone tz, Filter.Result onMatch, Filter.Result onMismatch)
void initMidnight(long now)
now
- a time in milliseconds since the epoch, used to pinpoint the current dateFilter.Result filter(long currentTimeMillis)
currentTimeMillis
- the time to compare with the boundaries. May re-initialize the cached midnight
boundary values.public Filter.Result filter(LogEvent event)
AbstractFilter
filter
in interface Filter
filter
in class AbstractFilter
event
- The LogEvent.private Filter.Result filter()
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(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, 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.String msg, java.lang.Object p0)
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.p0
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1)
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.p0
- the message parametersp1
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2)
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.p0
- the message parametersp1
- the message parametersp2
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)
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.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4)
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.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5)
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.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6)
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.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7)
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.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parametersp7
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8)
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.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parametersp7
- the message parametersp8
- the message parameterspublic Filter.Result filter(Logger logger, Level level, Marker marker, java.lang.String msg, java.lang.Object p0, java.lang.Object p1, java.lang.Object p2, java.lang.Object p3, java.lang.Object p4, java.lang.Object p5, java.lang.Object p6, java.lang.Object p7, java.lang.Object p8, java.lang.Object p9)
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.p0
- the message parametersp1
- the message parametersp2
- the message parametersp3
- the message parametersp4
- the message parametersp5
- the message parametersp6
- the message parametersp7
- the message parametersp8
- the message parametersp9
- the message parameterspublic java.lang.String toString()
toString
in class AbstractFilter
@PluginFactory public static TimeFilter createFilter(@PluginAttribute(value="start") java.lang.String start, @PluginAttribute(value="end") java.lang.String end, @PluginAttribute(value="timezone") java.lang.String tz, @PluginAttribute(value="onMatch") Filter.Result match, @PluginAttribute(value="onMismatch") Filter.Result mismatch)
start
- The start time.end
- The end time.tz
- timezone.match
- Action to perform if the time matches.mismatch
- Action to perform if the action does not match.private static long parseTimestamp(java.lang.String timestamp, long defaultValue)