org.openhubframework.openhub.spi.msg

Interface MessageService

All Known Implementing Classes:

MessageServiceImpl

public interface MessageService

Service for manipulating with Message.

Author:

Petr Juza

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEAN

Method Summary

Methods

Modifier and Type	Method and Description
Message	findEagerMessageById(Long msgId) Finds message by message ID with eager loading.
Message	findMessageByCorrelationId(String correlationId, ExternalSystemExtEnum systemEnum) Finds message by message external system and correlation Id.
Message	findMessageById(Long msgId) Finds message by message ID.
List<Message>	findMessagesByContent(String substring) Finds message by substring in payload property.
int	getCountMessages(MsgStateEnum state, Integer interval) Get count of messages in specific state.
int	getCountProcessingMessagesForFunnel(String funnelValue, int idleInterval, String funnelCompId) Get count of processing messages for specified funnel value and funnel ID.
List<Message>	getMessagesForGuaranteedOrderForFunnel(String funnelValue, int idleInterval, boolean excludeFailedState, String funnelCompId) Gets list of messages with specified funnel value for guaranteed processing order of messages for specified funnel.
List<Message>	getMessagesForGuaranteedOrderForRoute(String funnelValue, boolean excludeFailedState) Gets list of messages with specified funnel value for guaranteed processing order of whole routes.
void	insertMessage(Message message) Inserts new message.
void	insertMessages(Collection<Message> messages) Inserts new messages.
void	setFunnelComponentId(Message msg, String funnelCompId) Sets funnel component identifier to specified message.
void	setStateFailed(Message msg, ErrorExtEnum errCode, String errDesc) Changes state of the message to MsgStateEnum.FAILED.
void	setStateFailed(Message msg, Exception ex, ErrorExtEnum errCode, String customData, Map<String,Object> props) Changes state of the message to MsgStateEnum.FAILED.
void	setStateOk(Message msg, Map<String,Object> props) Changes state of the message to MsgStateEnum.OK.
void	setStatePartlyFailed(Message msg, Exception ex, ErrorExtEnum errCode, String customData, Map<String,Object> props) Changes state of the message to MsgStateEnum.PARTLY_FAILED.
void	setStatePartlyFailedWithoutError(Message msg) Changes state of the message to MsgStateEnum.PARTLY_FAILED but without increasing error count.
void	setStatePostponed(Message msg) Changes state of the message to MsgStateEnum.POSTPONED.
void	setStateProcessing(Message msg) Changes state of the message to MsgStateEnum.PROCESSING.
void	setStateWaiting(Message msg) Changes state of the message to MsgStateEnum.WAITING - only if the message hasn't been already processed.
void	setStateWaitingForResponse(Message msg) Changes state of the message to MsgStateEnum.WAITING_FOR_RES.

Field Detail

BEAN

static final String BEAN

See Also:

Constant Field Values

Method Detail

insertMessage

void insertMessage(Message message)

Inserts new message.

Parameters:

message - message that will be saved

insertMessages

void insertMessages(Collection<Message> messages)

Inserts new messages.

Parameters:

messages - the collection of message

setStateOk

void setStateOk(@Header(value="processingMessage")
              Message msg,
              @Properties
              Map<String,Object> props)

Changes state of the message to MsgStateEnum.OK.

If message is child message then method checks if all child messages of the parent message aren't processed.

Parameters:

msg - the message

props - the exchange properties [property name; property value]

setStateProcessing

void setStateProcessing(Message msg)

Changes state of the message to MsgStateEnum.PROCESSING.

Parameters:

msg - the message

setStateWaiting

void setStateWaiting(@Header(value="processingMessage")
                   Message msg)

Changes state of the message to MsgStateEnum.WAITING - only if the message hasn't been already processed.

Parameters:

msg - the message

setStateWaitingForResponse

void setStateWaitingForResponse(@Header(value="processingMessage")
                              Message msg)

Changes state of the message to MsgStateEnum.WAITING_FOR_RES.

Parameters:

msg - the message

setStatePartlyFailedWithoutError

void setStatePartlyFailedWithoutError(@Header(value="processingMessage")
                                    Message msg)

Changes state of the message to MsgStateEnum.PARTLY_FAILED but without increasing error count.

Parameters:

msg - the message

setStatePartlyFailed

