MessageHeader (Sodeac Common 0.5.4 API)

java.lang.Object
- org.sodeac.common.message.MessageHeader

All Implemented Interfaces:

Serializable
```
public class MessageHeader
extends Object
implements Serializable
```
Message Header with common properties for message driven communication.

Author:

Sebastian Palarus

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MESSAGE_HEADER_BOUNDED_CONTEXT`
`static String`	`MESSAGE_HEADER_CONNECTION`
`static String`	`MESSAGE_HEADER_CORRELATION_ID`
`static String`	`MESSAGE_HEADER_DELIVERY_TIME`
`static String`	`MESSAGE_HEADER_DESTINATION`
`static String`	`MESSAGE_HEADER_DOMAIN`
`static String`	`MESSAGE_HEADER_END`
`static String`	`MESSAGE_HEADER_EXPIRATION`
`static String`	`MESSAGE_HEADER_GUARANTEED_DELIVERY`
`static String`	`MESSAGE_HEADER_MESSAGE_FORMAT`
`static String`	`MESSAGE_HEADER_MESSAGE_ID`
`static String`	`MESSAGE_HEADER_MESSAGE_TYPE`
`static String`	`MESSAGE_HEADER_POSITION`
`static String`	`MESSAGE_HEADER_PRIORITY`
`static String`	`MESSAGE_HEADER_PROPERTIES`
`static String`	`MESSAGE_HEADER_QUEUE`
`static String`	`MESSAGE_HEADER_REDELIVERED`
`static String`	`MESSAGE_HEADER_REPLY_TO`
`static String`	`MESSAGE_HEADER_SEQUENCE`
`static String`	`MESSAGE_HEADER_SERVICE`
`static String`	`MESSAGE_HEADER_SESSION`
`static String`	`MESSAGE_HEADER_SIZE`
`static String`	`MESSAGE_HEADER_SOURCE`
`static String`	`MESSAGE_HEADER_TIMESTAMP`
`static String`	`MESSAGE_HEADER_TOPIC`
`static String`	`MESSAGE_HEADER_USER`
`static String`	`MESSAGE_HEADER_WORKFLOW`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MessageHeader`	`addProperty(String key, Object value)` adds a message property
`MessageHeader`	`clearProperties()` clears all message properties
`void`	`dispose()`
`boolean`	`equals(Object obj)`
`MessageHeader`	`generateMessageID()` Autogenerates message id.
`String`	`getBoundedContext()` setter for bounded context
`UUID`	`getConnection()` getter for connection id
`UUID`	`getCorrelationID()` getter for correlation id
`Long`	`getDeliveryTime()` getter for delivery time
`String`	`getDestination()` getter for destination
`String`	`getDomain()` getter for domain
`Boolean`	`getEnd()` setter for end flag
`Long`	`getExpiration()` getter for expiration
`Boolean`	`getGuaranteedDelivery()` getter for guaranteed delivery property
`String`	`getMessageFormat()` getter for message format
`UUID`	`getMessageID()` getter for message id
`String`	`getMessageType()` getter for message type
`Long`	`getPosition()` getter for message position
`Integer`	`getPriority()` getter for message priority
`Set<String>`	`getPropertyKeySet()` getter for message property keyset
`Object`	`getPropertyValue(String key)` returns the value of message property specified by key
`<T> T`	`getPropertyValue(String key, Class<T> type)` returns the typed value of message property specified by key
`String`	`getQueue()` getter for queue
`Boolean`	`getRedelivered()` getter for redelivered property
`String`	`getReplyTo()` getter for reply to property
`Long`	`getSequence()` getter for message sequence
`String`	`getService()` getter for service
`UUID`	`getSession()` getter for session id
`Long`	`getSize()` getter for message size (complete message)
`String`	`getSource()` getter for source
`Long`	`getTimestamp()` getter for timestamp
`String`	`getTopic()` getter for topic
`String`	`getUser()` getter for user
`UUID`	`getWorkflow()` getter for workflow id
`int`	`hashCode()`
`MessageHeader`	`lockAllHeader()` Locks complete message header.
`MessageHeader`	`lockHeader(String messageHeader)` Locks single property of message header.
`static MessageHeader`	`newInstance()` Factory to create new Message Header.
`MessageHeader`	`removeProperty(String key)` removes a message property
`MessageHeader`	`setBoundedContext(String boundedContext)` setter for bounded context
`MessageHeader`	`setConnection(UUID connection)` setter for connection id
`MessageHeader`	`setCorrelationID(UUID correlationID)` setter for correlation id
`MessageHeader`	`setDeliveryTime(Long deliveryTime)` setter for delivery time
`MessageHeader`	`setDestination(String destination)` setter for destination
`MessageHeader`	`setDomain(String domain)` setter for domain
`MessageHeader`	`setEnd(Boolean end)` setter for end flag
`MessageHeader`	`setExpiration(Long expiration)` setter for expiration
`MessageHeader`	`setGuaranteedDelivery(Boolean guaranteedDelivery)` setter for guaranteed delivery property
`MessageHeader`	`setMessageFormat(String messageFormat)` setter for message format
`MessageHeader`	`setMessageType(String messageType)` setter for message type
`MessageHeader`	`setPosition(Long position)` setter for message position
`MessageHeader`	`setPriority(Integer priority)` setter for message priority
`MessageHeader`	`setQueue(String queue)` setter for queue
`MessageHeader`	`setRedelivered(Boolean redelivered)` setter for redelivered property
`MessageHeader`	`setReplyTo(String replyTo)` setter for reply to property
`MessageHeader`	`setSequence(Long sequence)` setter for message sequence
`MessageHeader`	`setService(String service)` setter for service
`MessageHeader`	`setSession(UUID session)` setter for session id
`MessageHeader`	`setSize(Long size)` setter for message size (complete message)
`MessageHeader`	`setSource(String source)` setter for source
`MessageHeader`	`setTimestamp(Long timestamp)` setter for timestamp
`MessageHeader`	`setTopic(String topic)` setter for topic
`MessageHeader`	`setUser(String user)` setter for user
`MessageHeader`	`setWorkflow(UUID workflow)` setter for workflow id

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

