de.otto.synapse.message.DefaultHeaderAttr Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of synapse-core Show documentation

A library used at otto.de to implement Spring Boot based event-sourcing microservices.

The newest version!

package de.otto.synapse.message;

import de.otto.synapse.configuration.SynapseProperties;

public enum DefaultHeaderAttr implements HeaderAttr {

    /**
     * Unique identifier of the message.
     *
     * 
     * The attribute key is {@code synapse_msg_id}
     * 
     */
    MSG_ID("synapse_msg_id"),
    /**
     * The sender of the message.
     * 
     *     Using the {@link de.otto.synapse.endpoint.DefaultSenderHeadersInterceptor}, the attribute's value
     *     is configured using {@link SynapseProperties.Sender#getName()} and defaults to the value of
     *     property {@code spring.application.name}.
     * 
     * 
     * The attribute key is {@code synapse_msg_sender}
     * 
     */
    MSG_SENDER("synapse_msg_sender"),
    /**
     * The header attribute containing the Kinesis {@code Record#approximateArrivalTimestamp()}
     * to which the message has arrived in Kinesis. Other channel implementations may use this attribute for similar
     * timestamps, as long as the semantics of the property is the met.
     *
     * 
     * The attribute key is {@code synapse_msg_arrival_ts}
     * 
     */
    MSG_ARRIVAL_TS("synapse_msg_arrival_ts"),
    /**
     * The timestamp to which the message was sent.
     * 
     * The attribute key is {@code synapse_msg_sender_ts}
     * 
     */
    MSG_SENDER_TS("synapse_msg_sender_ts"),
    /**
     * The timestamp to which the message was received by a {@link de.otto.synapse.endpoint.receiver.MessageReceiverEndpoint}.
     * 
     * The attribute key is {@code synapse_msg_receiver_ts}
     * 
     */
    MSG_RECEIVER_TS("synapse_msg_receiver_ts");

    private final String key;

    DefaultHeaderAttr(final String key) {
        this.key = key;
    }

    @Override
    public String key() {
        return key;
    }
}