org.apache.flume.interceptor

Class RemoveHeaderInterceptor

java.lang.Object

org.apache.flume.interceptor.RemoveHeaderInterceptor

All Implemented Interfaces:

Interceptor

public class RemoveHeaderInterceptor
extends Object
implements Interceptor

This interceptor manipulates Flume event headers, by removing one or many headers. It can remove a statically defined header, headers based on a regular expression or headers in a list. If none of these is defined, or if no header matches the criteria, the Flume events are not modified.
Note that if only one header needs to be removed, specifying it by name provides performance benefits over the other two methods.

Properties:
- .withName (optional): name of the header to remove
- .fromList (optional): list of headers to remove, separated with the separator specified with .from.list.separator
- .fromListSeparator (optional): regular expression used to separate multiple header names in the list specified using .from.list
- .matching (optional): All the headers which names match this regular expression are removed

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoveHeaderInterceptor.Builder Builder which builds new instances of the RemoveHeaderInterceptor.

Method Summary

Modifier and Type	Method and Description
void	close() Perform any closing / shutdown needed by the Interceptor.
void	initialize() Any initialization / startup needed by the Interceptor.
Event	intercept(Event event) Interception of a single Event.
List<Event>	intercept(List<Event> events) Interception of a batch of events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initialize

public void initialize()

Description copied from interface: Interceptor

Any initialization / startup needed by the Interceptor.

Specified by:

initialize in interface Interceptor

See Also:

Interceptor.initialize()

close

public void close()

Description copied from interface: Interceptor

Perform any closing / shutdown needed by the Interceptor.

Specified by:

close in interface Interceptor

See Also:

Interceptor.close()

intercept

public List<Event> intercept(List<Event> events)

Description copied from interface: Interceptor

Interception of a batch of events.

Specified by:

intercept in interface Interceptor

Parameters:

events - Input list of events

Returns:

Output list of events. The size of output list MUST NOT BE GREATER than the size of the input list (i.e. transformation and removal ONLY). Also, this method MUST NOT return null. If all events are dropped, then an empty List is returned.

See Also:

Interceptor.intercept(java.util.List)

intercept

public Event intercept(Event event)

Description copied from interface: Interceptor

Interception of a single Event.

Specified by:

intercept in interface Interceptor

Parameters:

event - Event to be intercepted

Returns:

Original or modified event, or null if the Event is to be dropped (i.e. filtered out).

See Also:

Interceptor.intercept(org.apache.flume.Event)