org.apache.flink.streaming.connectors.nifi

Class NiFiSink<T>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.sink.RichSinkFunction<T>

org.apache.flink.streaming.connectors.nifi.NiFiSink<T>

All Implemented Interfaces:

Serializable, Function, RichFunction, SinkFunction<T>

public class NiFiSink<T>
extends RichSinkFunction<T>

A sink that delivers data to Apache NiFi using the NiFi Site-to-Site client. The sink requires a NiFiDataPacketBuilder which can create instances of NiFiDataPacket from the incoming data.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

SinkFunction.Context<T>

Constructor Summary

Constructors

Constructor and Description
NiFiSink(org.apache.nifi.remote.client.SiteToSiteClientConfig clientConfig, NiFiDataPacketBuilder<T> builder) Construct a new NiFiSink with the given client config and NiFiDataPacketBuilder.

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for the user code.
void	invoke(T value)
void	open(Configuration parameters) Initialization method for the function.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.streaming.api.functions.sink.SinkFunction

invoke

Constructor Detail

NiFiSink

public NiFiSink(org.apache.nifi.remote.client.SiteToSiteClientConfig clientConfig,
                NiFiDataPacketBuilder<T> builder)

Construct a new NiFiSink with the given client config and NiFiDataPacketBuilder.

Parameters:

clientConfig - the configuration for building a NiFi SiteToSiteClient

builder - a builder to produce NiFiDataPackets from incoming data

Method Detail

open

public void open(Configuration parameters)
          throws Exception

Description copied from interface: RichFunction

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The configuration object passed to the function can be used for configuration and initialization. The configuration contains all parameters that were configured on the function in the program composition.

 public class MyMapper extends FilterFunction<String> {

     private String searchString;

     public void open(Configuration parameters) {
         this.searchString = parameters.getString("foo");
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractRichFunction

Parameters:

parameters - The configuration containing the parameters attached to the contract.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

See Also:

Configuration

invoke

public void invoke(T value)
            throws Exception

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: RichFunction

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.