Package com.nimbusds.oauth2.sdk.id

Class Issuer

java.lang.Object
com.nimbusds.oauth2.sdk.id.Identifier
com.nimbusds.oauth2.sdk.id.Issuer
All Implemented Interfaces:
Serializable, Comparable<Identifier>, net.minidev.json.JSONAware
@Immutable public final class Issuer extends Identifier
Issuer identifier.

Valid issuer identifiers are URIs with "https" schema and no query or fragment component.

See Also:

  • Constructor Details

    • Issuer

      public Issuer(String value)
      Creates a new issuer identifier with the specified value.
      Parameters:
      value - The issuer identifier value. Must not be null or empty string.

    • Issuer

      public Issuer(URI value)
      Creates a new issuer identifier with the specified URI value.
      Parameters:
      value - The URI value. Must not be null.

    • Issuer

      public Issuer(Identifier value)
      Creates a new issuer identifier with the specified value.
      Parameters:
      value - The value. Must not be null.

  • Method Details

    • isValid

      public static boolean isValid(String value)
      Checks if the specified string represents a valid issuer identifier. This method is null-safe.
      Parameters:
      value - The issuer string.
      Returns:
      true if the string represents a valid issuer identifier, else false.

    • isValid

      public static boolean isValid(Issuer value)
      Checks if the specified issuer is a valid identifier. This method is null-safe.
      Parameters:
      value - The issuer.
      Returns:
      true if the value is a valid identifier, else false.

    • isValid

      public static boolean isValid(URI value)
      Checks if the specified URI represents a valid issuer identifier. This method is null-safe.
      Parameters:
      value - The URI.
      Returns:
      true if the values represents a valid issuer identifier, else false.

    • isValid

      public boolean isValid()
      Checks if this issuer is a valid identifier. This method is null-safe.
      Returns:
      true if the value is a valid identifier, else false.

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Identifier

    • equalsIgnoreTrailingSlash

      public boolean equalsIgnoreTrailingSlash(Issuer other)
      Compares this issuer's URI to another issuer's URI, ignoring any trailing slashes. If either issuer is invalid this method falls back to the regular equals(Object) method.
      Parameters:
      other - The other issuer, if null this method returns false.
      Returns:
      true if the URIs are equal, ignoring any trailing slashes, else false.

    • parse

      public static Issuer parse(String s)
      Parses an issuer from the specified string.
      Parameters:
      s - The string to parse, null or empty if no issuer is specified.
      Returns:
      The issuer, null if the parsed string was null or empty.