org.sodeac.common.message.dispatcher.api

Interface IMessage<T>

All Known Implementing Classes:

MessageImpl

public interface IMessage<T>

The Message interface provides access to message payload.

Author:

Sebastian Palarus

Method Summary

Modifier and Type	Method and Description
default <A> A	getAdapter(Class<A> adapterClass) get registered adapter
IChannel<?>	getChannel()
MessageHeader	getMessageHeader()
T	getPayload()
Map<String,Object>	getProperties() get immutable deep copy of property-keys IMessage
Object	getProperty(String key) get property for IMessage registered with key
Set<String>	getPropertyKeySet() get set of all property-keys for IMessage
IOnMessageStoreResult	getScheduleResultObject() getter for IOnMessageStoreResult to inform schedule invoker about result
void	removeFromChannel() remove event from parent queue
Object	setProperty(String key, Object value) insert or update property for IMessage

Method Detail

getPayload

T getPayload()

Returns:

message payload

getMessageHeader

MessageHeader getMessageHeader()

Returns:

message header of message

getChannel

IChannel<?> getChannel()

Returns:

parent channel

setProperty

Object setProperty(String key,
                   Object value)

insert or update property for IMessage

Parameters:

key - property key

value - property value

Returns:

overwritten property or null

getProperty

Object getProperty(String key)

get property for IMessage registered with key

Parameters:

key - property key

Returns:

property for IMessage registered with key or null, if absent

getPropertyKeySet

Set<String> getPropertyKeySet()

get set of all property-keys for IMessage

Returns:

set of all property-keys for IMessage

getProperties

Map<String,Object> getProperties()

get immutable deep copy of property-keys IMessage

Returns:

immutable deep copy of property-keys IMessage

getScheduleResultObject

IOnMessageStoreResult getScheduleResultObject()

getter for IOnMessageStoreResult to inform schedule invoker about result

Returns:

schedule result object

getAdapter

default <A> A getAdapter(Class<A> adapterClass)

get registered adapter

Parameters:

adapterClass - type of adapter

Returns:

registered adapter with specified adapterClass

removeFromChannel

void removeFromChannel()

remove event from parent queue