io.scalecube.services.api

Class ServiceMessage

java.lang.Object

io.scalecube.services.api.ServiceMessage

public final class ServiceMessage
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceMessage.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DATA_FORMAT Default data format.
static String	HEADER_DATA_FORMAT Data format header.
static String	HEADER_DATA_TYPE This is a system header which used by transport for serialization and deserialization purpose.
static String	HEADER_ERROR_TYPE Error type header.
static String	HEADER_QUALIFIER Qualifier header.
static int	NULL_ERROR_TYPE Null value for error type.

Method Summary

Modifier and Type	Method and Description
static ServiceMessage.Builder	builder() Instantiates new empty message builder.
<T> T	data() Return the message data, which can be byte array, string or any type.
String	dataFormat() Returns data format of the message data.
String	dataFormatOrDefault() Returns data format of the message data or default one.
static ServiceMessage	error(String qualifier, int errorType, int errorCode, String errorMessage) Instantiates new message with error qualifier for given error type and specified error code and message.
int	errorType() Returns error type.
static ServiceMessage.Builder	from(ServiceMessage message) Instantiates new message with the same data and headers as at given message.
boolean	hasData()
boolean	hasData(Class<?> dataClass) Verify that this message contains data.
String	header(String name) Returns header value by given header name.
Map<String,String>	headers() Returns the message headers.
boolean	isError() Describes whether the message is an error.
String	qualifier() Returns message's qualifier.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATA_FORMAT

public static final String DEFAULT_DATA_FORMAT

Default data format.

See Also:

Constant Field Values

HEADER_QUALIFIER

public static final String HEADER_QUALIFIER

Qualifier header.

See Also:

Constant Field Values

HEADER_DATA_TYPE

public static final String HEADER_DATA_TYPE

This is a system header which used by transport for serialization and deserialization purpose. It is not supposed to be used by application directly and it is subject to changes in future releases.

See Also:

Constant Field Values

HEADER_DATA_FORMAT

public static final String HEADER_DATA_FORMAT

Data format header.

See Also:

Constant Field Values

HEADER_ERROR_TYPE

public static final String HEADER_ERROR_TYPE

Error type header.

See Also:

Constant Field Values

NULL_ERROR_TYPE

public static final int NULL_ERROR_TYPE

Null value for error type.

See Also:

Constant Field Values

Method Detail

from

public static ServiceMessage.Builder from(ServiceMessage 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

error

public static ServiceMessage error(String qualifier,
                                   int errorType,
                                   int errorCode,
                                   String errorMessage)

Instantiates new message with error qualifier for given error type and specified error code and message.

Parameters:

qualifier - origin qualifier.

errorType - the error type to be used in message qualifier.

errorCode - the error code.

errorMessage - the error message.

Returns:

builder.

builder

public static ServiceMessage.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's qualifier.

Returns:

qualifier string

dataFormat

public String dataFormat()

Returns data format of the message data.

Returns:

data format of the data

dataFormatOrDefault

public String dataFormatOrDefault()

Returns data format of the message data or default one.

Returns:

data format of the data or default one

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

hasData

public boolean hasData()

hasData

public boolean hasData(Class<?> dataClass)

Verify that this message contains data.

Parameters:

dataClass - the expected class of the data

Returns:

true if the data is instance of the dataClass

isError

public boolean isError()

Describes whether the message is an error.

Returns:

true if error, otherwise false.

errorType

public int errorType()

Returns error type. Error type is an identifier of a group of errors.

Returns:

error type if set otherwise -1.

toString

public String toString()

Overrides:

toString in class Object