Package io.quarkus.websockets.next

Record Class HttpUpgradeCheck.HttpUpgradeContext

java.lang.Object
java.lang.Record
io.quarkus.websockets.next.HttpUpgradeCheck.HttpUpgradeContext
Record Components:
httpRequest - HttpServerRequest; the HTTP 1.X request employing the 'Upgrade' header
securityIdentity - SecurityIdentity; the identity is null if the Quarkus Security extension is absent
endpointId - WebSocket.endpointId()
Enclosing interface:
HttpUpgradeCheck
public static record HttpUpgradeCheck.HttpUpgradeContext(io.vertx.core.http.HttpServerRequest httpRequest, io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> securityIdentity, String endpointId) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    HttpUpgradeContext(io.vertx.core.http.HttpServerRequest httpRequest, io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> securityIdentity, String endpointId)
    Creates an instance of a HttpUpgradeContext record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    endpointId()
    Returns the value of the endpointId record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    io.vertx.core.http.HttpServerRequest
    httpRequest()
    Returns the value of the httpRequest record component.
    io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity>
    securityIdentity()
    Returns the value of the securityIdentity record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • HttpUpgradeContext

      public HttpUpgradeContext(io.vertx.core.http.HttpServerRequest httpRequest, io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> securityIdentity, String endpointId)
      Creates an instance of a HttpUpgradeContext record class.
      Parameters:
      httpRequest - the value for the httpRequest record component
      securityIdentity - the value for the securityIdentity record component
      endpointId - the value for the endpointId record component

  • Method Details

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • httpRequest

      public io.vertx.core.http.HttpServerRequest httpRequest()
      Returns the value of the httpRequest record component.
      Returns:
      the value of the httpRequest record component

    • securityIdentity

      public io.smallrye.mutiny.Uni<io.quarkus.security.identity.SecurityIdentity> securityIdentity()
      Returns the value of the securityIdentity record component.
      Returns:
      the value of the securityIdentity record component

    • endpointId

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