- Field Detail
  - MESSAGE_HEADER_MESSAGE_ID
```
public static final String MESSAGE_HEADER_MESSAGE_ID
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_CORRELATION_ID
```
public static final String MESSAGE_HEADER_CORRELATION_ID
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_PRIORITY
```
public static final String MESSAGE_HEADER_PRIORITY
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_GUARANTEED_DELIVERY
```
public static final String MESSAGE_HEADER_GUARANTEED_DELIVERY
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_TIMESTAMP
```
public static final String MESSAGE_HEADER_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_EXPIRATION
```
public static final String MESSAGE_HEADER_EXPIRATION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_CONNECTION
```
public static final String MESSAGE_HEADER_CONNECTION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_SESSION
```
public static final String MESSAGE_HEADER_SESSION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_WORKFLOW
```
public static final String MESSAGE_HEADER_WORKFLOW
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_TOPIC
```
public static final String MESSAGE_HEADER_TOPIC
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_QUEUE
```
public static final String MESSAGE_HEADER_QUEUE
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_MESSAGE_TYPE
```
public static final String MESSAGE_HEADER_MESSAGE_TYPE
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_MESSAGE_FORMAT
```
public static final String MESSAGE_HEADER_MESSAGE_FORMAT
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_SERVICE
```
public static final String MESSAGE_HEADER_SERVICE
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_DOMAIN
```
public static final String MESSAGE_HEADER_DOMAIN
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_BOUNDED_CONTEXT
```
public static final String MESSAGE_HEADER_BOUNDED_CONTEXT
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_DESTINATION
```
public static final String MESSAGE_HEADER_DESTINATION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_USER
```
public static final String MESSAGE_HEADER_USER
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_SOURCE
```
public static final String MESSAGE_HEADER_SOURCE
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_REPLY_TO
```
public static final String MESSAGE_HEADER_REPLY_TO
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_DELIVERY_TIME
```
public static final String MESSAGE_HEADER_DELIVERY_TIME
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_REDELIVERED
```
public static final String MESSAGE_HEADER_REDELIVERED
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_SEQUENCE
```
public static final String MESSAGE_HEADER_SEQUENCE
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_POSITION
```
public static final String MESSAGE_HEADER_POSITION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_SIZE
```
public static final String MESSAGE_HEADER_SIZE
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_END
```
public static final String MESSAGE_HEADER_END
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HEADER_PROPERTIES
```
public static final String MESSAGE_HEADER_PROPERTIES
```
    See Also:
    
    Constant Field Values
