Record Class ForwardedRequestHeaders

java.lang.Object
java.lang.Record
org.springframework.boot.web.server.ForwardedRequestHeaders
Record Components:
naming - header naming
usePrefix - if the 'prefix' forward header should be used.

public record ForwardedRequestHeaders(ForwardedRequestHeaders.Naming naming, boolean usePrefix) extends Record
Configuration for forwarded request headers.
Since:
4.2.0
Author:
Brian Clozel, Phillip Webb
  • Field Details

  • Constructor Details

    • ForwardedRequestHeaders

      public ForwardedRequestHeaders(ForwardedRequestHeaders.Naming naming, boolean usePrefix)
      Creates an instance of a ForwardedRequestHeaders record class.
      Parameters:
      naming - the value for the naming record component
      usePrefix - the value for the usePrefix 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.
    • naming

      Returns the value of the naming record component.
      Returns:
      the value of the naming record component
    • usePrefix

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