Uses of Interface
org.apache.logging.log4j.core.Filter

Packages that use Filter

Package	Description
org.apache.logging.log4j.core	Implementation of Log4j 2.
org.apache.logging.log4j.core.appender	Log4j 2 Appenders.
org.apache.logging.log4j.core.appender.db	The classes in this package and sub packages provide appenders for various types of databases and methods for accessing databases.
org.apache.logging.log4j.core.appender.db.jdbc	The JDBC Appender supports writing log events to a relational database using standard JDBC connections.
org.apache.logging.log4j.core.appender.mom	Message oriented middleware appenders.
org.apache.logging.log4j.core.appender.mom.jeromq	Classes and interfaces for ZeroMQ/JeroMQ support.
org.apache.logging.log4j.core.appender.mom.kafka	Classes and interfaces for Kafka appender support.
org.apache.logging.log4j.core.appender.nosql	The NoSQL Appender supports writing log events to NoSQL databases.
org.apache.logging.log4j.core.appender.rewrite	Apache Flume Appender.
org.apache.logging.log4j.core.appender.routing	Apache Flume Appender.
org.apache.logging.log4j.core.async	Provides Asynchronous Logger classes and interfaces for low-latency logging.
org.apache.logging.log4j.core.config	Configuration of Log4j 2.
org.apache.logging.log4j.core.filter	Log4j 2 Filter support.

Uses of Filter in org.apache.logging.log4j.core

Fields in org.apache.logging.log4j.core declared as Filter

Modifier and Type	Field and Description
static Filter[]	Filter.EMPTY_ARRAY The empty array.

Methods in org.apache.logging.log4j.core that return types with arguments of type Filter

Modifier and Type	Method and Description
Iterator<Filter>	Logger.getFilters() This method is not exposed through the public API and is used primarily for unit testing.

Methods in org.apache.logging.log4j.core with parameters of type Filter

Modifier and Type	Method and Description
void	LoggerContext.addFilter(Filter filter) Adds a Filter to the Configuration.
void	Logger.addFilter(Filter filter) This method is not exposed through the public API and is used primarily for unit testing.
void	LoggerContext.removeFilter(Filter filter) Removes a Filter from the current Configuration.

Uses of Filter in org.apache.logging.log4j.core.appender

Methods in org.apache.logging.log4j.core.appender with parameters of type Filter

