io.scalecube.cluster.transport.api

Class Message

java.lang.Object

io.scalecube.cluster.transport.api.Message

All Implemented Interfaces:

Externalizable, Serializable

public final class Message
extends Object
implements Externalizable

The Class Message introduces generic protocol used for point to point communication by transport.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER_CORRELATION_ID This header is supposed to be used by application in order to correlate request and response messages.
static String	HEADER_QUALIFIER This header is supposed to be used by application in case if same data type can be reused for several messages so it will allow to qualify the specific message type.
static String	HEADER_SENDER This header represents sender address of type Address.

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
static Message.Builder	builder() Instantiates new empty message builder.
String	correlationId() Returns message correlation id.
<T> T	data() Return the message data, which can be byte array, string or any type.
static Message	from(Message message) Instantiates new message with the same data and headers as at given message.
static Message	fromData(Object data) Instantiates a new message with the given data and without headers.
static Message	fromHeaders(Map<String,String> headers) Instantiates a new message with the given headers and with empty data.
static Message	fromQualifier(String qualifier) Instantiates a new message with the given qualifier header and with empty data.
String	header(String name) Returns header value by given header name.
Map<String,String>	headers() Returns the message headers.
String	qualifier() Returns message qualifier.
void	readExternal(ObjectInput in)
io.scalecube.net.Address	sender() Returns Address of the sender of this message.
String	toString()
static Message.Builder	with(Message message) Instantiates new message builder with the same data and headers as at given message.
static Message.Builder	withData(Object data) Instantiates a new message builder with the given data and without headers.
static Message.Builder	withHeaders(Map<String,String> headers) Instantiates a new message builder with the given headers and with empty data.
static Message.Builder	withQualifier(String qualifier) Instantiates a new message builder with the given qualifier header and with empty data.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

HEADER_QUALIFIER

public static final String HEADER_QUALIFIER

This header is supposed to be used by application in case if same data type can be reused for several messages so it will allow to qualify the specific message type.

See Also:

Constant Field Values

HEADER_CORRELATION_ID

public static final String HEADER_CORRELATION_ID

This header is supposed to be used by application in order to correlate request and response messages.

See Also:

Constant Field Values

HEADER_SENDER

public static final String HEADER_SENDER

This header represents sender address of type Address. It's an address of message originator. This header is optional.

See Also:

Constant Field Values

Constructor Detail

Message

public Message()

Method Detail

fromData

public static Message fromData(Object data)

Instantiates a new message with the given data and without headers.

Parameters:

data - the data to build a message from

Returns:

the built message

withData

public static Message.Builder withData(Object data)

Instantiates a new message builder with the given data and without headers.

Parameters:

data - the initial data for the builder

Returns:

a builder with initial data

fromHeaders

public static Message fromHeaders(Map<String,String> headers)

Instantiates a new message with the given headers and with empty data.

Parameters:

headers - an initial headers to build a message from

Returns:

the built message

withHeaders

public static Message.Builder withHeaders(Map<String,String> headers)

Instantiates a new message builder with the given headers and with empty data.

Parameters:

headers - the initial headers for the builder

Returns:

a builder with initial headers

fromQualifier

public static Message fromQualifier(String qualifier)

Instantiates a new message with the given qualifier header and with empty data.

Parameters:

qualifier - the qualifier to build a message from

Returns:

the built message

withQualifier

public static Message.Builder withQualifier(String qualifier)

Instantiates a new message builder with the given qualifier header and with empty data.

Parameters:

qualifier - the initial qualifier for the builder

Returns:

a builder with initial qualifier

from

public static Message from(Message message)

Instantiates new message with the same data and headers as at given message.

Parameters:

message - the message to be copied

Returns:

a new message, with the same data and headers

with

public static Message.Builder with(Message message)

Instantiates new message builder with the same data and headers as at given message.

Parameters:

message - the message to instantiate the new builder from

Returns:

a builder with initial data and headers from the message

builder

public static Message.Builder builder()

Instantiates new empty message builder.

Returns:

new builder

headers

public Map<String,String> headers()

Returns the message headers.

Returns:

message headers

header

public String header(String name)

Returns header value by given header name.

Parameters:

name - header name

Returns:

the message header by given header name

qualifier

public String qualifier()

Returns message qualifier.

Returns:

qualifier string

correlationId

public String correlationId()

Returns message correlation id.

Returns:

correlation id

data

public <T> T data()

Return the message data, which can be byte array, string or any type.

Type Parameters:

T - data type

Returns:

payload of the message or null if message is without any payload

sender

public io.scalecube.net.Address sender()

Returns Address of the sender of this message.

Returns:

address

toString

public String toString()

Overrides:

toString in class Object

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException