forklift.connectors

Interface ForkliftConnectorI

All Superinterfaces:

LogicalSourceContext

public interface ForkliftConnectorI
extends LogicalSourceContext

An entity that manages consuming and producing to a particular message bus.

Method Summary

Modifier and Type	Method and Description
ForkliftConsumerI	getConsumerForSource(SourceI source) Retrieves the consumer instance that reads from the given source.
default ForkliftSerializer	getDefaultSerializer() Gives the serializer to use for explicitly pre-serializing messages destined to sources on this connector, but which need to be sent by an external application.
ForkliftConsumerI	getQueue(java.lang.String name) Retrieves the consumer instance that reads from the queue with the given name.
ForkliftProducerI	getQueueProducer(java.lang.String name) Gives a producer instance that writes to the given queue.
ForkliftConsumerI	getTopic(java.lang.String name) Retrieves a consumer instance that reads from the topic with the given name.
ForkliftProducerI	getTopicProducer(java.lang.String name) Gives a producer instance that writes to the given topic.
void	start() Starts the given connector.
void	stop() Stops the given connector, invalidating it's current state.
default boolean	supportsOrder() Does this connector support the Order annotation on consumers?
default boolean	supportsResponse() Does this connector support the Response annotation on consumers?

Methods inherited from interface forklift.source.LogicalSourceContext

mapSource

Method Detail

start

void start()
    throws ConnectorException

Starts the given connector. This method must be called for calls to connector methods to be expected to behave properly.

Throws:

ConnectorException - if there was a problem initializing the state of this connector or making a connection

stop

void stop()
   throws ConnectorException

Stops the given connector, invalidating it's current state.

Throws:

ConnectorException - if there was a problem un-initializing the state of this connector

getConsumerForSource

ForkliftConsumerI getConsumerForSource(SourceI source)
                                throws ConnectorException

Retrieves the consumer instance that reads from the given source.

Parameters:

source - the source to read from

Returns:

a consumer that reads from the given source

Throws:

ConnectorException - if an error occurred interacting with the connector

java.lang.RuntimeException - if reading from the given source is not supported

getQueue

ForkliftConsumerI getQueue(java.lang.String name)
                    throws ConnectorException

Retrieves the consumer instance that reads from the queue with the given name.

Parameters:

name - the name of the topic to read from

Returns:

a consumer that reads from the given topic

Throws:

ConnectorException - if an error occurred interacting with the connector

java.lang.RuntimeException - if reading from a queue is not supported

getTopic

ForkliftConsumerI getTopic(java.lang.String name)
                    throws ConnectorException

Retrieves a consumer instance that reads from the topic with the given name.

Parameters:

name - the name of the topic to read from

Returns:

a consumer that reads from the given topic

Throws:

ConnectorException - if an error occurred interacting with the connector

java.lang.RuntimeException - if reading from a topic is not supported

getQueueProducer

ForkliftProducerI getQueueProducer(java.lang.String name)

Gives a producer instance that writes to the given queue.

Parameters:

name - the name of the queue to write to

Returns:

a producer that writes to the given queue

getTopicProducer

ForkliftProducerI getTopicProducer(java.lang.String name)

Gives a producer instance that writes to the given topic.

Parameters:

name - the name of the topic to write to

Returns:

a producer that writes to the given topic

getDefaultSerializer

default ForkliftSerializer getDefaultSerializer()

Gives the serializer to use for explicitly pre-serializing messages destined to sources on this connector, but which need to be sent by an external application.

Returns:

the serializer to use for serializing messages to this connector, or null if there is no explicit serialization method for this connector

supportsOrder

default boolean supportsOrder()

Does this connector support the Order annotation on consumers?

Returns:

whether this connector supports Order

supportsResponse

default boolean supportsResponse()

Does this connector support the Response annotation on consumers?

Returns:

whether this connector supports Response