Modifier and Type	Method and Description
static AsyncAppender	AsyncAppender.createAppender(AppenderRef[] appenderRefs, String errorRef, boolean blocking, long shutdownTimeout, int size, String name, boolean includeLocation, Filter filter, Configuration config, boolean ignoreExceptions) Deprecated. use AsyncAppender.Builder instead
static SmtpAppender	SmtpAppender.createAppender(Configuration config, String name, String to, String cc, String bcc, String from, String replyTo, String subject, String smtpProtocol, String smtpHost, String smtpPortStr, String smtpUsername, String smtpPassword, String smtpDebug, String bufferSizeStr, Layout<? extends Serializable> layout, Filter filter, String ignore) Deprecated. Use SmtpAppender.newBuilder() to create and configure a SmtpAppender.Builder instance.
static ConsoleAppender	ConsoleAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, ConsoleAppender.Target target, String name, boolean follow, boolean direct, boolean ignoreExceptions) Deprecated. Deprecated in 2.7; use ConsoleAppender.newBuilder().
static OutputStreamAppender	OutputStreamAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, OutputStream target, String name, boolean follow, boolean ignore) Creates an OutputStream Appender.
static ConsoleAppender	ConsoleAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, String targetStr, String name, String follow, String ignore) Deprecated. Deprecated in 2.7; use ConsoleAppender.newBuilder().
static SocketAppender	SocketAppender.createAppender(String host, int port, Protocol protocol, SslConfiguration sslConfig, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, String name, boolean immediateFlush, boolean ignoreExceptions, Layout<? extends Serializable> layout, Filter filter, boolean advertise, Configuration configuration) Deprecated. Deprecated in 2.7; use SocketAppender.newBuilder()
static <B extends SyslogAppender.Builder<B>> SyslogAppender	SyslogAppender.createAppender(String host, int port, String protocolStr, SslConfiguration sslConfiguration, int connectTimeoutMillis, int reconnectDelayMillis, boolean immediateFail, String name, boolean immediateFlush, boolean ignoreExceptions, Facility facility, String id, int enterpriseNumber, boolean includeMdc, String mdcId, String mdcPrefix, String eventPrefix, boolean newLine, String escapeNL, String appName, String msgId, String excludes, String includes, String required, String format, Filter filter, Configuration configuration, Charset charset, String exceptionPattern, LoggerFields[] loggerFields, boolean advertise) Deprecated. Use SyslogAppender.newSyslogAppenderBuilder().
static WriterAppender	WriterAppender.createAppender(StringLayout layout, Filter filter, Writer target, String name, boolean follow, boolean ignore) Creates a WriterAppender.
static FailoverAppender	FailoverAppender.createAppender(String name, String primary, String[] failovers, String retryIntervalSeconds, Configuration config, Filter filter, String ignore) Create a Failover Appender.
static SocketAppender	SocketAppender.createAppender(String host, String portNum, String protocolIn, SslConfiguration sslConfig, int connectTimeoutMillis, String delayMillis, String immediateFail, String name, String immediateFlush, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, Configuration config) Deprecated. Deprecated in 2.5; use SocketAppender.newBuilder()
static <B extends MemoryMappedFileAppender.Builder<B>> MemoryMappedFileAppender	MemoryMappedFileAppender.createAppender(String fileName, String append, String name, String immediateFlush, String regionLengthStr, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseURI, Configuration config) Deprecated. Use MemoryMappedFileAppender.newBuilder().
static <B extends RandomAccessFileAppender.Builder<B>> RandomAccessFileAppender	RandomAccessFileAppender.createAppender(String fileName, String append, String name, String immediateFlush, String bufferSizeStr, String ignore, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseURI, Configuration configuration) Deprecated. Use RandomAccessFileAppender.newBuilder().
static <B extends FileAppender.Builder<B>> FileAppender	FileAppender.createAppender(String fileName, String append, String locking, String name, String immediateFlush, String ignoreExceptions, String bufferedIo, String bufferSizeStr, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseUri, Configuration config) Deprecated. Use FileAppender.newBuilder()
static <B extends RollingFileAppender.Builder<B>> RollingFileAppender	RollingFileAppender.createAppender(String fileName, String filePattern, String append, String name, String bufferedIO, String bufferSizeStr, String immediateFlush, TriggeringPolicy policy, RolloverStrategy strategy, Layout<? extends Serializable> layout, Filter filter, String ignore, String advertise, String advertiseUri, Configuration config) Deprecated. Use RollingFileAppender.newBuilder().
static <B extends RollingRandomAccessFileAppender.Builder<B>> RollingRandomAccessFileAppender	RollingRandomAccessFileAppender.createAppender(String fileName, String filePattern, String append, String name, String immediateFlush, String bufferSizeStr, TriggeringPolicy policy, RolloverStrategy strategy, Layout<? extends Serializable> layout, Filter filter, String ignoreExceptions, String advertise, String advertiseURI, Configuration configuration) Deprecated. Use RollingRandomAccessFileAppender.newBuilder().
SmtpAppender.Builder	SmtpAppender.Builder.setFilter(Filter filter) Specifies the filter used for this appender.

Constructors in org.apache.logging.log4j.core.appender with parameters of type Filter

