java.lang.Object
- joynr.Message
- - joynr.ImmutableMessage

```
public class ImmutableMessage
extends Message
```
This class wraps binary SMRF messages and provides access to the serialized attributes of the message. This type is mainly used by the messaging layers and the message router. MutableMessage objects will be converted to ImmutableMessage objects before they are handed over to a sub-class of MessageRouter. It's not possible to modify a immutable message any more because the content may be signed.

Nested Class Summary
- Nested classes/interfaces inherited from class joynr.Message
  Message.MessageType

Field Summary

Fields
Modifier and Type Field Description

static String DUMMY_CREATOR_USER_ID
- Fields inherited from class joynr.Message
  CUSTOM_HEADER_GBID_KEY, CUSTOM_HEADER_PREFIX, CUSTOM_HEADER_REQUEST_REPLY_ID, HEADER_EFFORT, HEADER_ID, HEADER_MSG_TYPE, HEADER_REPLY_TO

Constructor Summary

Constructors
Constructor Description

ImmutableMessage(byte[] serializedMessage)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,Serializable>`	`getContext()`
`String`	`getCreatorUserId()`
`Map<String,String>`	`getCustomHeaders()`
`String`	`getEffort()`
`Map<String,String>`	`getExtraCustomHeaders()`
`Map<String,String>`	`getHeaders()`
`String`	`getId()`
`int`	`getMessageSize()`
`Map<String,String>`	`getPrefixedCustomHeaders()`
`String`	`getRecipient()`
`String`	`getReplyTo()`
`String`	`getSender()`
`byte[]`	`getSerializedMessage()`
`String`	`getTrackingInfo()`
`long`	`getTtlMs()`
`Message.MessageType`	`getType()`
`byte[]`	`getUnencryptedBody()`
`boolean`	`isCompressed()`
`boolean`	`isEncrypted()`
`boolean`	`isMessageProcessed()`
`boolean`	`isReceivedFromGlobal()`
`boolean`	`isReply()`
`boolean`	`isSigned()`
`boolean`	`isTtlAbsolute()`
`void`	`messageProcessed()`
`void`	`setContext(HashMap<String,Serializable> context)`
`void`	`setCreatorUserId(String userId)`
`void`	`setExtraCustomHeaders(Map<String,String> customHeaders)`
`void`	`setPrefixedExtraCustomHeaders(Map<String,String> prefixedCustomHeaders)`
`void`	`setReceivedFromGlobal(boolean receivedFromGlobal)`
`String`	`toLogMessage()`
`String`	`toString()`

Methods inherited from class joynr.Message
isLocalMessage, setLocalMessage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- DUMMY_CREATOR_USER_ID
```
public static final String DUMMY_CREATOR_USER_ID
```
  See Also:
  
  Constant Field Values

Constructor Detail

ImmutableMessage

public ImmutableMessage(byte[] serializedMessage)
                 throws io.joynr.smrf.EncodingException,
                        io.joynr.smrf.UnsuppportedVersionException

Throws:: io.joynr.smrf.EncodingException; io.joynr.smrf.UnsuppportedVersionException

Method Detail

setPrefixedExtraCustomHeaders

public void setPrefixedExtraCustomHeaders(Map<String,String> prefixedCustomHeaders)

setExtraCustomHeaders

public void setExtraCustomHeaders(Map<String,String> customHeaders)

getExtraCustomHeaders

public Map<String,String> getExtraCustomHeaders()

getSerializedMessage
```
public byte[] getSerializedMessage()
```

getTtlMs
```
public long getTtlMs()
```

isTtlAbsolute
```
public boolean isTtlAbsolute()
```

getSender
```
public String getSender()
```

getRecipient
```
public String getRecipient()
```

getReplyTo
```
public String getReplyTo()
```

getType
```
public Message.MessageType getType()
```

getEffort
```
public String getEffort()
```

setCreatorUserId

public void setCreatorUserId(String userId)

getCreatorUserId
```
public String getCreatorUserId()
```

getUnencryptedBody

public byte[] getUnencryptedBody()
                          throws io.joynr.smrf.EncodingException

Throws:: io.joynr.smrf.EncodingException

getHeaders

public Map<String,String> getHeaders()

getCustomHeaders

public Map<String,String> getCustomHeaders()

getPrefixedCustomHeaders

public Map<String,String> getPrefixedCustomHeaders()

setContext

public void setContext(HashMap<String,Serializable> context)

getContext

public Map<String,Serializable> getContext()

setReceivedFromGlobal

public void setReceivedFromGlobal(boolean receivedFromGlobal)

isReceivedFromGlobal
```
public boolean isReceivedFromGlobal()
```

messageProcessed
```
public void messageProcessed()
```

isMessageProcessed
```
public boolean isMessageProcessed()
```

getId
```
public String getId()
```

isEncrypted
```
public boolean isEncrypted()
```

isSigned
```
public boolean isSigned()
```

isCompressed
```
public boolean isCompressed()
```

getMessageSize
```
public int getMessageSize()
```

toLogMessage
```
public String toLogMessage()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

isReply
```
public boolean isReply()
```

getTrackingInfo
```
public String getTrackingInfo()
```

Class ImmutableMessage

Nested Class Summary

Nested classes/interfaces inherited from class joynr.Message

Field Summary

Fields inherited from class joynr.Message

Constructor Summary

Method Summary

Methods inherited from class joynr.Message

Methods inherited from class java.lang.Object

Field Detail

DUMMY_CREATOR_USER_ID

Constructor Detail

ImmutableMessage

Method Detail

setPrefixedExtraCustomHeaders

setExtraCustomHeaders

getExtraCustomHeaders

getSerializedMessage

getTtlMs

isTtlAbsolute

getSender

getRecipient

getReplyTo

getType

getEffort

setCreatorUserId

getCreatorUserId

getUnencryptedBody

getHeaders

getCustomHeaders

getPrefixedCustomHeaders

setContext

getContext

setReceivedFromGlobal

isReceivedFromGlobal

messageProcessed

isMessageProcessed

getId

isEncrypted

isSigned

isCompressed

getMessageSize

toLogMessage

toString

isReply

getTrackingInfo