Package com.nimbusds.openid.connect.sdk.op

Class OIDCProviderEndpointMetadata

java.lang.Object

com.nimbusds.oauth2.sdk.as.AuthorizationServerEndpointMetadata

com.nimbusds.openid.connect.sdk.op.OIDCProviderEndpointMetadata

public class OIDCProviderEndpointMetadata
extends AuthorizationServerEndpointMetadata

OpenID Provider (OP) 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 Device Flow for Browserless and Input Constrained Devices (draft-ietf-oauth-device-flow-14)
• OpenID Connect Discovery 1.0, section 3.
• OpenID Connect Session Management 1.0, section 2.1 (draft 28).
• OpenID Connect Front-Channel Logout 1.0, section 3 (draft 02).
• OpenID Connect Back-Channel Logout 1.0, section 2.1 (draft 04).

Constructor Summary

Constructors

Constructor	Description
OIDCProviderEndpointMetadata()	Creates a new OpenID Connect provider endpoint metadata instance.
OIDCProviderEndpointMetadata(AuthorizationServerEndpointMetadata mtlsEndpointAliases)	Converts an authorization server endpoint metadata to an OpenID Connect provider endpoint metadata instance.

Method Summary

Modifier and Type	Method	Description
static Set<String>	getRegisteredParameterNames()	Gets the registered provider metadata parameter names for endpoints.
URI	getUserInfoEndpointURI()	Gets the UserInfo endpoint URI.
static OIDCProviderEndpointMetadata	parse(net.minidev.json.JSONObject jsonObject)	Parses an OAuth 2.0 Authorisation Server endpoint metadata from the specified JSON object.
void	setUserInfoEndpointURI(URI userInfoEndpoint)	Sets the UserInfo endpoint URI.
net.minidev.json.JSONObject	toJSONObject()	Returns the JSON object representation of this OpenID Connect provider metadata.

Methods inherited from class com.nimbusds.oauth2.sdk.as.AuthorizationServerEndpointMetadata

getAuthorizationEndpointURI, getDeviceAuthorizationEndpointURI, getIntrospectionEndpointURI, getPushedAuthorizationRequestEndpointURI, getRegistrationEndpointURI, getRequestObjectEndpoint, getRevocationEndpointURI, getTokenEndpointURI, setAuthorizationEndpointURI, setDeviceAuthorizationEndpointURI, setIntrospectionEndpointURI, setPushedAuthorizationRequestEndpointURI, setRegistrationEndpointURI, setRequestObjectEndpoint, setRevocationEndpointURI, setTokenEndpointURI, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OIDCProviderEndpointMetadata

public OIDCProviderEndpointMetadata()

Creates a new OpenID Connect provider endpoint metadata instance.

OIDCProviderEndpointMetadata

public OIDCProviderEndpointMetadata(AuthorizationServerEndpointMetadata mtlsEndpointAliases)

Converts an authorization server endpoint metadata to an OpenID Connect provider 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.

getUserInfoEndpointURI

public URI getUserInfoEndpointURI()

Gets the UserInfo endpoint URI. Corresponds the userinfo_endpoint metadata field.

Returns:

The UserInfo endpoint URI, null if not specified.

setUserInfoEndpointURI

public void setUserInfoEndpointURI(URI userInfoEndpoint)

Sets the UserInfo endpoint URI. Corresponds the userinfo_endpoint metadata field.

Parameters:

userInfoEndpoint - The UserInfo endpoint URI, null if not specified.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Returns the JSON object representation of this OpenID Connect provider metadata.

Overrides:

toJSONObject in class AuthorizationServerEndpointMetadata

Returns:

The JSON object representation.

parse

public static OIDCProviderEndpointMetadata 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.