Package org.apache.flink.streaming.connectors.rabbitmq

Interface RMQDeserializationSchema<T>

Type Parameters:

T - The output type of the RMQSource

All Superinterfaces:

org.apache.flink.api.java.typeutils.ResultTypeQueryable<T>, Serializable

@PublicEvolving
public interface RMQDeserializationSchema<T>
extends Serializable, org.apache.flink.api.java.typeutils.ResultTypeQueryable<T>

Interface for the set of methods required to parse an RMQ delivery.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RMQDeserializationSchema.RMQCollector<T>	Special collector for RMQ messages.

Method Summary

Modifier and Type	Method	Description
void	deserialize(com.rabbitmq.client.Envelope envelope, com.rabbitmq.client.AMQP.BasicProperties properties, byte[] body, RMQDeserializationSchema.RMQCollector<T> collector)	This method takes all the RabbitMQ delivery information supplied by the client extract the data and pass it to the collector.
boolean	isEndOfStream(T nextElement)	Method to decide whether the element signals the end of the stream.
default void	open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context)	Initialization method for the schema.

Methods inherited from interface org.apache.flink.api.java.typeutils.ResultTypeQueryable

getProducedType

Method Detail

open

default void open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context)
           throws Exception

Initialization method for the schema. It is called before the actual working methods deserialize(com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[], org.apache.flink.streaming.connectors.rabbitmq.RMQDeserializationSchema.RMQCollector<T>) and thus suitable for one time setup work.

The provided DeserializationSchema.InitializationContext can be used to access additional features such as e.g. registering user metrics.

Parameters:

context - Contextual information that can be used during initialization.

Throws:

Exception

deserialize

void deserialize(com.rabbitmq.client.Envelope envelope,
                 com.rabbitmq.client.AMQP.BasicProperties properties,
                 byte[] body,
                 RMQDeserializationSchema.RMQCollector<T> collector)
          throws IOException

This method takes all the RabbitMQ delivery information supplied by the client extract the data and pass it to the collector.

NOTICE: The implementation of this method can call RMQDeserializationSchema.RMQCollector.setMessageIdentifiers(java.lang.String, long) with a custom correlation ID and delivery tag if checkpointing and useCorrelationID were enabled in the constructor of RMQSource.

Parameters:

envelope - an AMQP Envelope.

properties - the AMQP.BasicProperties of the message.

body - the message itself as a byte array.

collector - the RMQDeserializationSchema.RMQCollector that will collect the data.

Throws:

IOException - When the body of the message can't be parsed

isEndOfStream

boolean isEndOfStream(T nextElement)

Method to decide whether the element signals the end of the stream. If true is returned the element won't be emitted.

Parameters:

nextElement - The element to test for the end-of-stream signal.

Returns:

True, if the element signals end of stream, false otherwise.