Package org.forgerock.oauth2.core

Interface OAuth2Uris

public interface OAuth2Uris

Models all of the possible settings the OAuth2 provider can have and that can be configured.

The actual implementation is responsible for providing the method in which these settings are configured. This interface only describes the API for other code to get the OAuth2 provider settings.

Since:

13.0.0

Method Summary

Modifier and Type	Method	Description
String	getAuthorizationEndpoint()	Gets the URI for the OAuth2 authorize endpoint.
String	getCheckSessionEndpoint()	Gets the URI for the OpenID Connect check session endpoint.
String	getClientRegistrationEndpoint()	Gets the OpenID Connect client registration endpoint.
String	getDeviceAuthorizationEndpoint()	Returns the default URL for this provider's Device Flow Authorization endpoint.
String	getEndSessionEndpoint()	Gets the URI for the OpenID Connect end session endpoint.
String	getIntrospectionEndpoint()	Returns the default URL for this provider's token introspection endpoint.
String	getIssuer()	Gets the identifier of this issuer.
String	getJWKSUri()	Gets the JSON Web Key Set URI.
String	getResourceSetRegistrationEndpoint()	Returns the default URL for this provider's Resource Set Registration endpoint.
String	getResourceSetRegistrationPolicyEndpoint(String resourceSetId)	Returns the default URL for this provider's Resource Set Registration policy endpoint.
String	getTokenEndpoint()	Gets the URI for the OAuth2 token endpoint.
String	getUserInfoEndpoint()	Gets the URI for the OpenID Connect user info endpoint.

Method Detail

getIssuer

String getIssuer()
          throws ServerException

Gets the identifier of this issuer.

Returns:

The issuer.

Throws:

ServerException

getAuthorizationEndpoint

String getAuthorizationEndpoint()

Gets the URI for the OAuth2 authorize endpoint.

Returns:

The OAuth2 authorize endpoint.

getTokenEndpoint

String getTokenEndpoint()

Gets the URI for the OAuth2 token endpoint.

Returns:

The OAuth2 token endpoint.

getUserInfoEndpoint

String getUserInfoEndpoint()

Gets the URI for the OpenID Connect user info endpoint.

Returns:

The OpenID Connect user info endpoint.

getCheckSessionEndpoint

String getCheckSessionEndpoint()

Gets the URI for the OpenID Connect check session endpoint.

Returns:

The OpenID Connect check session endpoint.

getEndSessionEndpoint

String getEndSessionEndpoint()

Gets the URI for the OpenID Connect end session endpoint.

Returns:

The OpenID Connect end session endpoint.

getJWKSUri

String getJWKSUri()
           throws ServerException

Gets the JSON Web Key Set URI.

Returns:

The JWKS URI.

Throws:

ServerException - If any internal server error occurs.

getClientRegistrationEndpoint

String getClientRegistrationEndpoint()

Gets the OpenID Connect client registration endpoint.

Returns:

The OpenID Connect client registration endpoint.

getIntrospectionEndpoint

String getIntrospectionEndpoint()

Returns the default URL for this provider's token introspection endpoint.

Returns:

The URL.

getResourceSetRegistrationPolicyEndpoint

String getResourceSetRegistrationPolicyEndpoint(String resourceSetId)

Returns the default URL for this provider's Resource Set Registration policy endpoint.

Returns:

The URL.

getResourceSetRegistrationEndpoint

String getResourceSetRegistrationEndpoint()

Returns the default URL for this provider's Resource Set Registration endpoint.

Returns:

The URL.

getDeviceAuthorizationEndpoint

String getDeviceAuthorizationEndpoint()

Returns the default URL for this provider's Device Flow Authorization endpoint.

Returns:

The URL.