- Method Detail
  - newInstance
```
public static MessageHeader newInstance()
```
    Factory to create new Message Header.
    
    Returns:
  - lockAllHeader
```
public MessageHeader lockAllHeader()
```
    Locks complete message header. After this call the header is immutable.
    
    Returns:
    
    message header
  - lockHeader
```
public MessageHeader lockHeader(String messageHeader)
```
    Locks single property of message header. After this call the property is immutable.
    
    Parameters:
    
    messageHeader - affected property
    
    Returns:
    
    message header
  - getMessageID
```
public UUID getMessageID()
```
    getter for message id
    
    Returns:
    
    message id
  - generateMessageID
```
public MessageHeader generateMessageID()
```
    Autogenerates message id.
    
    Returns:
    
    message header
  - getCorrelationID
```
public UUID getCorrelationID()
```
    getter for correlation id
    
    Returns:
    
    correlation id
  - setCorrelationID
```
public MessageHeader setCorrelationID(UUID correlationID)
```
    setter for correlation id
    
    Parameters:
    
    correlationID - correlation id to set
    
    Returns:
    
    message headers
  - getPriority
```
public Integer getPriority()
```
    getter for message priority
    
    Returns:
    
    message header
  - setPriority
```
public MessageHeader setPriority(Integer priority)
```
    setter for message priority
    
    Parameters:
    
    priority - priority to set
    
    Returns:
    
    message header
  - getGuaranteedDelivery
```
public Boolean getGuaranteedDelivery()
```
    getter for guaranteed delivery property
    
    Returns:
    
    guaranteed delivery property
  - setGuaranteedDelivery
```
public MessageHeader setGuaranteedDelivery(Boolean guaranteedDelivery)
```
    setter for guaranteed delivery property
    
    Parameters:
    
    guaranteedDelivery - guaranteed delivery property to set
    
    Returns:
    
    message header
  - getTimestamp
```
public Long getTimestamp()
```
    getter for timestamp
    
    Returns:
    
    timestamp
  - setTimestamp
```
public MessageHeader setTimestamp(Long timestamp)
```
    setter for timestamp
    
    Parameters:
    
    timestamp - timestamp to set
    
    Returns:
    
    message header
  - getExpiration
```
public Long getExpiration()
```
    getter for expiration
    
    Returns:
    
    expiration
  - setExpiration
```
public MessageHeader setExpiration(Long expiration)
```
    setter for expiration
    
    Parameters:
    
    expiration - expiration to set
    
    Returns:
    
    message header
  - getConnection
```
public UUID getConnection()
```
    getter for connection id
    
    Returns:
    
    connection id
  - setConnection
```
public MessageHeader setConnection(UUID connection)
```
    setter for connection id
    
    Parameters:
    
    connection - connection id to set
    
    Returns:
    
    message header
  - getSession
```
public UUID getSession()
```
    getter for session id
    
    Returns:
    
    session id
  - setSession
```
public MessageHeader setSession(UUID session)
```
    setter for session id
    
    Parameters:
    
    session - session id to set
    
    Returns:
    
    message header
  - getWorkflow
```
public UUID getWorkflow()
```
    getter for workflow id
    
    Returns:
    
    workflow id
  - setWorkflow
```
public MessageHeader setWorkflow(UUID workflow)
```
    setter for workflow id
    
    Parameters:
    
    workflow - workflow id to set
    
    Returns:
  - getTopic
```
public String getTopic()
```
    getter for topic
    
    Returns:
    
    topic
  - setTopic
