io.siddhi.extension.map.binarypassthrough.sinkmapper

Class BinaryPassThroughSinkMapper

java.lang.Object

io.siddhi.core.stream.output.sink.SinkMapper

io.siddhi.extension.map.binarypassthrough.sinkmapper.BinaryPassThroughSinkMapper

public class BinaryPassThroughSinkMapper
extends io.siddhi.core.stream.output.sink.SinkMapper

Annotation of Siddhi Extension.

 eg:-
  @Extension(
 name = "The name of the extension",
 namespace = "The namespace of the extension",
 description = "The description of the extension (optional).",
 //Sink Mapper configurations
 parameters = {
  @Parameter(name = "The name of the first parameter",
                               description= "The description of the first parameter",
                               type =  "Supported parameter types.
                                        eg:{DataType.STRING, DataType.INT, DataType.LONG etc}",
                               dynamic= "false
                                         (if parameter doesn't depend on each event then dynamic parameter is false.
                                         In Source, only use static parameter)",
                               optional= "true/false, defaultValue= if it is optional then assign a default value
                                          according to the type."),
  @Parameter(name = "The name of the second parameter",
                               description= "The description of the second parameter",
                               type =   "Supported parameter types.
                                         eg:{DataType.STRING, DataType.INT, DataType.LONG etc}",
                               dynamic= "false
                                         (if parameter doesn't depend on each event then dynamic parameter is false.
                                         In Source, only use static parameter)",
                               optional= "true/false, defaultValue= if it is optional then assign a default value
                                         according to the type."),
 },
 //If Sink Mapper system configurations will need then
 systemParameters = {
  @SystemParameter(name = "The name of the first  system parameter",
                                      description="The description of the first system parameter." ,
                                      defaultValue = "the default value of the system parameter.",
                                      possibleParameter="the possible value of the system parameter.",
                               ),
 },
 examples = {
  @Example(syntax = "sample query with Sink Mapper annotation that explain how extension use in Siddhi."
                              description =" The description of the given example's query."
                      ),
 }

 )
 

Constructor Summary

Constructors

Constructor and Description
BinaryPassThroughSinkMapper()

Method Summary

Modifier and Type	Method and Description
Class[]	getOutputEventClasses() Returns the list of classes which this sink can consume.
String[]	getSupportedDynamicOptions() Returns a list of supported dynamic options (that means for each event value of the option can change) by the transport.
void	init(io.siddhi.query.api.definition.StreamDefinition streamDefinition, io.siddhi.core.util.transport.OptionHolder optionHolder, Map<String,io.siddhi.core.util.transport.TemplateBuilder> map, io.siddhi.core.util.config.ConfigReader configReader, io.siddhi.core.config.SiddhiAppContext siddhiAppContext) The initialization method for SinkMapper, which will be called before other methods and validate the all configuration and getting the initial values.
void	mapAndSend(io.siddhi.core.event.Event[] events, io.siddhi.core.util.transport.OptionHolder optionHolder, Map<String,io.siddhi.core.util.transport.TemplateBuilder> map, io.siddhi.core.stream.output.sink.SinkListener sinkListener) Method to map the events and send them to SinkListener for publishing.
void	mapAndSend(io.siddhi.core.event.Event event, io.siddhi.core.util.transport.OptionHolder optionHolder, Map<String,io.siddhi.core.util.transport.TemplateBuilder> map, io.siddhi.core.stream.output.sink.SinkListener sinkListener) Method to map the event and send it to SinkListener for publishing.

Methods inherited from class io.siddhi.core.stream.output.sink.SinkMapper

getType, init, setGroupDeterminer

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryPassThroughSinkMapper

public BinaryPassThroughSinkMapper()

Method Detail

init

public void init(io.siddhi.query.api.definition.StreamDefinition streamDefinition,
                 io.siddhi.core.util.transport.OptionHolder optionHolder,
                 Map<String,io.siddhi.core.util.transport.TemplateBuilder> map,
                 io.siddhi.core.util.config.ConfigReader configReader,
                 io.siddhi.core.config.SiddhiAppContext siddhiAppContext)

The initialization method for SinkMapper, which will be called before other methods and validate the all configuration and getting the initial values.

Specified by:

init in class io.siddhi.core.stream.output.sink.SinkMapper

Parameters:

streamDefinition - containing stream definition bind to the SinkMapper

optionHolder - Option holder containing static and dynamic configuration related to the SinkMapper

map - Unmapped payload for reference

configReader - to read the sink related system configuration.

siddhiAppContext - the context of the SiddhiApp used to get siddhi related utilty functions.

getSupportedDynamicOptions

public String[] getSupportedDynamicOptions()

Returns a list of supported dynamic options (that means for each event value of the option can change) by the transport.

Specified by:

getSupportedDynamicOptions in class io.siddhi.core.stream.output.sink.SinkMapper

Returns:

the list of supported dynamic option keys

getOutputEventClasses

public Class[] getOutputEventClasses()

Returns the list of classes which this sink can consume. Based on the type of the sink, it may be limited to being able to publish specific type of classes. For example, a SinkMapper of type event can convert to CSV file objects of type String or byte.

Specified by:

getOutputEventClasses in class io.siddhi.core.stream.output.sink.SinkMapper

Returns:

array of supported classes , if extension can support of any types of classes then return empty array .

mapAndSend

public void mapAndSend(io.siddhi.core.event.Event[] events,
                       io.siddhi.core.util.transport.OptionHolder optionHolder,
                       Map<String,io.siddhi.core.util.transport.TemplateBuilder> map,
                       io.siddhi.core.stream.output.sink.SinkListener sinkListener)

Method to map the events and send them to SinkListener for publishing.

Specified by:

mapAndSend in class io.siddhi.core.stream.output.sink.SinkMapper

Parameters:

events - Events that need to be mapped

optionHolder - Option holder containing static and dynamic options related to the mapper

map - To build the message payload based on the given template

sinkListener - SinkListener that will be called with the mapped events

mapAndSend

public void mapAndSend(io.siddhi.core.event.Event event,
                       io.siddhi.core.util.transport.OptionHolder optionHolder,
                       Map<String,io.siddhi.core.util.transport.TemplateBuilder> map,
                       io.siddhi.core.stream.output.sink.SinkListener sinkListener)

Method to map the event and send it to SinkListener for publishing.

Specified by:

mapAndSend in class io.siddhi.core.stream.output.sink.SinkMapper

Parameters:

event - Event that need to be mapped

optionHolder - Option holder containing static and dynamic options related to the mapper

map - To build the message payload based on the given template

sinkListener - SinkListener that will be called with the mapped event