com.yahoo.bullet.pubsub

Class PubSubMessageSerDe

java.lang.Object

com.yahoo.bullet.pubsub.PubSubMessageSerDe

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IdentityPubSubMessageSerDe

public abstract class PubSubMessageSerDe
extends Object
implements Serializable

This allows you to hook into the PubSubMessage serialization and deserialization - for instance, if you want to customize what is done to the message before it is sent to or read in the backend. You can implement a custom version of this to change what the PubSubMessage contains (see toMessage(PubSubMessage)) and invert it when it is read back (see fromMessage(PubSubMessage)). Please note that this is not intended to be applied to messages read from the backend or for signals sent to the backend. You can, for example, use this if you want to customize what is stored in storage or to lazily create a Query in the backend.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BulletConfig	config

Constructor Summary

Constructors

Constructor and Description
PubSubMessageSerDe(BulletConfig config) Constructor.

Method Summary

Modifier and Type	Method and Description
static PubSubMessageSerDe	from(BulletConfig config) Create a PubSubMessageSerDe instance using the class specified in the config file.
abstract PubSubMessage	fromMessage(PubSubMessage message) Takes a converted PubSubMessage and returns the original format of the message.
abstract PubSubMessage	toMessage(PubSubMessage message) Takes a PubSubMessage and returns the new format of the message.
PubSubMessage	toMessage(String id, Query query, String queryString) A helper to submit a query by converting it to a standard PubSubMessage and running it through toMessage(PubSubMessage).

Methods inherited from class java.lang.Object

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

Field Detail

config

protected BulletConfig config

Constructor Detail

PubSubMessageSerDe

public PubSubMessageSerDe(BulletConfig config)

Constructor.

Parameters:

config - The BulletConfig to configure this class.

Method Detail

toMessage

public PubSubMessage toMessage(String id,
                               Query query,
                               String queryString)

A helper to submit a query by converting it to a standard PubSubMessage and running it through toMessage(PubSubMessage).

Parameters:

id - The ID for the query.

query - The Query object to create a PubSubMessage.

queryString - The BQL for the query.

Returns:

A converted PubSubMessage.

toMessage

public abstract PubSubMessage toMessage(PubSubMessage message)

Takes a PubSubMessage and returns the new format of the message. Note that it is allowed to modify the original message. See fromMessage(PubSubMessage) for the inverse.

Parameters:

message - The PubSubMessage to convert.

Returns:

A converted PubSubMessage.

fromMessage

public abstract PubSubMessage fromMessage(PubSubMessage message)

Takes a converted PubSubMessage and returns the original format of the message. Note that it is allowed to modify the original message. See toMessage(PubSubMessage) for the inverse.

Parameters:

message - The PubSubMessage to revert.

Returns:

A reverted PubSubMessage.

from

public static PubSubMessageSerDe from(BulletConfig config)

Create a PubSubMessageSerDe instance using the class specified in the config file.

Parameters:

config - The non-null BulletConfig containing the class name and its settings.

Returns:

An instance of specified class initialized with settings from the input file and defaults.