Package org.frankframework.extensions.kafka

Class KafkaSender

java.lang.Object

org.frankframework.extensions.kafka.AbstractKafkaFacade

org.frankframework.extensions.kafka.KafkaSender

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, ISender, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Category(EXPERIMENTAL)
@ConfigurationWarning("Experimental and under development. Do not use unless you wish to participate in this development.")
public class KafkaSender
extends AbstractKafkaFacade
implements ISender

Experimental ISender for sending messages to a Kafka instance. The Kafka integration is still under development so do not currently use unless you wish to participate in this development.

Field Summary

Fields inherited from class org.frankframework.extensions.kafka.AbstractKafkaFacade

properties

Constructor Summary

Constructors

Constructor	Description
KafkaSender()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
String	getPhysicalDestinationName()
SenderResult	sendMessage(Message message, PipeLineSession session)	Send a message to some destination (as configured in the Sender object).
void	start()	This method will be called to start the sender.
void	stop()	Stop/close the sender and deallocate resources.

Methods inherited from class org.frankframework.extensions.kafka.AbstractKafkaFacade

checkConnection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.ISender

consumesSessionVariable, isSynchronous, sendMessageOrThrow

Methods inherited from interface org.frankframework.core.NameAware

setName

Constructor Details

KafkaSender

public KafkaSender()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractKafkaFacade

Throws:

ConfigurationException - in case it was not able to configure the component.

start

public void start()

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

start in interface ISender

stop

public void stop()

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

stop in interface ISender

sendMessage

@Nonnull
public SenderResult sendMessage(@Nonnull
 Message message,
 @Nonnull
 PipeLineSession session)
                         throws SenderException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination