Message (OpenHub Framework 1.0.0 API)

java.lang.Object
- org.openhubframework.openhub.api.entity.Message

All Implemented Interfaces:

HumanReadable
```
@Entity
public class Message
extends Object
implements HumanReadable
```
Input asynchronous message.

Author:

Petr Juza

Field Summary

Fields
Modifier and Type Field and Description

static String ERR_DESC_SEPARATOR
Separator that separates business error descriptions.

Fields
Modifier and Type	Field and Description
`static String`	`ERR_DESC_SEPARATOR` Separator that separates business error descriptions.

Constructor Summary

Constructors
Constructor and Description
`Message()` Empty (default) constructor.
`Message(ExternalSystemExtEnum sourceSystem, String correlationId)` Creates message with specified source system and correlation ID.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`boolean`	`existHardParent()` Is there message that has parent message with `hard` binding?
`String`	`getBusinessError()` Gets business error descriptions.
`List<String>`	`getBusinessErrorList()` Gets list of business error descriptions.
`String`	`getCorrelationId()` Gets correlation ID that serves for pairing asynchronous request and response.
`String`	`getCustomData()` Gets custom data.
`EntityTypeExtEnum`	`getEntityType()` Gets type of the entity that is being changed.
`String`	`getEnvelope()` Gets the whole SOAP envelope (= the full original request: SOAP headers, SOAP body).
`List<ExternalCall>`	`getExternalCalls()` Gets the set of referenced external calls.
`int`	`getFailedCount()` Gets number of failed processing.
`String`	`getFailedDesc()` Gets error description if last try was unsuccessful with error.
`ErrorExtEnum`	`getFailedErrorCode()` Gets error code if last try was unsuccessful with error.
`String`	`getFunnelComponentId()` Gets funnel component identifier.
`String`	`getFunnelValue()` Gets value for funnel filtering - you can have funnel that will ensure that there is only one processing message with same funnel value.
`Date`	`getLastUpdateTimestamp()` Gets timestamp when the entity was changed last time.
`Long`	`getMsgId()` Gets unique message ID.
`Date`	`getMsgTimestamp()` Gets timestamp from source system.
`String`	`getObjectId()` Gets object ID that will be changed during message processing.
`String`	`getOperationName()` Gets operation name, e.g.
`BindingTypeEnum`	`getParentBindingType()` Gets type of binding between parent and child message.
`Long`	`getParentMsgId()` Gets ID of the parent message (if any).
`String`	`getPayload()` Gets body content (XML by default).
`String`	`getProcessId()` Gets process ID that serves for pairing more requests with one process.
`int`	`getProcessingPriority()`
`Date`	`getReceiveTimestamp()` Gets timestamp when message was received.
`List<Request>`	`getRequests()` Gets the set of referenced logged requests.
`ServiceExtEnum`	`getService()` Gets service name, e.g.
`ExternalSystemExtEnum`	`getSourceSystem()` Gets source system.
`Date`	`getStartProcessTimestamp()` Gets timestamp when the message started processing.
`MsgStateEnum`	`getState()` Gets message state.
`int`	`hashCode()`
`boolean`	`isExcludeFailedState()` Returns `true` if FAILED state should be excluded from guaranteed order.
`boolean`	`isGuaranteedOrder()` Gets flag (true/false) if route should be processed in guaranteed order or not.
`boolean`	`isParentMessage()` Is parent message that has child messages? Note: binding between child and parent message must be `hard`.
`void`	`setBusinessError(String businessError)`
`void`	`setCorrelationId(String correlationId)`
`void`	`setCustomData(String customData)`
`void`	`setEntityType(EntityTypeExtEnum entityType)`
`void`	`setEnvelope(String envelope)`
`void`	`setExcludeFailedState(boolean excludeFailedState)`
`void`	`setFailedCount(int failedCount)`
`void`	`setFailedDesc(String failedDesc)`
`void`	`setFailedErrorCode(ErrorExtEnum failedErrorCode)`
`void`	`setFunnelComponentId(String funnelComponentId)`
`void`	`setFunnelValue(String funnelValue)`
`void`	`setGuaranteedOrder(boolean guaranteedOrder)`
`void`	`setLastUpdateTimestamp(Date lastUpdateTimestamp)`
`void`	`setMsgId(Long msgId)`
`void`	`setMsgTimestamp(Date msgTimestamp)`
`void`	`setObjectId(String objectId)`
`void`	`setOperationName(String operationName)`
`void`	`setParentBindingType(BindingTypeEnum parentBindingType)`
`void`	`setParentMessage(boolean parentMessage)`
`void`	`setParentMsgId(Long parentMsgId)`
`void`	`setPayload(String payload)`
`void`	`setProcessId(String processId)`
`void`	`setProcessingPriority(int processingPriority)` Sets priority of processing this message.
`void`	`setReceiveTimestamp(Date receiveTimestamp)`
`void`	`setService(ServiceExtEnum service)`
`void`	`setSourceSystem(ExternalSystemExtEnum sourceSystem)`
`void`	`setStartProcessTimestamp(Date startProcessTimestamp)`
`void`	`setState(MsgStateEnum state)`
`String`	`toHumanString()` Returns human readable entity identification with start and end round brackets.
`String`	`toString()`

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

- Field Detail
  - ERR_DESC_SEPARATOR
```
public static final String ERR_DESC_SEPARATOR
```
    Separator that separates business error descriptions.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Message
```
public Message()
```
    Empty (default) constructor.
  - Message
```
public Message(ExternalSystemExtEnum sourceSystem,
       String correlationId)
```
    Creates message with specified source system and correlation ID.
    
    Parameters:
    sourceSystem - the source system
    correlationId - the correlation ID
- Method Detail
  - getMsgId
```
public Long getMsgId()
```
    Gets unique message ID.
    
    Returns:
    message ID
  - setMsgId
```
public void setMsgId(Long msgId)
```
  - getMsgTimestamp
```
public Date getMsgTimestamp()
```
    Gets timestamp from source system.
    
    Returns:
    timestamp
  - setMsgTimestamp
```
public void setMsgTimestamp(Date msgTimestamp)
```
  - getReceiveTimestamp
```
public Date getReceiveTimestamp()
```
    Gets timestamp when message was received. This timestamp determines the order of next processing.
    
    Returns:
    timestamp
  - setReceiveTimestamp
```
public void setReceiveTimestamp(Date receiveTimestamp)
```
  - getService
```
public ServiceExtEnum getService()
```
    Gets service name, e.g. customer.
    
    Returns:
    service name
  - setService
```
public void setService(ServiceExtEnum service)
```
  - getOperationName
```
public String getOperationName()
```
    Gets operation name, e.g. createCustomer.
    
    Returns:
    op. name
  - setOperationName
```
public void setOperationName(String operationName)
```
  - getObjectId
```
@Nullable
public String getObjectId()
```
    Gets object ID that will be changed during message processing. This attribute serves for finding messages in the queue which deals with identical object.
    
    Returns:
    object ID
    See Also:
    getEntityTypeInternal()
  - setObjectId
```
public void setObjectId(@Nullable
               String objectId)
```
  - getEntityType
```
@Nullable
public EntityTypeExtEnum getEntityType()
```
    Gets type of the entity that is being changed.
    In general it's enough to detect identical changed data by objectId and operation name but there are few different operations which can change the same data (e.g. setCustomer, setCustomerExt).
    If defined then it will be used for "obsolete operation call" detection instead of operation name.
    
    Returns:
    entity type
    See Also:
    getObjectId()
  - setEntityType
```
public void setEntityType(@Nullable
                 EntityTypeExtEnum entityType)
```
  - getCorrelationId
```
public String getCorrelationId()
```
    Gets correlation ID that serves for pairing asynchronous request and response.
    
    Returns:
    correlation ID
  - setCorrelationId
```
public void setCorrelationId(String correlationId)
```
  - getProcessId
```
@Nullable
public String getProcessId()
```
    Gets process ID that serves for pairing more requests with one process.
    
    Returns:
    process ID
  - setProcessId
