Class ClientRegistration

  • All Implemented Interfaces:
    java.io.Serializable

    public final class ClientRegistration
    extends java.lang.Object
    implements java.io.Serializable
    A representation of a client registration with an OAuth 2.0 or OpenID Connect 1.0 Provider.
    Since:
    5.0
    See Also:
    Section 2 Client Registration, Serialized Form
    • Method Detail

      • getRegistrationId

        public java.lang.String getRegistrationId()
        Returns the identifier for the registration.
        Returns:
        the identifier for the registration
      • getClientId

        public java.lang.String getClientId()
        Returns the client identifier.
        Returns:
        the client identifier
      • getClientSecret

        public java.lang.String getClientSecret()
        Returns the client secret.
        Returns:
        the client secret
      • getRedirectUriTemplate

        @Deprecated
        public java.lang.String getRedirectUriTemplate()
        Deprecated.
        Use getRedirectUri() instead
        Returns the uri (or uri template) for the redirection endpoint.
        Returns:
        the uri (or uri template) for the redirection endpoint
      • getRedirectUri

        public java.lang.String getRedirectUri()
        Returns the uri (or uri template) for the redirection endpoint.
        The supported uri template variables are: {baseScheme}, {baseHost}, {basePort}, {basePath} and {registrationId}.
        NOTE: {baseUrl} is also supported, which is the same as {baseScheme}://{baseHost}{basePort}{basePath}.
        Configuring uri template variables is especially useful when the client is running behind a Proxy Server. This ensures that the X-Forwarded-* headers are used when expanding the redirect-uri.
        Returns:
        the uri (or uri template) for the redirection endpoint
        Since:
        5.4
      • getScopes

        public java.util.Set<java.lang.String> getScopes()
        Returns the scope(s) used for the client.
        Returns:
        the Set of scope(s)
      • getClientName

        public java.lang.String getClientName()
        Returns the logical name of the client or registration.
        Returns:
        the client or registration name
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object