io.vertx.httpproxy

## Interface ProxyContext

-     public interface ProxyContext

  A controller for proxy interception.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `<T> T` | `get(String name, Class<T> type)` Get a payload attached to this context
    `ProxyRequest` | `request()`
    `ProxyResponse` | `response()`
    `Future<ProxyResponse>` | `sendRequest()`
    `Future<Void>` | `sendResponse()`
    `void` | `set(String name, Object value)` Attach a payload to the context

- - ### Method Detail

    - #### request

          ProxyRequest request()

      Returns:
        the proxy request

    - #### response

          ProxyResponse response()

      Returns:
        the proxy response, it might be `null` if the response has not been sent

    - #### sendRequest

          Future<ProxyResponse> sendRequest()

    - #### sendResponse

          Future<Void> sendResponse()

    - #### set

          void set(String name,
                   Object value)

      Attach a payload to the context
      Parameters:
        `name` - the payload name
        `value` - any payload value

    - #### get

          <T> T get(String name,
                    Class<T> type)

      Get a payload attached to this context
      Parameters:
        `name` - the payload name
        `type` - the expected payload type
      Returns:
        the attached payload

Copyright © 2024 Eclipse. All rights reserved.