```
public void setProcessId(@Nullable
                String processId)
```
  - getPayload
```
public String getPayload()
```
    Gets body content (XML by default).
    
    Returns:
    body content
  - setPayload
```
public void setPayload(String payload)
```
  - getEnvelope
```
@Nullable
public String getEnvelope()
```
    Gets the whole SOAP envelope (= the full original request: SOAP headers, SOAP body).
    
    Returns:
    the envelope; can be null because it's possible to turn off saving the envelope with regards to performance
  - setEnvelope
```
public void setEnvelope(@Nullable
               String envelope)
```
  - getSourceSystem
```
public ExternalSystemExtEnum getSourceSystem()
```
    Gets source system.
    
    Returns:
    source system
  - setSourceSystem
```
public void setSourceSystem(ExternalSystemExtEnum sourceSystem)
```
  - getState
```
public MsgStateEnum getState()
```
    Gets message state.
    
    Returns:
    msg state
  - setState
```
public void setState(MsgStateEnum state)
```
  - getStartProcessTimestamp
```
public Date getStartProcessTimestamp()
```
    Gets timestamp when the message started processing. When message starts repeatably then this time is valid for last processing.
    
    Returns:
    start date of processing
  - setStartProcessTimestamp
```
public void setStartProcessTimestamp(Date startProcessTimestamp)
```
  - getFailedCount
```
public int getFailedCount()
```
    Gets number of failed processing.
    
    Returns:
    number of failed processing
  - setFailedCount
```
public void setFailedCount(int failedCount)
```
  - getFailedErrorCode
```
@Nullable
public ErrorExtEnum getFailedErrorCode()
```
    Gets error code if last try was unsuccessful with error.
    Note: there can be only one error during message processing because next processing is stopped when an error occurred.
    
    Returns:
    error code
  - setFailedErrorCode
```
public void setFailedErrorCode(@Nullable
                      ErrorExtEnum failedErrorCode)
```
  - getFailedDesc
```
@Nullable
public String getFailedDesc()
```
    Gets error description if last try was unsuccessful with error.
    
    Returns:
    error description
  - setFailedDesc
```
public void setFailedDesc(@Nullable
                 String failedDesc)
```
  - getLastUpdateTimestamp
```
@Nullable
public Date getLastUpdateTimestamp()
```
    Gets timestamp when the entity was changed last time.
    
    Returns:
    timestamp
  - setLastUpdateTimestamp
```
public void setLastUpdateTimestamp(@Nullable
                          Date lastUpdateTimestamp)
```
  - getCustomData
```
@Nullable
public String getCustomData()
```
    Gets custom data.
    Custom data can be used for saving arbitrary data for transferring state between more processing calls of the asynchronous message.
    
    Returns:
    the custom data
  - setCustomData
```
public void setCustomData(@Nullable
                 String customData)
```
  - getBusinessError
