Package com.nimbusds.oauth2.sdk.as
Class AuthorizationServerEndpointMetadata
- java.lang.Object
-
- com.nimbusds.oauth2.sdk.as.AuthorizationServerEndpointMetadata
-
- All Implemented Interfaces:
ReadOnlyAuthorizationServerEndpointMetadata
- Direct Known Subclasses:
AuthorizationServerMetadata
,OIDCProviderEndpointMetadata
public class AuthorizationServerEndpointMetadata extends Object implements ReadOnlyAuthorizationServerEndpointMetadata
OAuth 2.0 Authorisation Server (AS) endpoint metadata.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 (RFC 9126)
- OAuth 2.0 Device Authorization Grant (RFC 8628)
- OpenID Connect Client Initiated Backchannel Authentication Flow - Core 1.0
- OpenID Connect Federation 1.0 (draft 22).
-
-
Constructor Summary
Constructors Constructor Description AuthorizationServerEndpointMetadata()
Creates a new OAuth 2.0 Authorisation Server (AS) endpoint metadata instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description URI
getAuthorizationEndpointURI()
Gets the authorisation endpoint URI.URI
getBackChannelAuthenticationEndpoint()
Deprecated.URI
getBackChannelAuthenticationEndpointURI()
Gets the back-channel authentication endpoint URI.URI
getDeviceAuthorizationEndpointURI()
Gets the device authorization endpoint URI.URI
getFederationRegistrationEndpointURI()
Gets the federation registration endpoint URI.URI
getIntrospectionEndpointURI()
Gets the token introspection endpoint URI.URI
getPushedAuthorizationRequestEndpointURI()
Gets the pushed authorisation request endpoint.static Set<String>
getRegisteredParameterNames()
Gets the registered provider metadata parameter names for endpoints.URI
getRegistrationEndpointURI()
Gets the client registration endpoint URI.URI
getRequestObjectEndpoint()
Deprecated.URI
getRevocationEndpointURI()
Gets the token revocation endpoint URI.URI
getTokenEndpointURI()
Gets the token endpoint URI.static AuthorizationServerEndpointMetadata
parse(net.minidev.json.JSONObject jsonObject)
Parses an OAuth 2.0 Authorisation Server endpoint metadata from the specified JSON object.void
setAuthorizationEndpointURI(URI authzEndpoint)
Sets the authorisation endpoint URI.void
setBackChannelAuthenticationEndpoint(URI backChannelAuthEndpoint)
Deprecated.void
setBackChannelAuthenticationEndpointURI(URI backChannelAuthEndpoint)
Sets the back-channel authentication endpoint URI.void
setDeviceAuthorizationEndpointURI(URI deviceAuthzEndpoint)
Sets the device authorization endpoint URI.void
setFederationRegistrationEndpointURI(URI federationRegistrationEndpoint)
Sets the federation registration endpoint URI.void
setIntrospectionEndpointURI(URI introspectionEndpoint)
Sets the token introspection endpoint URI.void
setPushedAuthorizationRequestEndpointURI(URI parEndpoint)
Gets the pushed authorisation request endpoint.void
setRegistrationEndpointURI(URI regEndpoint)
Sets the client registration endpoint URI.void
setRequestObjectEndpoint(URI requestObjectEndpoint)
Deprecated.void
setRevocationEndpointURI(URI revocationEndpoint)
Sets the token revocation endpoint URI.void
setTokenEndpointURI(URI tokenEndpoint)
Sts the token endpoint URI.net.minidev.json.JSONObject
toJSONObject()
Returns the JSON object representation of the metadata.String
toString()
-
-
-
Constructor Detail
-
AuthorizationServerEndpointMetadata
public AuthorizationServerEndpointMetadata()
Creates a new OAuth 2.0 Authorisation Server (AS) endpoint metadata instance.
-
-
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()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the authorisation endpoint URI. Corresponds theauthorization_endpoint
metadata field.- Specified by:
getAuthorizationEndpointURI
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The authorisation endpoint URI,
null
if not specified.
-
setAuthorizationEndpointURI
public void setAuthorizationEndpointURI(URI authzEndpoint)
Sets the authorisation endpoint URI. Corresponds theauthorization_endpoint
metadata field.- Parameters:
authzEndpoint
- The authorisation endpoint URI,null
if not specified.
-
getTokenEndpointURI
public URI getTokenEndpointURI()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the token endpoint URI. Corresponds thetoken_endpoint
metadata field.- Specified by:
getTokenEndpointURI
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The token endpoint URI,
null
if not specified.
-
setTokenEndpointURI
public void setTokenEndpointURI(URI tokenEndpoint)
Sts the token endpoint URI. Corresponds thetoken_endpoint
metadata field.- Parameters:
tokenEndpoint
- The token endpoint URI,null
if not specified.
-
getRegistrationEndpointURI
public URI getRegistrationEndpointURI()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the client registration endpoint URI. Corresponds to theregistration_endpoint
metadata field.- Specified by:
getRegistrationEndpointURI
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The client registration endpoint URI,
null
if not specified.
-
setRegistrationEndpointURI
public void setRegistrationEndpointURI(URI regEndpoint)
Sets the client registration endpoint URI. Corresponds to theregistration_endpoint
metadata field.- Parameters:
regEndpoint
- The client registration endpoint URI,null
if not specified.
-
getIntrospectionEndpointURI
public URI getIntrospectionEndpointURI()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the token introspection endpoint URI. Corresponds to theintrospection_endpoint
metadata field.- Specified by:
getIntrospectionEndpointURI
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The token introspection endpoint URI,
null
if not specified.
-
setIntrospectionEndpointURI
public void setIntrospectionEndpointURI(URI introspectionEndpoint)
Sets the token introspection endpoint URI. Corresponds to theintrospection_endpoint
metadata field.- Parameters:
introspectionEndpoint
- The token introspection endpoint URI,null
if not specified.
-
getRevocationEndpointURI
public URI getRevocationEndpointURI()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the token revocation endpoint URI. Corresponds to therevocation_endpoint
metadata field.- Specified by:
getRevocationEndpointURI
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The token revocation endpoint URI,
null
if not specified.
-
setRevocationEndpointURI
public void setRevocationEndpointURI(URI revocationEndpoint)
Sets the token revocation endpoint URI. Corresponds to therevocation_endpoint
metadata field.- Parameters:
revocationEndpoint
- The token revocation endpoint URI,null
if not specified.
-
getRequestObjectEndpoint
@Deprecated public URI getRequestObjectEndpoint()
Deprecated.Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the request object endpoint. Corresponds to therequest_object_endpoint
metadata field.- Specified by:
getRequestObjectEndpoint
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The request object endpoint,
null
if not specified.
-
setRequestObjectEndpoint
@Deprecated public void setRequestObjectEndpoint(URI requestObjectEndpoint)
Deprecated.Sets the request object endpoint. Corresponds to therequest_object_endpoint
metadata field.- Parameters:
requestObjectEndpoint
- The request object endpoint,null
if not specified.
-
getPushedAuthorizationRequestEndpointURI
public URI getPushedAuthorizationRequestEndpointURI()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the pushed authorisation request endpoint. Corresponds to thepushed_authorization_request_endpoint
metadata field.- Specified by:
getPushedAuthorizationRequestEndpointURI
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The pushed authorisation request endpoint,
null
if not specified.
-
setPushedAuthorizationRequestEndpointURI
public void setPushedAuthorizationRequestEndpointURI(URI parEndpoint)
Gets the pushed authorisation request endpoint. Corresponds to thepushed_authorization_request_endpoint
metadata field.- Parameters:
parEndpoint
- The pushed authorisation request endpoint,null
if not specified.
-
getDeviceAuthorizationEndpointURI
public URI getDeviceAuthorizationEndpointURI()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the device authorization endpoint URI. Corresponds thedevice_authorization_endpoint
metadata field.- Specified by:
getDeviceAuthorizationEndpointURI
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The device authorization endpoint URI,
null
if not specified.
-
setDeviceAuthorizationEndpointURI
public void setDeviceAuthorizationEndpointURI(URI deviceAuthzEndpoint)
Sets the device authorization endpoint URI. Corresponds thedevice_authorization_endpoint
metadata field.- Parameters:
deviceAuthzEndpoint
- The device authorization endpoint URI,null
if not specified.
-
getBackChannelAuthenticationEndpointURI
public URI getBackChannelAuthenticationEndpointURI()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the back-channel authentication endpoint URI. Corresponds thebackchannel_authentication_endpoint
metadata field.- Specified by:
getBackChannelAuthenticationEndpointURI
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The back-channel authentication endpoint URI,
null
if not specified.
-
getBackChannelAuthenticationEndpoint
@Deprecated public URI getBackChannelAuthenticationEndpoint()
Deprecated.Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the back-channel authentication endpoint URI. Corresponds thebackchannel_authentication_endpoint
metadata field.- Specified by:
getBackChannelAuthenticationEndpoint
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The back-channel authentication endpoint URI,
null
if not specified.
-
setBackChannelAuthenticationEndpointURI
public void setBackChannelAuthenticationEndpointURI(URI backChannelAuthEndpoint)
Sets the back-channel authentication endpoint URI. Corresponds thebackchannel_authentication_endpoint
metadata field.- Parameters:
backChannelAuthEndpoint
- The back-channel authentication e endpoint URI,null
if not specified.
-
setBackChannelAuthenticationEndpoint
@Deprecated public void setBackChannelAuthenticationEndpoint(URI backChannelAuthEndpoint)
Deprecated.Sets the back-channel authentication endpoint URI. Corresponds thebackchannel_authentication_endpoint
metadata field.- Parameters:
backChannelAuthEndpoint
- The back-channel authentication e endpoint URI,null
if not specified.
-
getFederationRegistrationEndpointURI
public URI getFederationRegistrationEndpointURI()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Gets the federation registration endpoint URI. Corresponds to thefederation_registration_endpoint
metadata field.- Specified by:
getFederationRegistrationEndpointURI
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The federation registration endpoint URI,
null
if not specified.
-
setFederationRegistrationEndpointURI
public void setFederationRegistrationEndpointURI(URI federationRegistrationEndpoint)
Sets the federation registration endpoint URI. Corresponds to thefederation_registration_endpoint
metadata field.- Parameters:
federationRegistrationEndpoint
- The federation registration endpoint URI,null
if not specified.
-
toJSONObject
public net.minidev.json.JSONObject toJSONObject()
Description copied from interface:ReadOnlyAuthorizationServerEndpointMetadata
Returns the JSON object representation of the metadata.- Specified by:
toJSONObject
in interfaceReadOnlyAuthorizationServerEndpointMetadata
- Returns:
- The JSON object.
-
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 benull
.- 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.
-
-