Class EsbEventCodec

java.lang.Object

com.kingsrook.qqq.esb.envelope.EsbEventCodec

public class EsbEventCodec
extends Object

Reads and writes EsbEvents as CloudEvents 1.0 structured JSON (spec section 4), and as JMS TextMessages. Written JSON always has specversion "1.0" and datacontenttype "application/json"; subject, time, qqqcausationid (the causation id, as a CloudEvent extension attribute) and data are left out when null. Values inside data are written as they are, nulls included; Instants and other java.time values are written as ISO-8601 strings. Reading accepts any CloudEvents 1.0 JSON event whose data (if any) is a JSON object; other attributes are ignored. Decimal numbers in data are read as BigDecimal, so they keep their exact value. Anything else throws EsbUnparseableMessageException. Uses one shared, thread-safe Jackson mapper, because building one per message is slow for bulk publishes.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_CAUSATION_ID
static final String	ATTRIBUTE_DATA
static final String	ATTRIBUTE_DATA_BASE64
static final String	ATTRIBUTE_DATA_CONTENT_TYPE
static final String	ATTRIBUTE_ID
static final String	ATTRIBUTE_SOURCE
static final String	ATTRIBUTE_SPEC_VERSION
static final String	ATTRIBUTE_SUBJECT
static final String	ATTRIBUTE_TIME
static final String	ATTRIBUTE_TYPE
static final String	DATA_CONTENT_TYPE
static final String	PROPERTY_ID	//////////////////////////////////////////////////////////
static final String	PROPERTY_SOURCE
static final String	PROPERTY_TYPE
static final String	SPEC_VERSION

Constructor Summary

Constructors

Constructor	Description
EsbEventCodec()

Method Summary

Modifier and Type	Method	Description
static EsbEvent	fromJson(String json)	Read an event from CloudEvents 1.0 structured JSON.
static EsbEvent	fromMessage(jakarta.jms.Message message)	Read an event from a JMS message.
static String	toJson(EsbEvent event)	Write an event as CloudEvents 1.0 structured JSON.
static jakarta.jms.TextMessage	toMessage(jakarta.jms.Session session, EsbEvent event)	Make a JMS TextMessage holding the event's JSON, with the ce_id, ce_type, and ce_source properties set.

Methods inherited from class java.lang.Object

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

Field Details

SPEC_VERSION

public static final String SPEC_VERSION

See Also:

• Constant Field Values

DATA_CONTENT_TYPE

public static final String DATA_CONTENT_TYPE

See Also:

• Constant Field Values

ATTRIBUTE_SPEC_VERSION

public static final String ATTRIBUTE_SPEC_VERSION

See Also:

• Constant Field Values

ATTRIBUTE_ID

public static final String ATTRIBUTE_ID

See Also:

• Constant Field Values

ATTRIBUTE_SOURCE

public static final String ATTRIBUTE_SOURCE

See Also:

• Constant Field Values

ATTRIBUTE_TYPE

public static final String ATTRIBUTE_TYPE

See Also:

• Constant Field Values

ATTRIBUTE_SUBJECT

public static final String ATTRIBUTE_SUBJECT

See Also:

• Constant Field Values

ATTRIBUTE_TIME

public static final String ATTRIBUTE_TIME

See Also:

• Constant Field Values

ATTRIBUTE_DATA_CONTENT_TYPE

public static final String ATTRIBUTE_DATA_CONTENT_TYPE

See Also:

• Constant Field Values

ATTRIBUTE_CAUSATION_ID

public static final String ATTRIBUTE_CAUSATION_ID

See Also:

• Constant Field Values

ATTRIBUTE_DATA

public static final String ATTRIBUTE_DATA

See Also:

• Constant Field Values

ATTRIBUTE_DATA_BASE64

public static final String ATTRIBUTE_DATA_BASE64

See Also:

• Constant Field Values

PROPERTY_ID

public static final String PROPERTY_ID

//////////////////////////////////////////////////////////

See Also:

• Constant Field Values

PROPERTY_TYPE

public static final String PROPERTY_TYPE

See Also:

• Constant Field Values

PROPERTY_SOURCE

public static final String PROPERTY_SOURCE

See Also:

• Constant Field Values

Constructor Details

EsbEventCodec

public EsbEventCodec()

Method Details

toJson

public static String toJson(EsbEvent event)

Write an event as CloudEvents 1.0 structured JSON. Throws IllegalArgumentException if the event is null, is missing its id, source, or type, or has data that can't be written as JSON.

fromJson

public static EsbEvent fromJson(String json)
                         throws EsbUnparseableMessageException

Read an event from CloudEvents 1.0 structured JSON.

Throws:

EsbUnparseableMessageException

toMessage

public static jakarta.jms.TextMessage toMessage(jakarta.jms.Session session,
 EsbEvent event)
                                         throws jakarta.jms.JMSException

Make a JMS TextMessage holding the event's JSON, with the ce_id, ce_type, and ce_source properties set.

Throws:

jakarta.jms.JMSException

fromMessage

public static EsbEvent fromMessage(jakarta.jms.Message message)
                            throws jakarta.jms.JMSException,
EsbUnparseableMessageException

Read an event from a JMS message. Only TextMessages hold events. Throws JMSException if the broker client can't read the message, and EsbUnparseableMessageException if the message isn't an event.

Throws:

jakarta.jms.JMSException

EsbUnparseableMessageException