Class OIDCProviderEndpointMetadata
- java.lang.Object
-
- com.nimbusds.oauth2.sdk.as.AuthorizationServerEndpointMetadata
-
- com.nimbusds.openid.connect.sdk.op.OIDCProviderEndpointMetadata
-
- All Implemented Interfaces:
ReadOnlyAuthorizationServerEndpointMetadata
,ReadOnlyOIDCProviderEndpointMetadata
public class OIDCProviderEndpointMetadata extends AuthorizationServerEndpointMetadata implements ReadOnlyOIDCProviderEndpointMetadata
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 07).
- OpenID Connect Federation 1.0 (draft 22).
-
-
Constructor Summary
Constructors Constructor Description OIDCProviderEndpointMetadata()
Creates a new OpenID Connect provider endpoint metadata instance.OIDCProviderEndpointMetadata(AuthorizationServerEndpointMetadata endpointMetadata)
Converts an authorisation server endpoint metadata to an OpenID Connect provider endpoint metadata instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description URI
getCheckSessionIframeURI()
Gets the cross-origin check session iframe URI.URI
getEndSessionEndpointURI()
Gets the logout endpoint URI.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
setCheckSessionIframeURI(URI checkSessionIframe)
Sets the cross-origin check session iframe URI.void
setEndSessionEndpointURI(URI endSessionEndpoint)
Sets the logout endpoint URI.void
setUserInfoEndpointURI(URI userInfoEndpoint)
Sets the UserInfo endpoint URI.net.minidev.json.JSONObject
toJSONObject()
Returns the JSON object representation of the metadata.-
Methods inherited from class com.nimbusds.oauth2.sdk.as.AuthorizationServerEndpointMetadata
getAuthorizationEndpointURI, getBackChannelAuthenticationEndpoint, getBackChannelAuthenticationEndpointURI, getDeviceAuthorizationEndpointURI, getFederationRegistrationEndpointURI, getIntrospectionEndpointURI, getPushedAuthorizationRequestEndpointURI, getRegistrationEndpointURI, getRequestObjectEndpoint, getRevocationEndpointURI, getTokenEndpointURI, setAuthorizationEndpointURI, setBackChannelAuthenticationEndpoint, setBackChannelAuthenticationEndpointURI, setDeviceAuthorizationEndpointURI, setFederationRegistrationEndpointURI, setIntrospectionEndpointURI, setPushedAuthorizationRequestEndpointURI, setRegistrationEndpointURI, setRequestObjectEndpoint, setRevocationEndpointURI, setTokenEndpointURI, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.nimbusds.oauth2.sdk.as.ReadOnlyAuthorizationServerEndpointMetadata
getAuthorizationEndpointURI, getBackChannelAuthenticationEndpoint, getBackChannelAuthenticationEndpointURI, getDeviceAuthorizationEndpointURI, getFederationRegistrationEndpointURI, getIntrospectionEndpointURI, getPushedAuthorizationRequestEndpointURI, getRegistrationEndpointURI, getRequestObjectEndpoint, getRevocationEndpointURI, getTokenEndpointURI
-
-
-
-
Constructor Detail
-
OIDCProviderEndpointMetadata
public OIDCProviderEndpointMetadata()
Creates a new OpenID Connect provider endpoint metadata instance.
-
OIDCProviderEndpointMetadata
public OIDCProviderEndpointMetadata(AuthorizationServerEndpointMetadata endpointMetadata)
Converts an authorisation server endpoint metadata to an OpenID Connect provider endpoint metadata instance.- Parameters:
endpointMetadata
- The authorisation server endpoint metadata. Must not benull
.
-
-
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 the endpoints, as an unmodifiable set.
-
getUserInfoEndpointURI
public URI getUserInfoEndpointURI()
Description copied from interface:ReadOnlyOIDCProviderEndpointMetadata
Gets the UserInfo endpoint URI. Corresponds theuserinfo_endpoint
metadata field.- Specified by:
getUserInfoEndpointURI
in interfaceReadOnlyOIDCProviderEndpointMetadata
- Returns:
- The UserInfo endpoint URI,
null
if not specified.
-
setUserInfoEndpointURI
public void setUserInfoEndpointURI(URI userInfoEndpoint)
Sets the UserInfo endpoint URI. Corresponds theuserinfo_endpoint
metadata field.- Parameters:
userInfoEndpoint
- The UserInfo endpoint URI,null
if not specified.
-
getCheckSessionIframeURI
public URI getCheckSessionIframeURI()
Description copied from interface:ReadOnlyOIDCProviderEndpointMetadata
Gets the cross-origin check session iframe URI. Corresponds to thecheck_session_iframe
metadata field.- Specified by:
getCheckSessionIframeURI
in interfaceReadOnlyOIDCProviderEndpointMetadata
- Returns:
- The check session iframe URI,
null
if not specified.
-
setCheckSessionIframeURI
public void setCheckSessionIframeURI(URI checkSessionIframe)
Sets the cross-origin check session iframe URI. Corresponds to thecheck_session_iframe
metadata field.- Parameters:
checkSessionIframe
- The check session iframe URI,null
if not specified.
-
getEndSessionEndpointURI
public URI getEndSessionEndpointURI()
Description copied from interface:ReadOnlyOIDCProviderEndpointMetadata
Gets the logout endpoint URI. Corresponds to theend_session_endpoint
metadata field.- Specified by:
getEndSessionEndpointURI
in interfaceReadOnlyOIDCProviderEndpointMetadata
- Returns:
- The logoout endpoint URI,
null
if not specified.
-
setEndSessionEndpointURI
public void setEndSessionEndpointURI(URI endSessionEndpoint)
Sets the logout endpoint URI. Corresponds to theend_session_endpoint
metadata field.- Parameters:
endSessionEndpoint
- The logoout 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
- Overrides:
toJSONObject
in classAuthorizationServerEndpointMetadata
- Returns:
- The JSON object.
-
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 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.
-
-