void setStatePartlyFailed(@Header(value="processingMessage")
                        Message msg,
                        Exception ex,
                        @ExchangeProperty(value="exceptionErrorCode")@Nullable
                        ErrorExtEnum errCode,
                        @ExchangeProperty(value="customData")@Nullable
                        String customData,
                        @Properties
                        Map<String,Object> props)

Changes state of the message to MsgStateEnum.PARTLY_FAILED.

Parameters:

msg - the message

ex - the exception

errCode - the error code that can be explicitly defined if needed

customData - the custom data

props - the exchange properties [property name; property value]

setStateFailed

void setStateFailed(@Header(value="processingMessage")
                  Message msg,
                  Exception ex,
                  @ExchangeProperty(value="exceptionErrorCode")@Nullable
                  ErrorExtEnum errCode,
                  @ExchangeProperty(value="customData")@Nullable
                  String customData,
                  @Properties
                  Map<String,Object> props)

Changes state of the message to MsgStateEnum.FAILED.

If message is child message then parent message will be marked as failed too.

Parameters:

msg - the message

ex - the exception

errCode - the error code that can be explicitly defined if needed

customData - the custom data

props - the exchange properties [property name; property value]

setStateFailed

void setStateFailed(Message msg,
                  ErrorExtEnum errCode,
                  String errDesc)

Changes state of the message to MsgStateEnum.FAILED.

If message is child message then parent message will be marked as failed too.

Parameters:

msg - the message

errCode - the error code

errDesc - the error description

findMessageById

@Nullable
Message findMessageById(Long msgId)

Finds message by message ID.

Parameters:

msgId - the message ID

Returns:

message or null if not found message with specified ID

findEagerMessageById

@Nullable
Message findEagerMessageById(Long msgId)

Finds message by message ID with eager loading.

Parameters:

msgId - the message ID

Returns:

message or null if not found message with specified ID

findMessageByCorrelationId

@Nullable
Message findMessageByCorrelationId(String correlationId,
                                          @Nullable
                                          ExternalSystemExtEnum systemEnum)

Finds message by message external system and correlation Id. If system parameter is null then messages are searched by correlation id only.

Parameters:

correlationId - the correlation ID

systemEnum - the external system

Returns:

message or null if not found message with specified correlation ID

findMessagesByContent

List<Message> findMessagesByContent(String substring)

Finds message by substring in payload property.

Parameters:

substring - the substring of payload property

Returns:

list of messages or empty list if not found messages with substring in payload property

getCountMessages

int getCountMessages(MsgStateEnum state,
                   @Nullable
                   Integer interval)

Get count of messages in specific state.

Parameters:

state - State of message

interval - searching messages updated after this interval (in seconds)

Returns:

count of messages

getCountProcessingMessagesForFunnel

int getCountProcessingMessagesForFunnel(String funnelValue,
                                      int idleInterval,
                                      String funnelCompId)

Get count of processing messages for specified funnel value and funnel ID.

Parameters:

funnelValue - the funnel value

idleInterval - interval (in seconds) that determines how long can be message processing

funnelCompId - the funnel component ID

Returns:

count of processing messages

getMessagesForGuaranteedOrderForRoute

List<Message> getMessagesForGuaranteedOrderForRoute(String funnelValue,
                                                  boolean excludeFailedState)

Gets list of messages with specified funnel value for guaranteed processing order of whole routes.

Parameters:

funnelValue - the funnel value

excludeFailedState - FAILED state is used by default; use true if you want to exclude FAILED state

Returns:

list of messages ordered by message timestamp

getMessagesForGuaranteedOrderForFunnel

List<Message> getMessagesForGuaranteedOrderForFunnel(String funnelValue,
                                                   int idleInterval,
                                                   boolean excludeFailedState,
                                                   String funnelCompId)

Gets list of messages with specified funnel value for guaranteed processing order of messages for specified funnel.

Parameters:

funnelValue - the funnel value

idleInterval - interval (in seconds) that determines how long can message be processing

excludeFailedState - FAILED state is used by default; use true if you want to exclude FAILED state

funnelCompId - the funnel component ID

Returns:

list of messages ordered by message timestamp

setStatePostponed

void setStatePostponed(@Header(value="processingMessage")
                     Message msg)

Changes state of the message to MsgStateEnum.POSTPONED.

Parameters:

msg - the message

setFunnelComponentId

void setFunnelComponentId(Message msg,
                        String funnelCompId)

Sets funnel component identifier to specified message.

Parameters:

msg - the message

funnelCompId - the funnel component ID