Constructor and Description
AbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout) Deprecated. Use AbstractAppender.AbstractAppender(String, Filter, Layout, boolean, Property[]).
AbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions) Deprecated. Use AbstractAppender.AbstractAppender(String, Filter, Layout, boolean, Property[])
AbstractAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties) Constructor.
AbstractOutputStreamAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, M manager) Deprecated. Use AbstractOutputStreamAppender.AbstractOutputStreamAppender(String, Layout, Filter, boolean, boolean, Property[], OutputStreamManager)
AbstractOutputStreamAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, Property[] properties, M manager) Instantiates a WriterAppender and set the output destination to a new OutputStreamWriter initialized with os as its OutputStream.
AbstractWriterAppender(String name, StringLayout layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, M manager) Deprecated. Use AbstractWriterAppender.AbstractWriterAppender(String, StringLayout, Filter, boolean, boolean, Property[], WriterManager).
AbstractWriterAppender(String name, StringLayout layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, Property[] properties, M manager) Instantiates.
SocketAppender(String name, Layout<? extends Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser) Deprecated. SocketAppender.SocketAppender(String, Layout, Filter, AbstractSocketManager, boolean, boolean, Advertiser, Property[]).
SocketAppender(String name, Layout<? extends Serializable> layout, Filter filter, AbstractSocketManager manager, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)
SyslogAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser) Deprecated. Use SyslogAppender.SyslogAppender(String, Layout, Filter, boolean, boolean, AbstractSocketManager, Advertiser, Property[]).
SyslogAppender(String name, Layout<? extends Serializable> layout, Filter filter, boolean ignoreExceptions, boolean immediateFlush, AbstractSocketManager manager, Advertiser advertiser, Property[] properties)

Uses of Filter in org.apache.logging.log4j.core.appender.db

Constructors in org.apache.logging.log4j.core.appender.db with parameters of type Filter

Constructor and Description
AbstractDatabaseAppender(String name, Filter filter, boolean ignoreExceptions, T manager) Deprecated. Use AbstractDatabaseAppender.AbstractDatabaseAppender(String, Filter, Layout, boolean, Property[], AbstractDatabaseManager).
AbstractDatabaseAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, T manager) Instantiates the base appender.
AbstractDatabaseAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, T manager) Deprecated. Use AbstractDatabaseAppender.AbstractDatabaseAppender(String, Filter, Layout, boolean, Property[], AbstractDatabaseManager)

Uses of Filter in org.apache.logging.log4j.core.appender.db.jdbc

Methods in org.apache.logging.log4j.core.appender.db.jdbc with parameters of type Filter

Modifier and Type	Method and Description
static <B extends JdbcAppender.Builder<B>> JdbcAppender	JdbcAppender.createAppender(String name, String ignore, Filter filter, ConnectionSource connectionSource, String bufferSize, String tableName, ColumnConfig[] columnConfigs) Deprecated. use JdbcAppender.newBuilder()

Uses of Filter in org.apache.logging.log4j.core.appender.mom

Constructors in org.apache.logging.log4j.core.appender.mom with parameters of type Filter

Constructor and Description
JmsAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, JmsManager manager) Deprecated. Use JmsAppender.JmsAppender(String, Filter, Layout, boolean, Property[], JmsManager).
JmsAppender(String name, Filter filter, Layout<? extends Serializable> layout, boolean ignoreExceptions, Property[] properties, JmsManager manager) Constructs a new instance.

Uses of Filter in org.apache.logging.log4j.core.appender.mom.jeromq

Methods in org.apache.logging.log4j.core.appender.mom.jeromq with parameters of type Filter

Modifier and Type

Method and Description

static JeroMqAppender

JeroMqAppender.createAppender(String name, Layout<?> layout, Filter filter, Property[] properties, boolean ignoreExceptions, long affinity, long backlog, boolean delayAttachOnConnect, byte[] identity, boolean ipv4Only, long linger, long maxMsgSize, long rcvHwm, long receiveBufferSize, int receiveTimeOut, long reconnectIVL, long reconnectIVLMax, long sendBufferSize, int sendTimeOut, long sndHwm, int tcpKeepAlive, long tcpKeepAliveCount, long tcpKeepAliveIdle, long tcpKeepAliveInterval, boolean xpubVerbose)

Uses of Filter in org.apache.logging.log4j.core.appender.mom.kafka

Methods in org.apache.logging.log4j.core.appender.mom.kafka with parameters of type Filter

