org.apache.ignite.sink.flink

Class IgniteSink<IN>

java.lang.Object

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

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

org.apache.ignite.sink.flink.IgniteSink<IN>

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.streaming.api.functions.sink.SinkFunction<IN>

public class IgniteSink<IN>
extends org.apache.flink.streaming.api.functions.sink.RichSinkFunction<IN>

Apache Flink Ignite sink implemented as a RichSinkFunction.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	cacheName Cache name.
protected Ignite	ignite Ignite instance.
protected String	igniteCfgFile Ignite grid configuration file.
protected IgniteDataStreamer	streamer Ignite Data streamer instance.

Constructor Summary

Constructors

Constructor and Description
IgniteSink(String cacheName, String igniteCfgFile) Default IgniteSink constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Stops streamer.
boolean	getAllowOverwrite() Obtains flag for enabling overwriting existing values in cache.
long	getAutoFlushFrequency() Obtains data flush frequency.
String	getCacheName() Gets the cache name.
Ignite	getIgnite() Gets the Ignite instance.
String	getIgniteConfigFile() Gets Ignite configuration file.
void	invoke(IN in) Transfers data into grid.
void	open(org.apache.flink.configuration.Configuration parameter) Starts streamer.
void	setAllowOverwrite(boolean allowOverwrite) Enables overwriting existing values in cache.
void	setAutoFlushFrequency(long autoFlushFrequency) Specifies data flush frequency into the grid.

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

Field Detail

ignite

protected transient Ignite ignite

Ignite instance.

streamer

protected transient IgniteDataStreamer streamer

Ignite Data streamer instance.

igniteCfgFile

protected final String igniteCfgFile

Ignite grid configuration file.

cacheName

protected final String cacheName

Cache name.

Constructor Detail

IgniteSink

public IgniteSink(String cacheName,
                  String igniteCfgFile)

Default IgniteSink constructor.

Parameters:

cacheName - Cache name.

Method Detail

getCacheName

public String getCacheName()

Gets the cache name.

Returns:

Cache name.

getIgniteConfigFile

public String getIgniteConfigFile()

Gets Ignite configuration file.

Returns:

Configuration file.

getIgnite

public Ignite getIgnite()

Gets the Ignite instance.

Returns:

Ignite instance.

getAutoFlushFrequency

public long getAutoFlushFrequency()

Obtains data flush frequency.

Returns:

Flush frequency.

setAutoFlushFrequency

public void setAutoFlushFrequency(long autoFlushFrequency)

Specifies data flush frequency into the grid.

Parameters:

autoFlushFrequency - Flush frequency.

getAllowOverwrite

public boolean getAllowOverwrite()

Obtains flag for enabling overwriting existing values in cache.

Returns:

True if overwriting is allowed, false otherwise.

setAllowOverwrite

public void setAllowOverwrite(boolean allowOverwrite)

Enables overwriting existing values in cache.

Parameters:

allowOverwrite - Flag value.

open

public void open(org.apache.flink.configuration.Configuration parameter)

Starts streamer.

Specified by:

open in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

open in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

IgniteException - If failed.

close

public void close()

Stops streamer.

Specified by:

close in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

close in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

IgniteException - If failed.

invoke

public void invoke(IN in)

Transfers data into grid. It is called when new data arrives to the sink, and forwards it to IgniteDataStreamer.

Specified by:

invoke in interface org.apache.flink.streaming.api.functions.sink.SinkFunction<IN>

Specified by:

invoke in class org.apache.flink.streaming.api.functions.sink.RichSinkFunction<IN>

Parameters:

in - IN.