```
public MessageHeader setTopic(String topic)
```
    setter for topic
    
    Parameters:
    
    topic - topic to set
    
    Returns:
    
    message header
  - getQueue
```
public String getQueue()
```
    getter for queue
    
    Returns:
    
    queue
  - setQueue
```
public MessageHeader setQueue(String queue)
```
    setter for queue
    
    Parameters:
    
    queue - queue to set
    
    Returns:
    
    message header
  - getMessageType
```
public String getMessageType()
```
    getter for message type
    
    Returns:
    
    message type
  - setMessageType
```
public MessageHeader setMessageType(String messageType)
```
    setter for message type
    
    Parameters:
    
    messageType - message type to set
    
    Returns:
    
    message header
  - getMessageFormat
```
public String getMessageFormat()
```
    getter for message format
    
    Returns:
    
    message format
  - setMessageFormat
```
public MessageHeader setMessageFormat(String messageFormat)
```
    setter for message format
    
    Parameters:
    
    messageFormat - message format to set
    
    Returns:
    
    message header
  - getService
```
public String getService()
```
    getter for service
    
    Returns:
    
    service
  - setService
```
public MessageHeader setService(String service)
```
    setter for service
    
    Parameters:
    
    service - service to set
    
    Returns:
    
    message header
  - getDomain
```
public String getDomain()
```
    getter for domain
    
    Returns:
    
    domain
  - setDomain
```
public MessageHeader setDomain(String domain)
```
    setter for domain
    
    Parameters:
    
    domain - domain to set
    
    Returns:
    
    message header
  - getBoundedContext
```
public String getBoundedContext()
```
    setter for bounded context
    
    Returns:
    
    bounded context
  - setBoundedContext
```
public MessageHeader setBoundedContext(String boundedContext)
```
    setter for bounded context
    
    Parameters:
    
    boundedContext - bounded context to set
    
    Returns:
    
    message header
  - getDestination
```
public String getDestination()
```
    getter for destination
    
    Returns:
    
    destination
  - setDestination
```
public MessageHeader setDestination(String destination)
```
    setter for destination
    
    Parameters:
    
    destination - destination to set
    
    Returns:
    
    message header
  - getUser
```
public String getUser()
```
    getter for user
    
    Returns:
    
    user
  - setUser
```
public MessageHeader setUser(String user)
```
    setter for user
    
    Parameters:
    
    user - user to set
    
    Returns:
    
    message parameter
  - getSource
```
public String getSource()
```
    getter for source
    
    Returns:
    
    source
  - setSource
```
public MessageHeader setSource(String source)
```
    setter for source
    
    Parameters:
    
    source - source to set
    
    Returns:
    
    message header
  - getReplyTo
```
public String getReplyTo()
```
    getter for reply to property
    
    Returns:
    
    reply to property
  - setReplyTo
```
public MessageHeader setReplyTo(String replyTo)
```
    setter for reply to property
    
    Parameters:
    
    replyTo - reply to property to set
    
    Returns:
    
    message header
  - getDeliveryTime
```
public Long getDeliveryTime()
```
    getter for delivery time
    
    Returns:
    
    delivery time
  - setDeliveryTime
```
public MessageHeader setDeliveryTime(Long deliveryTime)
```
    setter for delivery time
    
    Parameters:
    
    deliveryTime - delivery time to set
    
    Returns:
    
    message header
  - getRedelivered
```
public Boolean getRedelivered()
```
    getter for redelivered property
    
    Returns:
    
    redelivered property
  - setRedelivered
```
public MessageHeader setRedelivered(Boolean redelivered)
```
    setter for redelivered property
    
    Parameters:
    
    redelivered - redelivered property to set
    
    Returns:
    
    message header
  - getSequence
```
public Long getSequence()
```
    getter for message sequence
    
    Returns:
    
    message sequence
  - setSequence
```
public MessageHeader setSequence(Long sequence)
```
    setter for message sequence
    
    Parameters:
    
    sequence - message sequence to set
    
    Returns:
    
    message header
  - getPosition
```
public Long getPosition()
```
    getter for message position
    
    Returns:
    
    message position
  - setPosition
