-
Notifications
You must be signed in to change notification settings - Fork 270
/
RefreshTokenRequest.java
142 lines (128 loc) · 4.85 KB
/
RefreshTokenRequest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
* Copyright (c) 2011 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
package com.google.api.client.auth.oauth2;
import com.google.api.client.http.BasicAuthentication;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpExecuteInterceptor;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.util.Key;
import com.google.api.client.util.Preconditions;
import java.util.Collection;
/**
* OAuth 2.0 request to refresh an access token using a refresh token as specified in <a
* href="http://tools.ietf.org/html/rfc6749#section-6">Refreshing an Access Token</a>.
*
* <p>Use {@link Credential} to access protected resources from the resource server using the {@link
* TokenResponse} returned by {@link #execute()}. On error, it will instead throw {@link
* TokenResponseException}.
*
* <p>Sample usage:
*
* <pre>
* static void refreshAccessToken() throws IOException {
* try {
* TokenResponse response =
* new RefreshTokenRequest(new NetHttpTransport(), new GsonFactory(), new GenericUrl(
* "https://server.example.com/token"), "tGzv3JOkF0XG5Qx2TlKWIA")
* .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());
* }
* }
* }
* </pre>
*
* <p>Some OAuth 2.0 providers don't support {@link BasicAuthentication} but instead support {@link
* ClientParametersAuthentication}. In the above sample code, simply replace the class name and it
* will work the same way.
*
* <p>Implementation is not thread-safe.
*
* @since 1.7
* @author Yaniv Inbar
*/
public class RefreshTokenRequest extends TokenRequest {
/** Refresh token issued to the client. */
@Key("refresh_token")
private String refreshToken;
/**
* @param transport HTTP transport
* @param jsonFactory JSON factory
* @param tokenServerUrl token server URL
* @param refreshToken refresh token issued to the client
*/
public RefreshTokenRequest(
HttpTransport transport,
JsonFactory jsonFactory,
GenericUrl tokenServerUrl,
String refreshToken) {
super(transport, jsonFactory, tokenServerUrl, "refresh_token");
setRefreshToken(refreshToken);
}
@Override
public RefreshTokenRequest setRequestInitializer(HttpRequestInitializer requestInitializer) {
return (RefreshTokenRequest) super.setRequestInitializer(requestInitializer);
}
@Override
public RefreshTokenRequest setTokenServerUrl(GenericUrl tokenServerUrl) {
return (RefreshTokenRequest) super.setTokenServerUrl(tokenServerUrl);
}
@Override
public RefreshTokenRequest setScopes(Collection<String> scopes) {
return (RefreshTokenRequest) super.setScopes(scopes);
}
@Override
public RefreshTokenRequest setGrantType(String grantType) {
return (RefreshTokenRequest) super.setGrantType(grantType);
}
@Override
public RefreshTokenRequest setClientAuthentication(HttpExecuteInterceptor clientAuthentication) {
return (RefreshTokenRequest) super.setClientAuthentication(clientAuthentication);
}
@Override
public RefreshTokenRequest setResponseClass(Class<? extends TokenResponse> responseClass) {
return (RefreshTokenRequest) super.setResponseClass(responseClass);
}
/** Returns the refresh token issued to the client. */
public final String getRefreshToken() {
return refreshToken;
}
/**
* Sets the refresh token issued to the client.
*
* <p>Overriding is only supported for the purpose of calling the super implementation and
* changing the return type, but nothing else.
*/
public RefreshTokenRequest setRefreshToken(String refreshToken) {
this.refreshToken = Preconditions.checkNotNull(refreshToken);
return this;
}
@Override
public RefreshTokenRequest set(String fieldName, Object value) {
return (RefreshTokenRequest) super.set(fieldName, value);
}
}