de.otto.synapse.endpoint.MessageInterceptorRegistration 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
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.endpoint;
import com.google.common.collect.ImmutableSet;
import de.otto.synapse.endpoint.receiver.AbstractMessageReceiverEndpoint;
import de.otto.synapse.endpoint.sender.AbstractMessageSenderEndpoint;
import jakarta.annotation.Nonnull;
import org.springframework.core.Ordered;
import java.util.EnumSet;
import java.util.Objects;
import java.util.Set;
import java.util.regex.Pattern;
import static com.google.common.collect.ImmutableSet.copyOf;
import static java.util.Objects.requireNonNull;
import static java.util.regex.Pattern.compile;
/**
* Information about the channels that should be intercepted by a {@link MessageInterceptor}.
*/
public class MessageInterceptorRegistration implements Ordered {
private static final Pattern MATCH_ALL = compile(".*");
private final Pattern channelNamePattern;
private final MessageInterceptor interceptor;
private final ImmutableSet enabledEndpointTypes;
private final int order;
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} in all channels,
* at the {@link AbstractMessageSenderEndpoint sender-side} as well as at the
* {@link AbstractMessageReceiverEndpoint receiver-side}.
*
* @param interceptor the MessageInterceptor used to intercept messages
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration allChannelsWith(final @Nonnull MessageInterceptor interceptor) {
return new MessageInterceptorRegistration(MATCH_ALL, interceptor, EnumSet.allOf(EndpointType.class), LOWEST_PRECEDENCE);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} in all channels,
* at the {@link AbstractMessageSenderEndpoint sender-side} as well as at the
* {@link AbstractMessageReceiverEndpoint receiver-side}.
*
* @param interceptor the MessageInterceptor used to intercept messages
* @param order the {@link Ordered order} of the interceptor. Highest precedence interceptors (lowest order value)
* will be executed last.
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration allChannelsWith(final @Nonnull MessageInterceptor interceptor, final int order) {
return new MessageInterceptorRegistration(MATCH_ALL, interceptor, EnumSet.allOf(EndpointType.class), order);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} in all channels
* with names matching the {@code channelNamePattern},
* at the {@link AbstractMessageSenderEndpoint sender-side} as well as at the
* {@link AbstractMessageReceiverEndpoint receiver-side}.
*
* @param channelNamePattern the regexp used to match channel names. Only channels with matching names will be intercepted.
* @param interceptor the MessageInterceptor used to intercept messages
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration matchingChannelsWith(final @Nonnull String channelNamePattern,
final @Nonnull MessageInterceptor interceptor) {
return new MessageInterceptorRegistration(compile(channelNamePattern), interceptor, EnumSet.allOf(EndpointType.class), LOWEST_PRECEDENCE);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} in all channels
* with names matching the {@code channelNamePattern},
* at the {@link AbstractMessageSenderEndpoint sender-side} as well as at the
* {@link AbstractMessageReceiverEndpoint receiver-side}.
*
* @param channelNamePattern the regexp used to match channel names. Only channels with matching names will be intercepted.
* @param interceptor the MessageInterceptor used to intercept messages
* @param order the {@link Ordered order} of the interceptor. Highest precedence interceptors (lowest order value)
* will be executed last.
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration matchingChannelsWith(final @Nonnull String channelNamePattern,
final @Nonnull MessageInterceptor interceptor,
final int order) {
return new MessageInterceptorRegistration(compile(channelNamePattern), interceptor, EnumSet.allOf(EndpointType.class), order);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} at the
* {@link AbstractMessageReceiverEndpoint receiver-side} of all channels.
*
* @param interceptor the MessageInterceptor used to intercept messages
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration receiverChannelsWith(final @Nonnull MessageInterceptor interceptor) {
return new MessageInterceptorRegistration(MATCH_ALL, interceptor, EnumSet.of(EndpointType.RECEIVER), LOWEST_PRECEDENCE);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} at the
* {@link AbstractMessageReceiverEndpoint receiver-side} of all channels.
*
* @param interceptor the MessageInterceptor used to intercept messages
* @param order the {@link Ordered order} of the interceptor. Highest precedence interceptors (lowest order value)
* will be executed last.
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration receiverChannelsWith(final @Nonnull MessageInterceptor interceptor,
final int order) {
return new MessageInterceptorRegistration(MATCH_ALL, interceptor, EnumSet.of(EndpointType.RECEIVER), order);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} at the
* {@link AbstractMessageReceiverEndpoint receiver-side} of all channels
* with names matching the {@code channelNamePattern}.
*
* @param channelNamePattern the regexp used to match channel names. Only channels with matching names will be intercepted.
* @param interceptor the MessageInterceptor used to intercept messages
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration matchingReceiverChannelsWith(final @Nonnull String channelNamePattern,
final @Nonnull MessageInterceptor interceptor) {
return new MessageInterceptorRegistration(compile(channelNamePattern), interceptor, EnumSet.of(EndpointType.RECEIVER), LOWEST_PRECEDENCE);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} at the
* {@link AbstractMessageReceiverEndpoint receiver-side} of all channels
* with names matching the {@code channelNamePattern}.
*
* @param channelNamePattern the regexp used to match channel names. Only channels with matching names will be intercepted.
* @param interceptor the MessageInterceptor used to intercept messages
* @param order the {@link Ordered order} of the interceptor. Highest precedence interceptors (lowest order value)
* will be executed last.
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration matchingReceiverChannelsWith(final @Nonnull String channelNamePattern,
final @Nonnull MessageInterceptor interceptor,
final int order) {
return new MessageInterceptorRegistration(compile(channelNamePattern), interceptor, EnumSet.of(EndpointType.RECEIVER), order);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} at the
* {@link AbstractMessageSenderEndpoint sender-side} of all channels.
*
* @param interceptor the MessageInterceptor used to intercept messages
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration senderChannelsWith(final @Nonnull MessageInterceptor interceptor) {
return new MessageInterceptorRegistration(MATCH_ALL, interceptor, EnumSet.of(EndpointType.SENDER), LOWEST_PRECEDENCE);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} at the
* {@link AbstractMessageSenderEndpoint sender-side} of all channels.
*
* @param interceptor the MessageInterceptor used to intercept messages
* @param order the {@link Ordered order} of the interceptor. Highest precedence interceptors (lowest order value)
* will be executed last.
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration senderChannelsWith(final @Nonnull MessageInterceptor interceptor,
final int order) {
return new MessageInterceptorRegistration(MATCH_ALL, interceptor, EnumSet.of(EndpointType.SENDER), order);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} at the
* {@link AbstractMessageSenderEndpoint sender-side} of all channels
* with names matching the {@code channelNamePattern}.
*
* @param channelNamePattern the regexp used to match channel names. Only channels with matching names will be intercepted.
* @param interceptor the MessageInterceptor used to intercept messages
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration matchingSenderChannelsWith(final @Nonnull String channelNamePattern,
final @Nonnull MessageInterceptor interceptor) {
return new MessageInterceptorRegistration(compile(channelNamePattern), interceptor, EnumSet.of(EndpointType.SENDER), LOWEST_PRECEDENCE);
}
/**
* Creates a MessageInterceptorRegistration that is used to register a {@link MessageInterceptor} at the
* {@link AbstractMessageSenderEndpoint sender-side} of all channels
* with names matching the {@code channelNamePattern}.
*
* @param channelNamePattern the regexp used to match channel names. Only channels with matching names will be intercepted.
* @param interceptor the MessageInterceptor used to intercept messages
* @param order the {@link Ordered order} of the interceptor. Highest precedence interceptors (lowest order value)
* will be executed last.
* @return MessageInterceptorRegistration
*/
public static MessageInterceptorRegistration matchingSenderChannelsWith(final @Nonnull String channelNamePattern,
final @Nonnull MessageInterceptor interceptor,
final int order) {
return new MessageInterceptorRegistration(compile(channelNamePattern), interceptor, EnumSet.of(EndpointType.SENDER), order);
}
public MessageInterceptorRegistration(final Pattern channelNamePattern,
final MessageInterceptor interceptor,
final Set enabledEndpointTypes,
final int order) {
if (enabledEndpointTypes.isEmpty()) {
throw new IllegalArgumentException("The set of enabled endpoint types must not be emptyMessageStore");
}
this.channelNamePattern = requireNonNull(channelNamePattern);
this.interceptor = requireNonNull(interceptor);
this.enabledEndpointTypes = copyOf(requireNonNull(enabledEndpointTypes));
this.order = order;
}
/**
* Returns the {@code MessageInterceptor} of the registration.
*
* @return MessageInterceptor
*/
public MessageInterceptor getInterceptor() {
return interceptor;
}
/**
* Returns {@code true} if the registration is matching the given {@code channelName} and {@code EndpointType},
* false otherwise.
*
* @param channelNamePattern the regexp used to match channel names
* @param endpointType the {@link EndpointType} of the channel
* @return boolean
*/
public boolean isEnabledFor(final String channelNamePattern,
final EndpointType endpointType) {
return enabledEndpointTypes.contains(endpointType) && this.channelNamePattern.matcher(channelNamePattern).matches();
}
@Override
public int getOrder() {
return order;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
MessageInterceptorRegistration that = (MessageInterceptorRegistration) o;
return Objects.equals(channelNamePattern.pattern(), that.channelNamePattern.pattern()) &&
Objects.equals(interceptor, that.interceptor) &&
Objects.equals(enabledEndpointTypes, that.enabledEndpointTypes);
}
@Override
public int hashCode() {
return Objects.hash(channelNamePattern.pattern(), interceptor, enabledEndpointTypes);
}
@Override
public String toString() {
return "MessageInterceptorRegistration{" +
"channelNamePattern=" + channelNamePattern.pattern() +
", interceptor=" + interceptor +
", enabledEndpointTypes=" + enabledEndpointTypes +
'}';
}
}