io.vertx.httpproxy.ProxyContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-http-proxy Show documentation

There is a newer version: 5.0.0.CR3

package io.vertx.httpproxy;

import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Future;

/**
 * A controller for proxy interception.
 */
@VertxGen
public interface ProxyContext {

  /**
   * @return the proxy request
   */
  ProxyRequest request();

  /**
   * @return the proxy response, it might be {@code null} if the response has not been sent
   */
  ProxyResponse response();

  /**
   *
   */
  Future sendRequest();

  /**
   *
   */
  Future sendResponse();

  /**
   * @return if this request or response is the handshake of WebSocket
   */
  boolean isWebSocket();

  /**
   * Attach a payload to the context
   *
   * @param name the payload name
   * @param value any payload value
   */
  void set(String name, Object value);

  /**
   * Get a payload attached to this context
   *
   * @param name the payload name
   * @param type the expected payload type
   * @return the attached payload
   */
   T get(String name, Class type);
}