Added missing javadocs

This commit is contained in:
Marcin Grzejszczak
2020-12-03 17:18:37 +01:00
parent 3f0cb2ffaa
commit 5ad9108de9

View File

@@ -21,6 +21,8 @@ import brave.SpanCustomizer;
import org.springframework.lang.Nullable;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageChannel;
import org.springframework.messaging.MessageHandler;
import org.springframework.messaging.support.ExecutorChannelInterceptor;
/**
* Allows customization of messaging spans.
@@ -30,12 +32,38 @@ import org.springframework.messaging.MessageChannel;
*/
public interface MessageSpanCustomizer {
/**
* Customizes the span created when
* {@link ExecutorChannelInterceptor#beforeHandle(Message, MessageChannel, MessageHandler)}
* gets called.
* @param spanCustomizer current span to customize
* @param message received or sent message
* @param messageChannel channel from / to which the message was sent
* @return customized span
*/
SpanCustomizer customizeHandle(SpanCustomizer spanCustomizer, Message<?> message,
@Nullable MessageChannel messageChannel);
/**
* Customizes the span created when
* {@link ExecutorChannelInterceptor#postReceive(Message, MessageChannel)} gets
* called.
* @param spanCustomizer current span to customize
* @param message received or sent message
* @param messageChannel channel from / to which the message was sent
* @return customized span
*/
SpanCustomizer customizeReceive(SpanCustomizer spanCustomizer, Message<?> message,
@Nullable MessageChannel messageChannel);
/**
* Customizes the span created when
* {@link ExecutorChannelInterceptor#preSend(Message, MessageChannel)} gets called.
* @param spanCustomizer current span to customize
* @param message received or sent message
* @param messageChannel channel from / to which the message was sent
* @return customized span
*/
SpanCustomizer customizeSend(SpanCustomizer spanCustomizer, Message<?> message,
@Nullable MessageChannel messageChannel);