Class ScimAuthenticationScheme

java.lang.Object
com.revetsec.scim.ScimAuthenticationScheme

@Immutable @CheckReturnValue public final class ScimAuthenticationScheme extends Object
Immutable description of an application authentication scheme; it performs no authentication. Specification and documentation links are trusted bounded HTTP(S) URIs and are never fetched.
Since:
1.0.0
  • Method Details

    • withType

      Starts a standard authentication scheme with its exact SCIM type spelling.
      Parameters:
      type - oauth, oauth2, oauthbearertoken, httpbasic or httpdigest
      Returns:
      a new builder
      Since:
      1.0.0
    • getType

      Returns the exact standard scheme type.
      Returns:
      the exact standard scheme type
      Since:
      1.0.0
    • getName

      Returns the human-readable scheme name.
      Returns:
      the human-readable scheme name
      Since:
      1.0.0
    • getDescription

      Returns the scheme description.
      Returns:
      the scheme description
      Since:
      1.0.0
    • isPrimary

      Returns whether this is the preferred scheme.
      Returns:
      whether this is the preferred scheme
      Since:
      1.0.0
    • getSpecUri

      Returns the optional specification URI.
      Returns:
      the optional specification URI
      Since:
      1.0.0
    • getDocumentationUri

      Returns the optional documentation URI.
      Returns:
      the optional documentation URI
      Since:
      1.0.0
    • equals

      public boolean equals(@Nullable Object other)
      Compares all scheme description characteristics.
      Overrides:
      equals in class Object
      Parameters:
      other - the comparison value
      Returns:
      whether descriptions are equal
      Since:
      1.0.0
    • hashCode

      public int hashCode()
      Returns the scheme description hash.
      Overrides:
      hashCode in class Object
      Returns:
      the description hash
      Since:
      1.0.0
    • toString

      Returns a fixed redacted description.
      Overrides:
      toString in class Object
      Returns:
      a fixed redacted description
      Since:
      1.0.0