-
Notifications
You must be signed in to change notification settings - Fork 270
/
AuthorizationCodeTokenRequest.java
169 lines (152 loc) · 5.87 KB
/
AuthorizationCodeTokenRequest.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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/*
* 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 for an access token using an authorization code as specified in <a
* href="http://tools.ietf.org/html/rfc6749#section-4.1.3">Access Token Request</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 requestAccessToken() throws IOException {
* try {
* TokenResponse response =
* new AuthorizationCodeTokenRequest(new NetHttpTransport(), new GsonFactory(),
* new GenericUrl("https://server.example.com/token"), "SplxlOBeZQQYbYS6WxSbIA")
* .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());
* }
* }
* }
* </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 AuthorizationCodeTokenRequest extends TokenRequest {
/** Authorization code received from the authorization server. */
@Key private String code;
/**
* Redirect URI parameter matching the redirect URI parameter in the authorization request or
* {@code null} for none.
*/
@Key("redirect_uri")
private String redirectUri;
/**
* @param transport HTTP transport
* @param jsonFactory JSON factory
* @param tokenServerUrl token server URL
* @param code authorization code generated by the authorization server
*/
public AuthorizationCodeTokenRequest(
HttpTransport transport, JsonFactory jsonFactory, GenericUrl tokenServerUrl, String code) {
super(transport, jsonFactory, tokenServerUrl, "authorization_code");
setCode(code);
}
@Override
public AuthorizationCodeTokenRequest setRequestInitializer(
HttpRequestInitializer requestInitializer) {
return (AuthorizationCodeTokenRequest) super.setRequestInitializer(requestInitializer);
}
@Override
public AuthorizationCodeTokenRequest setTokenServerUrl(GenericUrl tokenServerUrl) {
return (AuthorizationCodeTokenRequest) super.setTokenServerUrl(tokenServerUrl);
}
@Override
public AuthorizationCodeTokenRequest setScopes(Collection<String> scopes) {
return (AuthorizationCodeTokenRequest) super.setScopes(scopes);
}
@Override
public AuthorizationCodeTokenRequest setGrantType(String grantType) {
return (AuthorizationCodeTokenRequest) super.setGrantType(grantType);
}
@Override
public AuthorizationCodeTokenRequest setClientAuthentication(
HttpExecuteInterceptor clientAuthentication) {
return (AuthorizationCodeTokenRequest) super.setClientAuthentication(clientAuthentication);
}
@Override
public AuthorizationCodeTokenRequest setResponseClass(
Class<? extends TokenResponse> responseClass) {
return (AuthorizationCodeTokenRequest) super.setResponseClass(responseClass);
}
/** Returns the authorization code generated by the authorization server. */
public final String getCode() {
return code;
}
/**
* Sets the authorization code generated by the authorization server.
*
* <p>Overriding is only supported for the purpose of calling the super implementation and
* changing the return type, but nothing else.
*/
public AuthorizationCodeTokenRequest setCode(String code) {
this.code = Preconditions.checkNotNull(code);
return this;
}
/**
* Returns the redirect URI parameter matching the redirect URI parameter in the authorization
* request or {@code null} for none.
*/
public final String getRedirectUri() {
return redirectUri;
}
/**
* Sets the redirect URI parameter matching the redirect URI parameter in the authorization
* request or {@code null} for none.
*
* <p>Overriding is only supported for the purpose of calling the super implementation and
* changing the return type, but nothing else.
*/
public AuthorizationCodeTokenRequest setRedirectUri(String redirectUri) {
this.redirectUri = redirectUri;
return this;
}
@Override
public AuthorizationCodeTokenRequest set(String fieldName, Object value) {
return (AuthorizationCodeTokenRequest) super.set(fieldName, value);
}
}