```
public MessageHeader setPosition(Long position)
```
    setter for message position
    
    Parameters:
    
    position - message position to set
    
    Returns:
    
    message header
  - getSize
```
public Long getSize()
```
    getter for message size (complete message)
    
    Returns:
    
    message size
  - setSize
```
public MessageHeader setSize(Long size)
```
    setter for message size (complete message)
    
    Parameters:
    
    size - complete message size to set
    
    Returns:
    
    message header
  - getEnd
```
public Boolean getEnd()
```
    setter for end flag
    
    Returns:
    
    end flag
  - setEnd
```
public MessageHeader setEnd(Boolean end)
```
    setter for end flag
    
    Parameters:
    
    end - end flag to set
    
    Returns:
    
    message header
  - getPropertyKeySet
```
public Set<String> getPropertyKeySet()
```
    getter for message property keyset
    
    Returns:
    
    message property keyset
  - addProperty
```
public MessageHeader addProperty(String key,
                                 Object value)
```
    adds a message property
    
    Parameters:
    
    key - key for property
    
    value - property value
    
    Returns:
    
    message header
  - removeProperty
```
public MessageHeader removeProperty(String key)
```
    removes a message property
    
    Parameters:
    
    key - key of message property to remove
    
    Returns:
    
    message header
  - clearProperties
```
public MessageHeader clearProperties()
```
    clears all message properties
    
    Returns:
    
    message header
  - getPropertyValue
```
public Object getPropertyValue(String key)
```
    returns the value of message property specified by key
    
    Parameters:
    
    key - key of property is to be returned
    
    Returns:
    
    property specified by key
  - getPropertyValue
```
public <T> T getPropertyValue(String key,
                              Class<T> type)
```
    returns the typed value of message property specified by key
    
    Parameters:
    
    key - key of property is to be returned
    
    type - type of property is to be returned
    
    Returns:
    
    typed property specified by key
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - dispose
```
public void dispose()
```

Class MessageHeader

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MESSAGE_HEADER_MESSAGE_ID

MESSAGE_HEADER_CORRELATION_ID

MESSAGE_HEADER_PRIORITY

MESSAGE_HEADER_GUARANTEED_DELIVERY

MESSAGE_HEADER_TIMESTAMP

MESSAGE_HEADER_EXPIRATION

MESSAGE_HEADER_CONNECTION

MESSAGE_HEADER_SESSION

MESSAGE_HEADER_WORKFLOW

MESSAGE_HEADER_TOPIC

MESSAGE_HEADER_QUEUE

MESSAGE_HEADER_MESSAGE_TYPE

MESSAGE_HEADER_MESSAGE_FORMAT

MESSAGE_HEADER_SERVICE

MESSAGE_HEADER_DOMAIN

MESSAGE_HEADER_BOUNDED_CONTEXT

MESSAGE_HEADER_DESTINATION

MESSAGE_HEADER_USER

MESSAGE_HEADER_SOURCE

MESSAGE_HEADER_REPLY_TO

MESSAGE_HEADER_DELIVERY_TIME

MESSAGE_HEADER_REDELIVERED

MESSAGE_HEADER_SEQUENCE

MESSAGE_HEADER_POSITION

MESSAGE_HEADER_SIZE

MESSAGE_HEADER_END

MESSAGE_HEADER_PROPERTIES

Method Detail

newInstance

lockAllHeader

lockHeader

getMessageID

generateMessageID

getCorrelationID

setCorrelationID

getPriority

setPriority

getGuaranteedDelivery

setGuaranteedDelivery

getTimestamp

setTimestamp

getExpiration

setExpiration

getConnection

setConnection

getSession

setSession

getWorkflow

setWorkflow

getTopic

setTopic

getQueue

setQueue

getMessageType

setMessageType

getMessageFormat

setMessageFormat

getService

setService

getDomain

setDomain

getBoundedContext

setBoundedContext

getDestination

setDestination

getUser

setUser

getSource

setSource

getReplyTo

setReplyTo

getDeliveryTime

setDeliveryTime

getRedelivered

setRedelivered