Class ProxyOptions

java.lang.Object
io.vertx.httpproxy.ProxyOptions
public class ProxyOptions extends Object
Proxy options.

  • Field Details

    • DEFAULT_SUPPORT_WEBSOCKET

      public static final boolean DEFAULT_SUPPORT_WEBSOCKET
      Enable WebSocket support : true
      See Also:

  • Constructor Details

    • ProxyOptions

      public ProxyOptions(JsonObject json)

    • ProxyOptions

      public ProxyOptions()

  • Method Details

    • getCacheOptions

      public CacheOptions getCacheOptions()
      Returns:
      the cache options

    • setCacheOptions

      public ProxyOptions setCacheOptions(CacheOptions cacheOptions)
      Set the cache options that configures the proxy. null cache options disables caching, by default cache is disabled.
      Parameters:
      cacheOptions - the cache options
      Returns:
      a reference to this, so the API can be used fluently

    • getSupportWebSocket

      public boolean getSupportWebSocket()
      Returns:
      whether WebSocket are supported

    • setSupportWebSocket

      public ProxyOptions setSupportWebSocket(boolean supportWebSocket)
      Set whether WebSocket are supported.
      Parameters:
      supportWebSocket - true to enable WebSocket support, false otherwise
      Returns:
      a reference to this, so the API can be used fluently

    • getForwardedHeadersOptions

      public ForwardedHeadersOptions getForwardedHeadersOptions()
      Returns:
      the forwarded headers options

    • setForwardedHeadersOptions

      public ProxyOptions setForwardedHeadersOptions(ForwardedHeadersOptions forwardedHeadersOptions)
      Set the forwarded headers options that configures how the proxy handles X-Forwarded-* or RFC 7239 Forwarded headers.

      null forwarded headers options disables forwarded headers support, by default forwarded headers support is disabled.

      Parameters:
      forwardedHeadersOptions - the forwarded headers options
      Returns:
      a reference to this, so the API can be used fluently

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toJson

      public JsonObject toJson()