public class ClientCredentialsTokenRequest extends TokenRequest
Use Credential to access protected resources from the resource server using the TokenResponse returned by TokenRequest.execute(). On error, it will instead throw TokenResponseException.
Sample usage:
static void requestAccessToken() throws IOException {
try {
TokenResponse response =
new ClientCredentialsTokenRequest(new NetHttpTransport(), new GsonFactory(),
new GenericUrl("https://server.example.com/token"))
.setRedirectUri("https://client.example.com/rd")
.setClientAuthentication(
new BasicAuthentication("s6BhdRkqt3", "7Fjfp0ZBr1KtDRbnfVdmIw")).execute();
System.out.println("Access token: " + response.getAccessToken());
} catch (TokenResponseException e) {
if (e.getDetails() != null) {
System.err.println("Error: " + e.getDetails().getError());
if (e.getDetails().getErrorDescription() != null) {
System.err.println(e.getDetails().getErrorDescription());
}
if (e.getDetails().getErrorUri() != null) {
System.err.println(e.getDetails().getErrorUri());
}
} else {
System.err.println(e.getMessage());
}
}
}
Some OAuth 2.0 providers don't support BasicAuthentication but instead support ClientParametersAuthentication. In the above sample code, simply replace the class name and it
will work the same way.
Implementation is not thread-safe.
GenericData.FlagsAbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>responseClass| Constructor and Description |
|---|
ClientCredentialsTokenRequest(HttpTransport transport,
JsonFactory jsonFactory,
GenericUrl tokenServerUrl) |
| Modifier and Type | Method and Description |
|---|---|
ClientCredentialsTokenRequest |
set(String fieldName,
Object value) |
ClientCredentialsTokenRequest |
setClientAuthentication(HttpExecuteInterceptor clientAuthentication)
Sets the client authentication or
null for none. |
ClientCredentialsTokenRequest |
setGrantType(String grantType)
Sets the grant type (
"authorization_code", "password", "client_credentials", "refresh_token" or absolute URI of the extension grant type). |
ClientCredentialsTokenRequest |
setRequestInitializer(HttpRequestInitializer requestInitializer)
Sets the HTTP request initializer or
null for none. |
ClientCredentialsTokenRequest |
setResponseClass(Class<? extends TokenResponse> responseClass)
Sets the TokenResponse class to allow specifying object parsing.
|
ClientCredentialsTokenRequest |
setScopes(Collection<String> scopes)
Sets the list of scopes (as specified in Access Token Scope) or
null
for none. |
ClientCredentialsTokenRequest |
setTokenServerUrl(GenericUrl tokenServerUrl)
Sets the token server URL.
|
execute, executeUnparsed, getClientAuthentication, getGrantType, getJsonFactory, getRequestInitializer, getResponseClass, getScopes, getTokenServerUrl, getTransportclone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toStringclear, containsKey, containsValue, isEmpty, keySet, size, valuesfinalize, getClass, notify, notifyAll, wait, wait, waitcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAllpublic ClientCredentialsTokenRequest(HttpTransport transport, JsonFactory jsonFactory, GenericUrl tokenServerUrl)
transport - HTTP transportjsonFactory - JSON factorytokenServerUrl - token server URLpublic ClientCredentialsTokenRequest setRequestInitializer(HttpRequestInitializer requestInitializer)
TokenRequestnull for none.
Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
setRequestInitializer in class TokenRequestpublic ClientCredentialsTokenRequest setTokenServerUrl(GenericUrl tokenServerUrl)
TokenRequestOverriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
setTokenServerUrl in class TokenRequestpublic ClientCredentialsTokenRequest setScopes(Collection<String> scopes)
TokenRequestnull
for none.
Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
setScopes in class TokenRequestscopes - collection of scopes to be joined by a space separator (or a single value
containing multiple space-separated scopes)public ClientCredentialsTokenRequest setGrantType(String grantType)
TokenRequest"authorization_code", "password", "client_credentials", "refresh_token" or absolute URI of the extension grant type).
Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
setGrantType in class TokenRequestpublic ClientCredentialsTokenRequest setClientAuthentication(HttpExecuteInterceptor clientAuthentication)
TokenRequestnull for none.
The recommended initializer by the specification is BasicAuthentication. All
authorization servers must support that. A common alternative is ClientParametersAuthentication. An alternative client authentication method may be provided
that implements HttpRequestInitializer.
This HTTP request execute interceptor is guaranteed to be the last execute interceptor
before the request is executed, and after any execute interceptor set by the TokenRequest.getRequestInitializer().
Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
setClientAuthentication in class TokenRequestpublic ClientCredentialsTokenRequest set(String fieldName, Object value)
set in class TokenRequestpublic ClientCredentialsTokenRequest setResponseClass(Class<? extends TokenResponse> responseClass)
TokenRequestsetResponseClass in class TokenRequestresponseClass - The response class returned by TokenRequest.execute().Copyright © 2011–2021 Google. All rights reserved.