org.forgerock.oauth2.core

Interface ClientRegistration

All Known Subinterfaces:

OpenIdConnectClientRegistration

All Known Implementing Classes:

AgentClientRegistration, OpenAMClientRegistration

public interface ClientRegistration

Models a client registration in the OAuth2 provider.

Since:

12.0.0

Method Summary

Modifier and Type	Method and Description
String	getAccessTokenType() Gets the type of access token the client requires.
Set<String>	getAllowedResponseTypes() Gets the allowed response types.
Set<String>	getAllowedScopes() Gets the allowed scopes configured for the client.
Map<String,String>	getClaimDescriptions(Locale locale) Gets the display descriptions for the allowed and default scopes combined, in the specified locale.
String	getClientId() Gets the client's identifier.
String	getClientSecret() Gets the client's secret.
String	getClientSessionURI() Gets the client's session URI.
Set<String>	getDefaultScopes() Gets the default scopes configured for the client.
String	getDisplayDescription(Locale locale) Gets the display description of the client in the specified locale.
String	getDisplayName(Locale locale) Gets the display name of the client in the specified locale.
Set<URI>	getPostLogoutRedirectUris() Gets the registered post logout redirect uris for the client.
Set<URI>	getRedirectUris() Gets the registered redirect uris for the client.
Map<String,String>	getScopeDescriptions(Locale locale) Gets the display descriptions for the allowed and default scopes combined, in the specified locale.
String	getSubjectType() Gets the subject type of this client.
boolean	isConfidential() Gets whether the client is confidential or not.
boolean	isConsentImplied() Gets whether or not the client wants the OAuth2 implementation to skip asking the resource owner for consent.
boolean	verifyJwtIdentity(OAuth2Jwt jwt) Verifies that the supplied jwt is signed by this client.

Method Detail

getRedirectUris

Set<URI> getRedirectUris()

Gets the registered redirect uris for the client.

Returns:

The redirect uris.

getPostLogoutRedirectUris

Set<URI> getPostLogoutRedirectUris()

Gets the registered post logout redirect uris for the client.

Returns:

The redirect uris.

getAllowedResponseTypes

Set<String> getAllowedResponseTypes()

Gets the allowed response types.

Returns:

The allowed response types.

getClientId

String getClientId()

Gets the client's identifier.

Returns:

The client's id.

getClientSecret

String getClientSecret()

Gets the client's secret.

Returns:

The client's secret.

getAccessTokenType

String getAccessTokenType()

Gets the type of access token the client requires.

Returns:

The access token type.

getDisplayName

String getDisplayName(Locale locale)

Gets the display name of the client in the specified locale.

Parameters:

locale - The locale.

Returns:

The display name.

getDisplayDescription

String getDisplayDescription(Locale locale)

Gets the display description of the client in the specified locale.

Parameters:

locale - The locale.

Returns:

The display description.

getScopeDescriptions

Map<String,String> getScopeDescriptions(Locale locale)
                                 throws ServerException

Gets the display descriptions for the allowed and default scopes combined, in the specified locale.

Parameters:

locale - The locale.

Returns:

The descriptions of the allowed and default scopes combined.

Throws:

ServerException

getClaimDescriptions

Map<String,String> getClaimDescriptions(Locale locale)
                                 throws ServerException

Gets the display descriptions for the allowed and default scopes combined, in the specified locale.

Parameters:

locale - The locale.

Returns:

The descriptions of the allowed and default scopes combined.

Throws:

ServerException

getDefaultScopes

Set<String> getDefaultScopes()

Gets the default scopes configured for the client.

Returns:

The default scopes.

getAllowedScopes

Set<String> getAllowedScopes()

Gets the allowed scopes configured for the client.

Returns:

The allowed scopes.

isConfidential

boolean isConfidential()

Gets whether the client is confidential or not.

Returns:

true if the client is confidential.

getClientSessionURI

String getClientSessionURI()

Gets the client's session URI.

Returns:

The client's session URI.

getSubjectType

String getSubjectType()

Gets the subject type of this client. PAIRWISE or PUBLIC.

verifyJwtIdentity

boolean verifyJwtIdentity(OAuth2Jwt jwt)

Verifies that the supplied jwt is signed by this client.

isConsentImplied

boolean isConsentImplied()

Gets whether or not the client wants the OAuth2 implementation to skip asking the resource owner for consent.

Returns:

true if the client is configured to skip resource owner consent.