Package io.vertx.mutiny.httpproxy

Class ProxyInterceptor

java.lang.Object
io.vertx.mutiny.httpproxy.ProxyInterceptor
All Implemented Interfaces:
MutinyDelegate
public class ProxyInterceptor extends Object implements MutinyDelegate
A HttpProxy interceptor.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

See Also:
  • ProxyInterceptor

  • Field Details

  • Constructor Details

    • ProxyInterceptor

      public ProxyInterceptor(io.vertx.httpproxy.ProxyInterceptor delegate)
      Create a new instance of ProxyInterceptor delegating to the given (non-null) instance of ProxyInterceptor.

    • ProxyInterceptor

      public ProxyInterceptor(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.httpproxy.ProxyInterceptor getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • handleProxyRequest

      @CheckReturnValue public io.smallrye.mutiny.Uni<ProxyResponse> handleProxyRequest(ProxyContext context)
      Handle the proxy request at the stage of this interceptor.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      context - the proxy context
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.httpproxy.ProxyInterceptor#handleProxyRequest(ProxyContext)

    • handleProxyRequestAndAwait

      public ProxyResponse handleProxyRequestAndAwait(ProxyContext context)
      Handle the proxy request at the stage of this interceptor.

      Unlike the bare Vert.x variant, this method returns a ProxyResponse. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      context - the proxy context
      Returns:
      The operation result
      See Also:
      • io.vertx.httpproxy.ProxyInterceptor#handleProxyRequest(ProxyContext)

    • handleProxyRequestAndForget

      public ProxyInterceptor handleProxyRequestAndForget(ProxyContext context)
      Handle the proxy request at the stage of this interceptor.

      Unlike the bare Vert.x variant, this method ignores the ProxyResponse result or any failure.

      Parameters:
      context - the proxy context
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.httpproxy.ProxyInterceptor#handleProxyRequest(ProxyContext)

    • handleProxyResponse

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> handleProxyResponse(ProxyContext context)
      Handle the proxy response at the stage of this interceptor.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      context - the proxy context
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • io.vertx.httpproxy.ProxyInterceptor#handleProxyResponse(ProxyContext)

    • handleProxyResponseAndAwait

      public void handleProxyResponseAndAwait(ProxyContext context)
      Handle the proxy response at the stage of this interceptor.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Parameters:
      context - the proxy context
      See Also:
      • io.vertx.httpproxy.ProxyInterceptor#handleProxyResponse(ProxyContext)

    • handleProxyResponseAndForget

      public ProxyInterceptor handleProxyResponseAndForget(ProxyContext context)
      Handle the proxy response at the stage of this interceptor.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Parameters:
      context - the proxy context
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • io.vertx.httpproxy.ProxyInterceptor#handleProxyResponse(ProxyContext)

    • builder

      public static ProxyInterceptorBuilder builder()
      Create a builder for implementing common HTTP interception hooks such as modifying headers or transforming the HTTP entity stream.
      Returns:
      a builder for common interception

    • newInstance

      public static ProxyInterceptor newInstance(io.vertx.httpproxy.ProxyInterceptor delegate)
      Creates a new instance of the ProxyInterceptor.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object