Package io.quarkus.vertx.http.runtime

Record Class ForwardingProxyHandlerFactory

java.lang.Object
java.lang.Record
io.quarkus.vertx.http.runtime.ForwardingProxyHandlerFactory
public record ForwardingProxyHandlerFactory(ProxyConfig proxyConfig, io.vertx.core.http.ClientAuth clientAuth, Optional<String> tlsConfigName, Supplier<io.vertx.core.Vertx> vertx, io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> root, String configPrefix, boolean allowForwarded, boolean allowXForwarded, boolean hasClientAuthTrustCheck, boolean hasHostTrustCheck) extends Record
Applies a TrustedProxyCheck based on ProxyConfig when the proxy address forwarding is enabled.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ForwardingProxyHandlerFactory(ProxyConfig proxyConfig, io.vertx.core.http.ClientAuth clientAuth, Optional<String> tlsConfigName, Supplier<io.vertx.core.Vertx> vertx, io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> root, String configPrefix)
     
    ForwardingProxyHandlerFactory(ProxyConfig proxyConfig, io.vertx.core.http.ClientAuth clientAuth, Optional<String> tlsConfigName, Supplier<io.vertx.core.Vertx> vertx, io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> root, String configPrefix, boolean allowForwarded, boolean allowXForwarded, boolean hasClientAuthTrustCheck, boolean hasHostTrustCheck)
    Creates an instance of a ForwardingProxyHandlerFactory record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    allowForwarded()
    Returns the value of the allowForwarded record component.
    boolean
    allowXForwarded()
    Returns the value of the allowXForwarded record component.
    io.vertx.core.http.ClientAuth
    clientAuth()
    Returns the value of the clientAuth record component.
    String
    configPrefix()
    Returns the value of the configPrefix record component.
    io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest>
    createHandler()
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    hasClientAuthTrustCheck()
    Returns the value of the hasClientAuthTrustCheck record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    hasHostTrustCheck()
    Returns the value of the hasHostTrustCheck record component.
    ProxyConfig
    proxyConfig()
    Returns the value of the proxyConfig record component.
    io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest>
    root()
    Returns the value of the root record component.
    Optional<String>
    tlsConfigName()
    Returns the value of the tlsConfigName record component.
    final String
    toString()
    Returns a string representation of this record class.
    Supplier<io.vertx.core.Vertx>
    vertx()
    Returns the value of the vertx record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ForwardingProxyHandlerFactory

      public ForwardingProxyHandlerFactory(ProxyConfig proxyConfig, io.vertx.core.http.ClientAuth clientAuth, Optional<String> tlsConfigName, Supplier<io.vertx.core.Vertx> vertx, io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> root, String configPrefix)

    • ForwardingProxyHandlerFactory

      public ForwardingProxyHandlerFactory(ProxyConfig proxyConfig, io.vertx.core.http.ClientAuth clientAuth, Optional<String> tlsConfigName, Supplier<io.vertx.core.Vertx> vertx, io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> root, String configPrefix, boolean allowForwarded, boolean allowXForwarded, boolean hasClientAuthTrustCheck, boolean hasHostTrustCheck)
      Creates an instance of a ForwardingProxyHandlerFactory record class.
      Parameters:
      proxyConfig - the value for the proxyConfig record component
      clientAuth - the value for the clientAuth record component
      tlsConfigName - the value for the tlsConfigName record component
      vertx - the value for the vertx record component
      root - the value for the root record component
      configPrefix - the value for the configPrefix record component
      allowForwarded - the value for the allowForwarded record component
      allowXForwarded - the value for the allowXForwarded record component
      hasClientAuthTrustCheck - the value for the hasClientAuthTrustCheck record component
      hasHostTrustCheck - the value for the hasHostTrustCheck record component

  • Method Details

    • createHandler

      public io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> createHandler()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • proxyConfig

      public ProxyConfig proxyConfig()
      Returns the value of the proxyConfig record component.
      Returns:
      the value of the proxyConfig record component

    • clientAuth

      public io.vertx.core.http.ClientAuth clientAuth()
      Returns the value of the clientAuth record component.
      Returns:
      the value of the clientAuth record component

    • tlsConfigName

      public Optional<String> tlsConfigName()
      Returns the value of the tlsConfigName record component.
      Returns:
      the value of the tlsConfigName record component

    • vertx

      public Supplier<io.vertx.core.Vertx> vertx()
      Returns the value of the vertx record component.
      Returns:
      the value of the vertx record component

    • root

      public io.vertx.core.Handler<io.vertx.core.http.HttpServerRequest> root()
      Returns the value of the root record component.
      Returns:
      the value of the root record component

    • configPrefix

      public String configPrefix()
      Returns the value of the configPrefix record component.
      Returns:
      the value of the configPrefix record component

    • allowForwarded

      public boolean allowForwarded()
      Returns the value of the allowForwarded record component.
      Returns:
      the value of the allowForwarded record component

    • allowXForwarded

      public boolean allowXForwarded()
      Returns the value of the allowXForwarded record component.
      Returns:
      the value of the allowXForwarded record component

    • hasClientAuthTrustCheck

      public boolean hasClientAuthTrustCheck()
      Returns the value of the hasClientAuthTrustCheck record component.
      Returns:
      the value of the hasClientAuthTrustCheck record component

    • hasHostTrustCheck

      public boolean hasHostTrustCheck()
      Returns the value of the hasHostTrustCheck record component.
      Returns:
      the value of the hasHostTrustCheck record component