de.otto.synapse.endpoint

Class DefaultSenderHeadersInterceptor

java.lang.Object

de.otto.synapse.endpoint.DefaultSenderHeadersInterceptor

public class DefaultSenderHeadersInterceptor
extends java.lang.Object

A message interceptor that is able to add some commonly required header attributes in Synapse services.

The DefaultSenderHeadersInterceptor is active by default for all sender endpoints. It can be customized

The property spring.application.name is used to determine the value of the MSG_SENDER_ATTR header attribute. This attribute can be used to identify the origin of a message.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultSenderHeadersInterceptor.Capability Capabilities of the DefaultSenderHeadersInterceptor.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_ID_ATTR
static java.lang.String	MSG_SENDER_ATTR The sender of the message
static java.lang.String	MSG_TIMESTAMP_ATTR

Constructor Summary

Constructors

Constructor and Description
DefaultSenderHeadersInterceptor(SynapseProperties.Sender senderProperties, java.util.Set<DefaultSenderHeadersInterceptor.Capability> capabilities, java.time.Clock clock) Creates an instance of DefaultSenderHeadersInterceptor with enhanced configuration options.
DefaultSenderHeadersInterceptor(SynapseProperties synapseProperties) Creates a new DefaultSenderHeadersInterceptor with default configuration.

Method Summary

Modifier and Type	Method and Description
Message<java.lang.String>	addDefaultHeaders(Message<java.lang.String> message)

Methods inherited from class java.lang.Object

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

Field Detail

MSG_SENDER_ATTR

public static final java.lang.String MSG_SENDER_ATTR

The sender of the message

See Also:

Constant Field Values

MSG_ID_ATTR

public static final java.lang.String MSG_ID_ATTR

See Also:

Constant Field Values

MSG_TIMESTAMP_ATTR

public static final java.lang.String MSG_TIMESTAMP_ATTR

See Also:

Constant Field Values

Constructor Detail

DefaultSenderHeadersInterceptor

public DefaultSenderHeadersInterceptor(SynapseProperties synapseProperties)

Creates a new DefaultSenderHeadersInterceptor with default configuration.

By default, all capabilites are enabled.

Parameters:

synapseProperties - the properties used to configure the interceptor

DefaultSenderHeadersInterceptor

public DefaultSenderHeadersInterceptor(SynapseProperties.Sender senderProperties,
                                       java.util.Set<DefaultSenderHeadersInterceptor.Capability> capabilities,
                                       java.time.Clock clock)

Creates an instance of DefaultSenderHeadersInterceptor with enhanced configuration options.

Parameters:

senderProperties - the properties used to configure the interceptor

capabilities - the enabled capabilities

clock - the clock used to generate timestamp attributes

Method Detail

addDefaultHeaders

@Nullable
 @MessageInterceptor(endpointType=SENDER)
public Message<java.lang.String> addDefaultHeaders(@Nonnull
                                                                                                       Message<java.lang.String> message)