Modifier and Type	Method and Description
static KafkaAppender	KafkaAppender.createAppender(Layout<? extends Serializable> layout, Filter filter, String name, boolean ignoreExceptions, String topic, Property[] properties, Configuration configuration, String key) Deprecated.

Uses of Filter in org.apache.logging.log4j.core.appender.nosql

Methods in org.apache.logging.log4j.core.appender.nosql with parameters of type Filter

Modifier and Type	Method and Description
static NoSqlAppender	NoSqlAppender.createAppender(String name, String ignore, Filter filter, String bufferSize, NoSqlProvider<?> provider) Deprecated. since 2.11.0; use NoSqlAppender.Builder.

Uses of Filter in org.apache.logging.log4j.core.appender.rewrite

Methods in org.apache.logging.log4j.core.appender.rewrite with parameters of type Filter

Modifier and Type	Method and Description
static RewriteAppender	RewriteAppender.createAppender(String name, String ignore, AppenderRef[] appenderRefs, Configuration config, RewritePolicy rewritePolicy, Filter filter) Creates a RewriteAppender.

Uses of Filter in org.apache.logging.log4j.core.appender.routing

Methods in org.apache.logging.log4j.core.appender.routing with parameters of type Filter

Modifier and Type	Method and Description
static RoutingAppender	RoutingAppender.createAppender(String name, String ignore, Routes routes, Configuration config, RewritePolicy rewritePolicy, PurgePolicy purgePolicy, Filter filter) Deprecated. Since 2.7; use RoutingAppender.newBuilder()

Uses of Filter in org.apache.logging.log4j.core.async

Methods in org.apache.logging.log4j.core.async with parameters of type Filter

