Package io.siddhi.core.stream.output.sink

Class LogSink

java.lang.Object

io.siddhi.core.stream.output.sink.Sink

io.siddhi.core.stream.output.sink.LogSink

All Implemented Interfaces:

SinkListener

public class LogSink
extends Sink

Implementation of Sink which can be used as a logger. This will log the output events in the output stream with user specified priority and a prefix

Nested Class Summary

Nested classes/interfaces inherited from class io.siddhi.core.stream.output.sink.Sink

Sink.OnErrorAction

Field Summary

Fields inherited from class io.siddhi.core.stream.output.sink.Sink

isTryingToConnect

Constructor Summary

Constructors

Constructor	Description
LogSink()

Method Summary

Modifier and Type	Method	Description
void	connect()	Called to connect to the backend before events are published
void	destroy()	Called at the end to clean all the resources consumed
void	disconnect()	Called after all publishing is done, or when ConnectionUnavailableException is thrown
protected ServiceDeploymentInfo	exposeServiceDeploymentInfo()	Give information to the deployment about the service exposed by the sink.
String[]	getSupportedDynamicOptions()	Supported dynamic options by the transport
Class[]	getSupportedInputEventClasses()
protected StateFactory<State>	init(io.siddhi.query.api.definition.StreamDefinition outputStreamDefinition, OptionHolder optionHolder, ConfigReader sinkConfigReader, SiddhiAppContext siddhiAppContext)	Will be called for initialing the Sink
void	publish(Object payload, DynamicOptions transportOptions, State s)	Sending events via output transport

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

connectWithRetry, getHandler, getMapper, getServiceDeploymentInfoList, getStreamDefinition, getType, init, initOnlyTransport, isConnected, isStateful, onError, publish, retryPublish, setConnected, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

LogSink

public LogSink()

Method Detail

getSupportedInputEventClasses

public Class[] getSupportedInputEventClasses()

Specified by:

getSupportedInputEventClasses in class Sink

exposeServiceDeploymentInfo

protected ServiceDeploymentInfo exposeServiceDeploymentInfo()

Description copied from class: Sink

Give information to the deployment about the service exposed by the sink.

Specified by:

exposeServiceDeploymentInfo in class Sink

Returns:

ServiceDeploymentInfo Service related information to the deployment

getSupportedDynamicOptions

public String[] getSupportedDynamicOptions()

Description copied from class: Sink

Supported dynamic options by the transport

Specified by:

getSupportedDynamicOptions in class Sink

Returns:

the list of supported dynamic option keys

init

protected StateFactory<State> init(io.siddhi.query.api.definition.StreamDefinition outputStreamDefinition,
                                   OptionHolder optionHolder,
                                   ConfigReader sinkConfigReader,
                                   SiddhiAppContext siddhiAppContext)

Description copied from class: Sink

Will be called for initialing the Sink

Specified by:

init in class Sink

Parameters:

outputStreamDefinition - containing stream definition bind to the Sink

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

sinkConfigReader - this hold the Sink extensions configuration reader.

siddhiAppContext - SiddhiAppContext of the parent siddhi app.

publish

public void publish(Object payload,
                    DynamicOptions transportOptions,
                    State s)
             throws ConnectionUnavailableException

Description copied from class: Sink

Sending events via output transport

Specified by:

publish in class Sink

Parameters:

payload - payload of the event

transportOptions - of the event constructing the payload

s - current state of the sink

Throws:

ConnectionUnavailableException - throw when connections are unavailable.

connect

public void connect()
             throws ConnectionUnavailableException

Description copied from class: Sink

Called to connect to the backend before events are published

Specified by:

connect in class Sink

Throws:

ConnectionUnavailableException - if it cannot connect to the backend

disconnect

public void disconnect()

Description copied from class: Sink

Called after all publishing is done, or when ConnectionUnavailableException is thrown

Specified by:

disconnect in class Sink

destroy

public void destroy()

Description copied from class: Sink

Called at the end to clean all the resources consumed

Specified by:

destroy in class Sink