rsb.protocol

Class ProtocolConversion

java.lang.Object

rsb.protocol.ProtocolConversion

public final class ProtocolConversion
extends Object

A utility class to converter between protocol buffers based classes and our user level types.

Author:

jwienke

Method Summary

Methods

Modifier and Type	Method and Description
static EventIdType.EventId.Builder	createEventIdBuilder(EventId id) Creates a build for the serialization of an EventId, filled with the contents of the given id.
static void	fillNotificationHeader(NotificationType.Notification.Builder notificationBuilder, Event event, String wireSchema) Fills the notification header in a builder instance.
static Event	fromNotification(NotificationType.Notification notification) Build event from RSB Notification.
static Event	fromNotification(NotificationType.Notification notification, ByteBuffer serializedData, ConverterSelectionStrategy<ByteBuffer> converters) Builds an Event instance from a NotificationType.Notification and a ByteBuffer containing the event payload.
static WireContents<ByteBuffer>	serializeEventData(Event event, ConverterSelectionStrategy<ByteBuffer> converters) Serializes the payload contained in an Event instance using a specified ConverterSelectionStrategy.

Methods inherited from class java.lang.Object

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

Method Detail

createEventIdBuilder

public static EventIdType.EventId.Builder createEventIdBuilder(EventId id)

Creates a build for the serialization of an EventId, filled with the contents of the given id.

Parameters:

id - the id to serialize

Returns:

the builder

fillNotificationHeader

public static void fillNotificationHeader(NotificationType.Notification.Builder notificationBuilder,
                          Event event,
                          String wireSchema)

Fills the notification header in a builder instance.

Parameters:

notificationBuilder - the builder where fields should be filled

event - the event to serialize and to greb the data for the notification header from

wireSchema - the wire shema of the serialized data

serializeEventData

public static WireContents<ByteBuffer> serializeEventData(Event event,
                                          ConverterSelectionStrategy<ByteBuffer> converters)
                                                   throws ConversionException

Serializes the payload contained in an Event instance using a specified ConverterSelectionStrategy.

Parameters:

event - event containing the data to serialize

converters - the converters to use

Returns:

the serialized data including the generated wire schema

Throws:

ConversionException - error converting, e.g. no converter available or wrong class

fromNotification

public static Event fromNotification(NotificationType.Notification notification)

Build event from RSB Notification. Excludes user data de-serialization as it is bound to the converter configuration.

Parameters:

notification - NotificationType.Notification instance to deserialize

Returns:

deserialized Event instance

fromNotification

public static Event fromNotification(NotificationType.Notification notification,
                     ByteBuffer serializedData,
                     ConverterSelectionStrategy<ByteBuffer> converters)
                              throws ConversionException

Builds an Event instance from a NotificationType.Notification and a ByteBuffer containing the event payload. This includes the deserialization of the payload using a specified converter strategy.

Parameters:

notification - the notification with the event meta data

serializedData - the serialized data

converters - converter strategy to use for deserializing the data

Returns:

the constructed and complete event including the payload

Throws:

ConversionException - unable to deserialize the data with the specified converter stategy