Modifier and Type	Method and Description
static LoggerConfig	AsyncLoggerConfig.createLogger(boolean additivity, org.apache.logging.log4j.Level level, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Factory method to create a LoggerConfig.
static LoggerConfig	AsyncLoggerConfig.RootLogger.createLogger(String additivity, org.apache.logging.log4j.Level level, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter)
static LoggerConfig	AsyncLoggerConfig.RootLogger.createLogger(String additivity, String levelName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Deprecated. use AsyncLoggerConfig.RootLogger.createLogger(String, Level, String, AppenderRef[], Property[], Configuration, Filter)
static LoggerConfig	AsyncLoggerConfig.createLogger(String additivity, String levelName, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Deprecated. use AsyncLoggerConfig.createLogger(boolean, Level, String, String, AppenderRef[], Property[], Configuration, Filter)

Constructors in org.apache.logging.log4j.core.async with parameters of type Filter

Constructor and Description
AsyncLoggerConfig(String name, List<AppenderRef> appenders, Filter filter, org.apache.logging.log4j.Level level, boolean additive, Property[] properties, Configuration config, boolean includeLocation)

Uses of Filter in org.apache.logging.log4j.core.config

Methods in org.apache.logging.log4j.core.config that return Filter

Modifier and Type	Method and Description
Filter	LoggerConfig.getFilter()
Filter	AppenderRef.getFilter()

Methods in org.apache.logging.log4j.core.config with parameters of type Filter

Modifier and Type	Method and Description
void	LoggerConfig.addAppender(Appender appender, org.apache.logging.log4j.Level level, Filter filter) Adds an Appender to the LoggerConfig.
void	AbstractConfiguration.addLoggerFilter(Logger logger, Filter filter) Associates a Filter with a LoggerConfig.
void	Configuration.addLoggerFilter(Logger logger, Filter filter)
static AppenderRef	AppenderRef.createAppenderRef(String ref, org.apache.logging.log4j.Level level, Filter filter) Create an Appender reference.
static LoggerConfig	LoggerConfig.createLogger(boolean additivity, org.apache.logging.log4j.Level level, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Factory method to create a LoggerConfig.
static LoggerConfig	LoggerConfig.RootLogger.createLogger(String additivity, org.apache.logging.log4j.Level level, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter)
static LoggerConfig	LoggerConfig.createLogger(String additivity, org.apache.logging.log4j.Level level, String loggerName, String includeLocation, AppenderRef[] refs, Property[] properties, Configuration config, Filter filter) Deprecated. Deprecated in 2.7; use LoggerConfig.createLogger(boolean, Level, String, String, AppenderRef[], Property[], Configuration, Filter)

Constructors in org.apache.logging.log4j.core.config with parameters of type Filter

Constructor and Description
AppenderControl(Appender appender, org.apache.logging.log4j.Level level, Filter filter) Constructor.
LoggerConfig(String name, List<AppenderRef> appenders, Filter filter, org.apache.logging.log4j.Level level, boolean additive, Property[] properties, Configuration config, boolean includeLocation)

Uses of Filter in org.apache.logging.log4j.core.filter

Classes in org.apache.logging.log4j.core.filter that implement Filter

Modifier and Type	Class and Description
class	AbstractFilter Users should extend this class to implement filters.
class	BurstFilter The BurstFilter is a logging filter that regulates logging traffic.
class	CompositeFilter Composes and invokes one or more filters.
class	DenyAllFilter This filter causes all logging events to be dropped.
class	DynamicThresholdFilter Compares against a log level that is associated with a context value.
class	LevelMatchFilter This filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.
class	LevelRangeFilter This filter returns the onMatch result if the level in the LogEvent is in the range of the configured min and max levels, otherwise it returns onMismatch value .
class	MapFilter A Filter that operates on a Map.
class	MarkerFilter This filter returns the onMatch result if the marker in the LogEvent is the same as or has the configured marker as a parent.
class	NoMarkerFilter This filter returns the onMatch result if there is no marker in the LogEvent.
class	RegexFilter This filter returns the onMatch result if the message matches the regular expression.
class	ScriptFilter Returns the onMatch result if the script returns True and returns the onMismatch value otherwise.
class	StringMatchFilter This filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.
class	StructuredDataFilter Filter based on data in a StructuredDataMessage.
class	ThreadContextMapFilter Filter based on a value in the Thread Context Map (MDC).
class	ThresholdFilter This filter returns the onMatch result if the level in the LogEvent is the same or more specific than the configured level and the onMismatch value otherwise.
class	TimeFilter Filters events that fall within a specified time period in each day.

Methods in org.apache.logging.log4j.core.filter that return Filter

Modifier and Type	Method and Description
Filter	AbstractFilterable.getFilter() Returns the Filter.
Filter	AbstractFilterable.Builder.getFilter()
Filter	Filterable.getFilter() Returns an Iterator for all the Filters.
Filter[]	CompositeFilter.getFiltersArray()

Methods in org.apache.logging.log4j.core.filter that return types with arguments of type Filter

Modifier and Type	Method and Description
List<Filter>	CompositeFilter.getFilters() Deprecated. Use CompositeFilter.getFiltersArray()
Iterator<Filter>	CompositeFilter.iterator()

Methods in org.apache.logging.log4j.core.filter with parameters of type Filter

Modifier and Type	Method and Description
void	AbstractFilterable.addFilter(Filter filter) Adds a filter.
CompositeFilter	CompositeFilter.addFilter(Filter filter)
void	Filterable.addFilter(Filter filter) Adds a new Filter.
static CompositeFilter	CompositeFilter.createFilters(Filter[] filters) Creates a CompositeFilter.
void	AbstractFilterable.removeFilter(Filter filter) Removes a Filter.
CompositeFilter	CompositeFilter.removeFilter(Filter filter)
void	Filterable.removeFilter(Filter filter) Removes a Filter.
B	AbstractFilterable.Builder.setFilter(Filter filter)
B	AbstractFilterable.Builder.withFilter(Filter filter) Deprecated. Use AbstractFilterable.Builder.setFilter(Filter).

Constructors in org.apache.logging.log4j.core.filter with parameters of type Filter

Constructor and Description
AbstractFilterable(Filter filter)
AbstractFilterable(Filter filter, Property[] propertyArray)