Record Class WwwAuthenticateChallenge

java.lang.Object
java.lang.Record
io.micronaut.security.authentication.WwwAuthenticateChallenge
Record Components:
authScheme - Authentication Schema
authParameters - Authentication Parameters
public record WwwAuthenticateChallenge(@NonNull String authScheme, @NonNull Map<String,Object> authParameters) extends Record
This is a helper class to create a challenge, the value of a WWW-Authenticate response header as described in WWW-Authenticate.
Since:
4.14.0
See Also:

  • Constructor Details

    • WwwAuthenticateChallenge

      public WwwAuthenticateChallenge(@NonNull String authScheme, @NonNull Map<String,Object> authParameters)
      Creates an instance of a WwwAuthenticateChallenge record class.
      Parameters:
      authScheme - the value for the authScheme record component
      authParameters - the value for the authParameters record component

  • Method Details

    • toString

      public @NonNull 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

    • builder

      public static @NonNull WwwAuthenticateChallenge.Builder builder()
      Create a new builder.
      Returns:
      Builder

    • 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.

    • authScheme

      public @NonNull String authScheme()
      Returns the value of the authScheme record component.
      Returns:
      the value of the authScheme record component

    • authParameters

      public @NonNull Map<String,Object> authParameters()
      Returns the value of the authParameters record component.
      Returns:
      the value of the authParameters record component