org.openhubframework.openhub.api.asynch

Class AsynchConstants

java.lang.Object

org.openhubframework.openhub.api.asynch.AsynchConstants

public final class AsynchConstants
extends Object

Constants regarding to asynchronous processing.

Author:

Petr Juza

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASYNCH_MSG_HEADER Header name that holds the Boolean if processing is asynchronous (true).
static String	BUSINESS_ERROR_PROP_SUFFIX Suffix of the property name that holds the business Exception, i.e.
static String	CUSTOM_DATA_PROP Property name that holds the custom data (string).
static String	ENTITY_TYPE_HEADER Header value that holds entity type of the object in the message.
static String	ERR_CALLBACK_RES_PROP Property that holds CallbackResponse with FAIL state.
static String	EXCEPTION_ERROR_CODE Property name that holds error code of the failure.
static String	EXCLUDE_FAILED_HEADER Header value that holds flag (true/false) if FAILED state should be considered when guaranteed order is involved.
static String	FUNNEL_VALUE_HEADER Header value that holds funnel value of the message.
static String	GUARANTEED_ORDER_HEADER Header value that holds flag (true/false) if route should be processed in guaranteed order or not.
static String	MSG_HEADER Header name that holds the Message for processing.
static String	MSG_QUEUE_INSERT_HEADER Header name that holds timestamp (long in ms) when message is inserted into queue for next processing.
static String	NO_EFFECT_PROCESS_HEADER Header name that holds the boolean flag, if message processing was with no effect (the message can't be processed because there are no prepared data in DB so far).
static String	OBJECT_ID_HEADER Header value that holds ID of the object in the message.
static String	OPERATION_HEADER Header value that holds target operation name (as string).
static String	SERVICE_HEADER Header value that holds target service identification.
static String	URI_ASYNC_MSG URI for asynchronous message processing (with SEDA).
static String	URI_ASYNCH_IN_MSG Endpoint URI for processing asynchronous incoming message.
static String	URI_CONFIRM_MESSAGE URI of for ensuring the provided message status is confirmed to the source system.
static String	URI_ERROR_FATAL URI of the route that sets current message as FAILED.
static String	URI_ERROR_HANDLING URI of the route that solves error handling.
static String	URI_EX_TRANSLATION URI of the route that translates exceptions.
static String	URI_POST_PROCESS_AFTER_FAILED URI of the route that makes post-processing when message failed.
static String	URI_POST_PROCESS_AFTER_OK URI of the route that makes post-processing after OK message.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_HEADER

public static final String MSG_HEADER

Header name that holds the Message for processing.

See Also:

Constant Field Values

NO_EFFECT_PROCESS_HEADER

public static final String NO_EFFECT_PROCESS_HEADER

Header name that holds the boolean flag, if message processing was with no effect (the message can't be processed because there are no prepared data in DB so far).

See Also:

Constant Field Values

ASYNCH_MSG_HEADER

public static final String ASYNCH_MSG_HEADER

Header name that holds the Boolean if processing is asynchronous (true).

See Also:

Constant Field Values

CUSTOM_DATA_PROP

public static final String CUSTOM_DATA_PROP

Property name that holds the custom data (string).

Custom data can be used for saving arbitrary data for transferring state between more processing calls of the asynchronous message.

See Also:

Constant Field Values

BUSINESS_ERROR_PROP_SUFFIX

public static final String BUSINESS_ERROR_PROP_SUFFIX

Suffix of the property name that holds the business Exception, i.e. exception that means that target system throws expected (business) exception.

Each target system call can generate different exceptions therefore use this constant as suffix for property names.

See Also:

Constant Field Values

SERVICE_HEADER

public static final String SERVICE_HEADER

Header value that holds target service identification.

See Also:

Constant Field Values

OPERATION_HEADER

public static final String OPERATION_HEADER

Header value that holds target operation name (as string).

See Also:

Constant Field Values

OBJECT_ID_HEADER

public static final String OBJECT_ID_HEADER

Header value that holds ID of the object in the message.

Object ID with entity type and operation name are used for identification of "obsolete" messages.

See Also:

Constant Field Values

FUNNEL_VALUE_HEADER

public static final String FUNNEL_VALUE_HEADER

Header value that holds funnel value of the message.

Funnel value serves for filtering messages in the route where should be only one processing message with same funnel value.

See Also:

Constant Field Values

GUARANTEED_ORDER_HEADER

public static final String GUARANTEED_ORDER_HEADER

Header value that holds flag (true/false) if route should be processed in guaranteed order or not.

See Also:

FUNNEL_VALUE_HEADER, EXCLUDE_FAILED_HEADER, Constant Field Values

EXCLUDE_FAILED_HEADER

public static final String EXCLUDE_FAILED_HEADER

Header value that holds flag (true/false) if FAILED state should be considered when guaranteed order is involved.

See Also:

GUARANTEED_ORDER_HEADER, Constant Field Values

ENTITY_TYPE_HEADER

public static final String ENTITY_TYPE_HEADER

Header value that holds entity type of the object in the message.

Entity type with object ID and operation name are used for identification of "obsolete" messages. Entity type isn't mandatory, if combination object ID - operation name is enough.

See Also:

Constant Field Values

ERR_CALLBACK_RES_PROP

public static final String ERR_CALLBACK_RES_PROP

Property that holds CallbackResponse with FAIL state.

See Also:

Constant Field Values

EXCEPTION_ERROR_CODE

public static final String EXCEPTION_ERROR_CODE

Property name that holds error code of the failure.

See Also:

Constant Field Values

URI_EX_TRANSLATION

public static final String URI_EX_TRANSLATION

URI of the route that translates exceptions. It creates uniform error responses - processor translates Camel exceptions to our exception hierarchy. Calls ExceptionTranslator.

See Also:

Constant Field Values

URI_ASYNCH_IN_MSG

public static final String URI_ASYNCH_IN_MSG

Endpoint URI for processing asynchronous incoming message.

See Also:

Constant Field Values

URI_ERROR_HANDLING

public static final String URI_ERROR_HANDLING

URI of the route that solves error handling.

See Also:

Constant Field Values

URI_ERROR_FATAL

public static final String URI_ERROR_FATAL

URI of the route that sets current message as FAILED.

See Also:

Constant Field Values

URI_ASYNC_MSG

public static final String URI_ASYNC_MSG

URI for asynchronous message processing (with SEDA).

See Also:

Constant Field Values

URI_POST_PROCESS_AFTER_OK

public static final String URI_POST_PROCESS_AFTER_OK

URI of the route that makes post-processing after OK message.

See Also:

Constant Field Values

URI_POST_PROCESS_AFTER_FAILED

public static final String URI_POST_PROCESS_AFTER_FAILED

URI of the route that makes post-processing when message failed.

See Also:

Constant Field Values

URI_CONFIRM_MESSAGE

public static final String URI_CONFIRM_MESSAGE

URI of for ensuring the provided message status is confirmed to the source system.

See Also:

Constant Field Values

MSG_QUEUE_INSERT_HEADER

public static final String MSG_QUEUE_INSERT_HEADER

Header name that holds timestamp (long in ms) when message is inserted into queue for next processing. Timestamp serves for measuring of waiting time in queue.

See Also:

Constant Field Values