org.myrobotlab.framework

Class Message

java.lang.Object

org.myrobotlab.framework.Message

All Implemented Interfaces:

java.io.Serializable

public class Message
extends java.lang.Object
implements java.io.Serializable

Author:

GroG FIXME - either a structure interface or a typical java setter getter NO MIX !!

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	apiKey apiKey related to data encoding
static java.lang.String	BLOCKING
java.lang.Object[]	data the data which will be sent to the destination method data payload - if invoking a service request this would be the parameter (list) - this would the return type data if the message is outbound
java.util.HashSet<java.lang.String>	historyList history of the message, its routing stops and Services it passed through.
java.lang.String	method the method which will be invoked on the destination @see Service
long	msgId unique identifier for this message
java.lang.String	msgType
java.lang.String	name destination name of the message
static java.lang.String	RETURN
java.util.HashMap<java.lang.String,java.lang.String>	security
java.lang.String	sender name of the sending Service which sent this Message
java.lang.String	sendingMethod originating source method which generated this Message
java.lang.String	status status is currently used for BLOCKING message calls the current valid state it can be in is null | BLOCKING | RETURN FIXME - this should be msgType not status
java.lang.String	uri the originating uri

Constructor Summary

Constructors

Constructor and Description
Message()
Message(Message other)

Method Summary

Modifier and Type	Method and Description
static Message	createMessage(NameProvider sender, java.lang.String name, java.lang.String method, java.lang.Object data)
static Message	createMessage(NameProvider sender, java.lang.String name, java.lang.String method, java.lang.Object[] data)
java.lang.Object[]	getData()
java.lang.String	getName()
static void	main(java.lang.String[] args)
void	set(Message other)
void	setData(java.lang.Object... params)
void	setName(java.lang.String name)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BLOCKING

public static final java.lang.String BLOCKING

See Also:

Constant Field Values

RETURN

public static final java.lang.String RETURN

See Also:

Constant Field Values

msgId

public long msgId

unique identifier for this message

uri

public java.lang.String uri

the originating uri

apiKey

public java.lang.String apiKey

apiKey related to data encoding

name

public java.lang.String name

destination name of the message

sender

public java.lang.String sender

name of the sending Service which sent this Message

sendingMethod

public java.lang.String sendingMethod

originating source method which generated this Message

historyList

public java.util.HashSet<java.lang.String> historyList

history of the message, its routing stops and Services it passed through. This is important to prevent endless looping of messages. Turns out ArrayList is quicker than HashSet on small sets http://www.javacodegeeks.com /2010/08/java-best-practices-vector-arraylist.html

security

public java.util.HashMap<java.lang.String,java.lang.String> security

status

public java.lang.String status

status is currently used for BLOCKING message calls the current valid state it can be in is null | BLOCKING | RETURN FIXME - this should be msgType not status

msgType

public java.lang.String msgType

method

public java.lang.String method

the method which will be invoked on the destination @see Service

data

public java.lang.Object[] data

the data which will be sent to the destination method data payload - if invoking a service request this would be the parameter (list) - this would the return type data if the message is outbound

Constructor Detail

Message

public Message()

Message

public Message(Message other)

Method Detail

getData

public java.lang.Object[] getData()

getName

public java.lang.String getName()

set

public final void set(Message other)

setData

public final void setData(java.lang.Object... params)

setName

public void setName(java.lang.String name)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createMessage

public static Message createMessage(NameProvider sender,
                                    java.lang.String name,
                                    java.lang.String method,
                                    java.lang.Object[] data)

createMessage

public static Message createMessage(NameProvider sender,
                                    java.lang.String name,
                                    java.lang.String method,
                                    java.lang.Object data)

main

public static void main(java.lang.String[] args)
                 throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException