Class ClientRegistration
java.lang.Object
org.springframework.security.oauth2.client.registration.ClientRegistration
- All Implemented Interfaces:
Serializable
A representation of a client registration with an OAuth 2.0 or OpenID Connect 1.0
Provider.
- Since:
- 5.0
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A builder forClientRegistration
.class
Details of the Provider. -
Method Summary
Modifier and TypeMethodDescriptionReturns theauthorization grant type
used for the client.Returns theauthentication method
used when authenticating the client with the authorization server.Returns the client identifier.Returns the logical name of the client or registration.Returns the client secret.Returns the details of the provider.Returns the uri (or uri template) for the redirection endpoint.Returns the identifier for the registration.Returns the scope(s) used for the client.toString()
static ClientRegistration.Builder
withClientRegistration
(ClientRegistration clientRegistration) Returns a newClientRegistration.Builder
, initialized with the providedClientRegistration
.static ClientRegistration.Builder
withRegistrationId
(String registrationId) Returns a newClientRegistration.Builder
, initialized with the provided registration identifier.
-
Method Details
-
getRegistrationId
Returns the identifier for the registration.- Returns:
- the identifier for the registration
-
getClientId
Returns the client identifier.- Returns:
- the client identifier
-
getClientSecret
Returns the client secret.- Returns:
- the client secret
-
getClientAuthenticationMethod
Returns theauthentication method
used when authenticating the client with the authorization server.- Returns:
- the
ClientAuthenticationMethod
-
getAuthorizationGrantType
Returns theauthorization grant type
used for the client.- Returns:
- the
AuthorizationGrantType
-
getRedirectUri
Returns the uri (or uri template) for the redirection endpoint.
The supported uri template variables are: {baseScheme}, {baseHost}, {basePort}, {basePath} and {registrationId}.
NOTE: {baseUrl} is also supported, which is the same as {baseScheme}://{baseHost}{basePort}{basePath}.
Configuring uri template variables is especially useful when the client is running behind a Proxy Server. This ensures that the X-Forwarded-* headers are used when expanding the redirect-uri.- Returns:
- the uri (or uri template) for the redirection endpoint
- Since:
- 5.4
-
getScopes
Returns the scope(s) used for the client.- Returns:
- the
Set
of scope(s)
-
getProviderDetails
Returns the details of the provider.- Returns:
- the
ClientRegistration.ProviderDetails
-
getClientName
Returns the logical name of the client or registration.- Returns:
- the client or registration name
-
toString
-
withRegistrationId
Returns a newClientRegistration.Builder
, initialized with the provided registration identifier.- Parameters:
registrationId
- the identifier for the registration- Returns:
- the
ClientRegistration.Builder
-
withClientRegistration
public static ClientRegistration.Builder withClientRegistration(ClientRegistration clientRegistration) Returns a newClientRegistration.Builder
, initialized with the providedClientRegistration
.- Parameters:
clientRegistration
- theClientRegistration
to copy from- Returns:
- the
ClientRegistration.Builder
-