|
Spring Social | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface OAuth2Operations
A service interface for the OAuth2 flow. This interface allows you to conduct the "OAuth dance" with a service provider on behalf of a user.
| Method Summary | |
|---|---|
AccessGrant |
authenticateClient()
Retrieves the client access grant using OAuth 2 client password flow. |
AccessGrant |
authenticateClient(java.lang.String scope)
Retrieves the client access grant using OAuth 2 client password flow. |
java.lang.String |
buildAuthenticateUrl(GrantType grantType,
OAuth2Parameters parameters)
Construct the URL to redirect the user to for authentication. |
java.lang.String |
buildAuthorizeUrl(GrantType grantType,
OAuth2Parameters parameters)
Construct the URL to redirect the user to for authorization. |
AccessGrant |
exchangeCredentialsForAccess(java.lang.String username,
java.lang.String password,
org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> additionalParameters)
Exchanges user credentials for an access grant using OAuth2's Resource Owner Credentials Grant (aka, "password" grant). |
AccessGrant |
exchangeForAccess(java.lang.String authorizationCode,
java.lang.String redirectUri,
org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> additionalParameters)
Exchange the authorization code for an access grant. |
AccessGrant |
refreshAccess(java.lang.String refreshToken,
org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> additionalParameters)
Refreshes a previous access grant. |
AccessGrant |
refreshAccess(java.lang.String refreshToken,
java.lang.String scope,
org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> additionalParameters)
Deprecated. Set the scope via additional parameters. This can be done conveniently user OAuth2Parameters. |
| Method Detail |
|---|
java.lang.String buildAuthorizeUrl(GrantType grantType,
OAuth2Parameters parameters)
grantType - specifies whether to use client-side or server-side OAuth flowparameters - authorization parameters needed to build the URL
java.lang.String buildAuthenticateUrl(GrantType grantType,
OAuth2Parameters parameters)
grantType - specifies whether to use client-side or server-side OAuth flowparameters - authorization parameters needed to build the URL
AccessGrant exchangeForAccess(java.lang.String authorizationCode,
java.lang.String redirectUri,
org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> additionalParameters)
authorizationCode - the authorization code returned by the provider upon user authorizationredirectUri - the authorization callback url; this value must match the redirectUri registered with the provideradditionalParameters - any additional parameters to be sent when exchanging the authorization code for an access grant. Should not be encoded.
AccessGrant exchangeCredentialsForAccess(java.lang.String username,
java.lang.String password,
org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> additionalParameters)
username - the user's username on the providerpassword - the user's password on the provideradditionalParameters - any additional parameters to be sent when exchanging the credentials for an access grant. Should not be encoded.
@Deprecated
AccessGrant refreshAccess(java.lang.String refreshToken,
java.lang.String scope,
org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> additionalParameters)
refreshToken - the refresh token from the previous access grant.scope - optional scope to narrow to when refreshing access; if null, the existing scope is preserved.additionalParameters - any additional parameters to be sent when refreshing a previous access grant. Should not be encoded.
AccessGrant refreshAccess(java.lang.String refreshToken,
org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> additionalParameters)
refreshToken - the refresh token from the previous access grant.additionalParameters - any additional parameters to be sent when refreshing a previous access grant. Should not be encoded.
AccessGrant authenticateClient()
AccessGrant authenticateClient(java.lang.String scope)
scope - optional scope to get for the access grant
|
Spring Social | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||