org.apache.flume.sink.http

Class HttpSink

java.lang.Object

org.apache.flume.sink.AbstractSink

org.apache.flume.sink.http.HttpSink

All Implemented Interfaces:

Configurable, LifecycleAware, NamedComponent, Sink

public class HttpSink
extends AbstractSink
implements Configurable

Implementation of an HTTP sink. Events are POSTed to an HTTP / HTTPS endpoint. The error handling behaviour is configurable, and can respond differently depending on the response status returned by the endpoint. Rollback of the Flume transaction, and backoff can be specified globally, then overridden for ranges (or individual) status codes.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flume.Sink

Sink.Status

Constructor Summary

Constructors

Constructor and Description
HttpSink()

Method Summary

Modifier and Type	Method and Description
void	configure(Context context) Request the implementing class to (re)configure itself.
Sink.Status	process() Requests the sink to attempt to consume data from attached channel
void	start() Starts a service or component.
void	stop() Stops a service or component.

Methods inherited from class org.apache.flume.sink.AbstractSink

getChannel, getLifecycleState, getName, setChannel, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSink

public HttpSink()

Method Detail

configure

public final void configure(Context context)

Description copied from interface: Configurable

Request the implementing class to (re)configure itself.

When configuration parameters are changed, they must be reflected by the component asap.

There are no thread safety guarantees on when configure might be called.

Specified by:

configure in interface Configurable

start

public final void start()

Description copied from interface: LifecycleAware

Starts a service or component.

Implementations should determine the result of any start logic and effect the return value of LifecycleAware.getLifecycleState() accordingly.

Specified by:

start in interface LifecycleAware

Overrides:

start in class AbstractSink

stop

public final void stop()

Description copied from interface: LifecycleAware

Stops a service or component.

Implementations should determine the result of any stop logic and effect the return value of LifecycleAware.getLifecycleState() accordingly.

Specified by:

stop in interface LifecycleAware

Overrides:

stop in class AbstractSink

process

public final Sink.Status process()
                          throws EventDeliveryException

Description copied from interface: Sink

Requests the sink to attempt to consume data from attached channel

Note: This method should be consuming from the channel within the bounds of a Transaction. On successful delivery, the transaction should be committed, and on failure it should be rolled back.

Specified by:

process in interface Sink

Returns:

READY if 1 or more Events were successfully delivered, BACKOFF if no data could be retrieved from the channel feeding this sink

Throws:

EventDeliveryException - In case of any kind of failure to deliver data to the next hop destination.