Package com.nimbusds.oauth2.sdk.as

Class AuthorizationServerEndpointMetadata

  • Direct Known Subclasses:
    AuthorizationServerMetadata, OIDCProviderEndpointMetadata
    public class AuthorizationServerEndpointMetadata
extends Object
    OAuth 2.0 Authorisation Server (AS) metadata for the endpoints.

    Related specifications:

    • OAuth 2.0 Authorization Server Metadata (RFC 8414)
    • OAuth 2.0 Mutual TLS Client Authentication and Certificate Bound Access Tokens (RFC 8705)
    • OAuth 2.0 Pushed Authorization Requests (draft-ietf-oauth-par-05)
    • OAuth 2.0 Device Authorization Grant (RFC 8628)
    • OpenID Connect Client Initiated Backchannel Authentication Flow - Core 1.0 (draft 03)

    • Method Detail

      • getRegisteredParameterNames

        public static Set<String> getRegisteredParameterNames()
        Gets the registered provider metadata parameter names for endpoints.
        Returns:
        The registered provider metadata parameter names for endpoints, as an unmodifiable set.

      • getAuthorizationEndpointURI

        public URI getAuthorizationEndpointURI()
        Gets the authorisation endpoint URI. Corresponds the authorization_endpoint metadata field.
        Returns:
        The authorisation endpoint URI, null if not specified.

      • setAuthorizationEndpointURI

        public void setAuthorizationEndpointURI​(URI authzEndpoint)
        Sets the authorisation endpoint URI. Corresponds the authorization_endpoint metadata field.
        Parameters:
        authzEndpoint - The authorisation endpoint URI, null if not specified.

      • getTokenEndpointURI

        public URI getTokenEndpointURI()
        Gets the token endpoint URI. Corresponds the token_endpoint metadata field.
        Returns:
        The token endpoint URI, null if not specified.

      • setTokenEndpointURI

        public void setTokenEndpointURI​(URI tokenEndpoint)
        Sts the token endpoint URI. Corresponds the token_endpoint metadata field.
        Parameters:
        tokenEndpoint - The token endpoint URI, null if not specified.

      • getRegistrationEndpointURI

        public URI getRegistrationEndpointURI()
        Gets the client registration endpoint URI. Corresponds to the registration_endpoint metadata field.
        Returns:
        The client registration endpoint URI, null if not specified.

      • setRegistrationEndpointURI

        public void setRegistrationEndpointURI​(URI regEndpoint)
        Sets the client registration endpoint URI. Corresponds to the registration_endpoint metadata field.
        Parameters:
        regEndpoint - The client registration endpoint URI, null if not specified.

      • getIntrospectionEndpointURI

        public URI getIntrospectionEndpointURI()
        Gets the token introspection endpoint URI. Corresponds to the introspection_endpoint metadata field.
        Returns:
        The token introspection endpoint URI, null if not specified.

      • setIntrospectionEndpointURI

        public void setIntrospectionEndpointURI​(URI introspectionEndpoint)
        Sets the token introspection endpoint URI. Corresponds to the introspection_endpoint metadata field.
        Parameters:
        introspectionEndpoint - The token introspection endpoint URI, null if not specified.

      • getRevocationEndpointURI

        public URI getRevocationEndpointURI()
        Gets the token revocation endpoint URI. Corresponds to the revocation_endpoint metadata field.
        Returns:
        The token revocation endpoint URI, null if not specified.

      • setRevocationEndpointURI

        public void setRevocationEndpointURI​(URI revocationEndpoint)
        Sets the token revocation endpoint URI. Corresponds to the revocation_endpoint metadata field.
        Parameters:
        revocationEndpoint - The token revocation endpoint URI, null if not specified.

      • getRequestObjectEndpoint

        @Deprecated
public URI getRequestObjectEndpoint()
        Deprecated.
        Gets the request object endpoint. Corresponds to the request_object_endpoint metadata field.
        Returns:
        The request object endpoint, null if not specified.

      • setRequestObjectEndpoint

        @Deprecated
public void setRequestObjectEndpoint​(URI requestObjectEndpoint)
        Deprecated.
        Sets the request object endpoint. Corresponds to the request_object_endpoint metadata field.
        Parameters:
        requestObjectEndpoint - The request object endpoint, null if not specified.

      • getPushedAuthorizationRequestEndpointURI

        public URI getPushedAuthorizationRequestEndpointURI()
        Gets the pushed authorisation request endpoint. Corresponds to the pushed_authorization_request_endpoint metadata field.
        Returns:
        The pushed authorisation request endpoint, null if not specified.

      • setPushedAuthorizationRequestEndpointURI

        public void setPushedAuthorizationRequestEndpointURI​(URI parEndpoint)
        Gets the pushed authorisation request endpoint. Corresponds to the pushed_authorization_request_endpoint metadata field.
        Parameters:
        parEndpoint - The pushed authorisation request endpoint, null if not specified.

      • getDeviceAuthorizationEndpointURI

        public URI getDeviceAuthorizationEndpointURI()
        Gets the device authorization endpoint URI. Corresponds the device_authorization_endpoint metadata field.
        Returns:
        The device authorization endpoint URI, null if not specified.

      • setDeviceAuthorizationEndpointURI

        public void setDeviceAuthorizationEndpointURI​(URI deviceAuthzEndpoint)
        Sets the device authorization endpoint URI. Corresponds the device_authorization_endpoint metadata field.
        Parameters:
        deviceAuthzEndpoint - The device authorization endpoint URI, null if not specified.

      • getBackChannelAuthenticationEndpoint

        public URI getBackChannelAuthenticationEndpoint()
        Gets the back-channel authentication endpoint URI. Corresponds the backchannel_authentication_endpoint metadata field.
        Returns:
        The back-channel authentication endpoint URI, null if not specified.

      • setBackChannelAuthenticationEndpoint

        public void setBackChannelAuthenticationEndpoint​(URI backChannelAuthEndpoint)
        Sets the back-channel authentication endpoint URI. Corresponds the backchannel_authentication_endpoint metadata field.
        Parameters:
        backChannelAuthEndpoint - The back-channel authentication e endpoint URI, null if not specified.

      • toJSONObject

        public net.minidev.json.JSONObject toJSONObject()
        Returns the JSON object representation of this OpenID Connect provider metadata.
        Returns:
        The JSON object representation.

      • parse

        public static AuthorizationServerEndpointMetadata parse​(net.minidev.json.JSONObject jsonObject)
                                                 throws ParseException
        Parses an OAuth 2.0 Authorisation Server endpoint metadata from the specified JSON object.
        Parameters:
        jsonObject - The JSON object to parse. Must not be null.
        Returns:
        The OAuth 2.0 Authorisation Server endpoint metadata.
        Throws:
        ParseException - If the JSON object couldn't be parsed to an OAuth 2.0 Authorisation Server endpoint metadata.