```
@Nullable
public String getBusinessError()
```
    Gets business error descriptions.
    During processing of asynchronous message can be collected lot of business errors which is suitable to present to source (callee) system (for example when we want to create new customer and this customer doesn't have valid customer number).
    Each error description is separated by "||".
    
    Returns:
    business error descriptions
  - getBusinessErrorList
```
public List<String> getBusinessErrorList()
```
    Gets list of business error descriptions.
    
    Returns:
    list of descriptions
  - setBusinessError
```
public void setBusinessError(@Nullable
                    String businessError)
```
  - getParentMsgId
```
@Nullable
public Long getParentMsgId()
```
    Gets ID of the parent message (if any).
    
    Returns:
    parent message ID
    See Also:
    getParentBindingType()
  - setParentMsgId
```
public void setParentMsgId(@Nullable
                  Long parentMsgId)
```
  - getParentBindingType
```
@Nullable
public BindingTypeEnum getParentBindingType()
```
    Gets type of binding between parent and child message.
    
    Returns:
    binding type
    See Also:
    getParentMsgId()
  - setParentBindingType
```
public void setParentBindingType(@Nullable
                        BindingTypeEnum parentBindingType)
```
  - existHardParent
```
public boolean existHardParent()
```
    Is there message that has parent message with hard binding?
    
    Returns:
    true for hard-binding parent message otherwise false
  - isParentMessage
```
public boolean isParentMessage()
```
    Is parent message that has child messages?
    Note: binding between child and parent message must be hard.
    
    Returns:
    true when this message is parent, otherwise false
  - setParentMessage
```
public void setParentMessage(boolean parentMessage)
```
  - getFunnelValue
```
public String getFunnelValue()
```
    Gets value for funnel filtering - you can have funnel that will ensure that there is only one processing message with same funnel value.
    
    Returns:
    funnel value
    See Also:
    getFunnelComponentId()
  - setFunnelValue
```
public void setFunnelValue(String funnelValue)
```
  - getFunnelComponentId
```
public String getFunnelComponentId()
```
    Gets funnel component identifier. Each funnel has unique identifier that says where is route currently being processed.
    
    Returns:
    funnel component identifier
    See Also:
    getFunnelValue()
  - setFunnelComponentId
```
public void setFunnelComponentId(String funnelComponentId)
```
  - isGuaranteedOrder
```
public boolean isGuaranteedOrder()
```
    Gets flag (true/false) if route should be processed in guaranteed order or not.
    
    Returns:
    true for guaranteed order otherwise false
    See Also:
    getFunnelValue(), isExcludeFailedState()
  - setGuaranteedOrder
```
public void setGuaranteedOrder(boolean guaranteedOrder)
```
  - isExcludeFailedState
```
public boolean isExcludeFailedState()
```
    Returns true if FAILED state should be excluded from guaranteed order. FAILED state is used for guaranteed order by default;
    This option has influence only if guaranteed processing order is enabled.
    
    Returns:
    true if FAILED state should be excluded
    See Also:
    isGuaranteedOrder()
  - setExcludeFailedState
```
public void setExcludeFailedState(boolean excludeFailedState)
```
  - getExternalCalls
```
public List<ExternalCall> getExternalCalls()
```
    Gets the set of referenced external calls.
    
    Returns:
    the set of referenced external calls
  - getRequests
```
public List<Request> getRequests()
```
    Gets the set of referenced logged requests.
    
    Returns:
    the set of referenced logged requests
  - getProcessingPriority
```
public int getProcessingPriority()
```
  - setProcessingPriority
```
public void setProcessingPriority(int processingPriority)
```
    Sets priority of processing this message. The higher number the higher priority.
    
    Parameters:
    processingPriority - the priority number
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toHumanString
```
public String toHumanString()
```
    Description copied from interface: HumanReadable
    
    Returns human readable entity identification with start and end round brackets.
    
    Specified by:
    
    toHumanString in interface HumanReadable
    
    Returns:
    entity identification

Class Message

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERR_DESC_SEPARATOR

Constructor Detail

Message

Message

Method Detail

getMsgId

setMsgId

getMsgTimestamp

setMsgTimestamp

getReceiveTimestamp

setReceiveTimestamp

getService

setService

getOperationName

setOperationName

getObjectId

setObjectId

getEntityType

setEntityType

getCorrelationId

setCorrelationId

getProcessId

setProcessId

getPayload

setPayload

getEnvelope

setEnvelope

getSourceSystem

setSourceSystem

getState

setState

getStartProcessTimestamp

setStartProcessTimestamp

getFailedCount

setFailedCount

getFailedErrorCode

setFailedErrorCode

getFailedDesc

setFailedDesc

getLastUpdateTimestamp

setLastUpdateTimestamp

getCustomData

setCustomData

getBusinessError

getBusinessErrorList

setBusinessError

getParentMsgId

setParentMsgId

getParentBindingType

setParentBindingType

existHardParent

isParentMessage

setParentMessage

getFunnelValue

setFunnelValue

getFunnelComponentId

setFunnelComponentId

isGuaranteedOrder

setGuaranteedOrder

isExcludeFailedState

setExcludeFailedState

getExternalCalls

getRequests

getProcessingPriority

setProcessingPriority

equals

hashCode

toString

toHumanString