com.hubspot.smtp.client

Class CompositeSendInterceptor

java.lang.Object

com.hubspot.smtp.client.CompositeSendInterceptor

All Implemented Interfaces:

SendInterceptor

public class CompositeSendInterceptor
extends Object
implements SendInterceptor

A chain of SendInterceptor instances that will call each other in turn.

Construct a chain by passing a list of SendInterceptors to the of method.

  CompositeSendInterceptor composite = CompositeSendInterceptor.of(
    new SendInterceptorA(),
    new SendInterceptorB(),
    new SendInterceptorC());

With this chain, SendInterceptorA will be called first, and the next parameter of each of its around methods will refer to the future returned by SendInterceptorB.

This class is thread-safe.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>>	aroundData(Supplier<CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>>> next) Called before data is sent.
CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>>	aroundPipelinedSequence(List<io.netty.handler.codec.smtp.SmtpRequest> requests, Supplier<CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>>> next) Called before a pipelined series of requests is sent.
CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>>	aroundRequest(io.netty.handler.codec.smtp.SmtpRequest request, Supplier<CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>>> next) Called before a request is sent.
List<SendInterceptor>	getSendInterceptors()
static CompositeSendInterceptor	of(List<SendInterceptor> interceptors) Creates a chain of SendInterceptor instances that will call each other in turn.
static CompositeSendInterceptor	of(SendInterceptor... sendInterceptors) Creates a chain of SendInterceptor instances that will call each other in turn.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static CompositeSendInterceptor of(SendInterceptor... sendInterceptors)

Creates a chain of SendInterceptor instances that will call each other in turn.

of

public static CompositeSendInterceptor of(List<SendInterceptor> interceptors)

Creates a chain of SendInterceptor instances that will call each other in turn.

getSendInterceptors

public List<SendInterceptor> getSendInterceptors()

aroundRequest

public CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>> aroundRequest(io.netty.handler.codec.smtp.SmtpRequest request,
                                                                                       Supplier<CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>>> next)

Description copied from interface: SendInterceptor

Called before a request is sent.

Specified by:

aroundRequest in interface SendInterceptor

Parameters:

request - the request that will be sent

next - supplies a future that will complete when the request has been sent and a response received

Returns:

next.get(), a CompletableFuture derived from it, or an exceptional future if the send should be aborted

aroundData

public CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>> aroundData(Supplier<CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>>> next)

Description copied from interface: SendInterceptor

Called before data is sent.

Specified by:

aroundData in interface SendInterceptor

Parameters:

next - supplies a future that will complete when the data has been sent and a response received

Returns:

next.get(), a CompletableFuture derived from it, or an exceptional future if the send should be aborted

aroundPipelinedSequence

public CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>> aroundPipelinedSequence(List<io.netty.handler.codec.smtp.SmtpRequest> requests,
                                                                                                 Supplier<CompletableFuture<List<io.netty.handler.codec.smtp.SmtpResponse>>> next)

Description copied from interface: SendInterceptor

Called before a pipelined series of requests is sent.

Specified by:

aroundPipelinedSequence in interface SendInterceptor

Parameters:

requests - the requests that will be sent

next - supplies a future that will complete when the requests have been sent and responses received

Returns:

next.get(), a CompletableFuture derived from it, or an exceptional future if the send should be aborted