Skip to content

Commit 11d6a3c

Browse files
suztomogcf-owl-bot[bot]
suztomo
and
gcf-owl-bot[bot]
authoredMay 10, 2024··
feat: servlet classes that use the jakarta namespace (#1115)
* feat: servlet classes that use the jakarta namespace * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * copyright --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
·
v1.39.0louhi-1139
1 parent 6b62df1 commit 11d6a3c

File tree

9 files changed

+620
-0
lines changed

9 files changed

+620
-0
lines changed
 

‎google-oauth-client-appengine/pom.xml

+5
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,11 @@
123123
<artifactId>junit</artifactId>
124124
<scope>test</scope>
125125
</dependency>
126+
<dependency>
127+
<groupId>jakarta.servlet</groupId>
128+
<artifactId>jakarta.servlet-api</artifactId>
129+
<scope>provided</scope>
130+
</dependency>
126131
<dependency>
127132
<groupId>javax.servlet</groupId>
128133
<artifactId>servlet-api</artifactId>

‎google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/jakarta/AbstractAppEngineAuthorizationCodeCallbackServlet.java

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
/*
2+
* Copyright (c) 2024 Google Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5+
* in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software distributed under the License
10+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11+
* or implied. See the License for the specific language governing permissions and limitations under
12+
* the License.
13+
*/
14+
15+
package com.google.api.client.extensions.appengine.auth.oauth2.jakarta;
16+
17+
import com.google.api.client.extensions.servlet.auth.oauth2.jakarta.AbstractAuthorizationCodeCallbackServlet;
18+
import com.google.appengine.api.users.UserServiceFactory;
19+
import jakarta.servlet.ServletException;
20+
import jakarta.servlet.http.HttpServletRequest;
21+
import java.io.IOException;
22+
23+
/**
24+
* Simple extension of {@link AbstractAuthorizationCodeCallbackServlet} that uses the currently
25+
* logged-in Google Account user, as directed in <a
26+
* href="https://cloud.google.com/appengine/docs/standard/java/config/webxml#security-auth">Security
27+
* and Authentication</a>. This uses the {@code jakarta.servlet} namespace.
28+
*
29+
* <p>Note that if there is no currently logged-in user, {@link #getUserId(HttpServletRequest)} will
30+
* throw a {@link NullPointerException}. Example to require login for all pages:
31+
*
32+
* <pre>
33+
* &lt;security-constraint&gt;
34+
* &lt;web-resource-collection&gt;
35+
* &lt;web-resource-name&gt;any&lt;/web-resource-name&gt;
36+
* &lt;url-pattern&gt;/*&lt;/url-pattern&gt;
37+
* &lt;/web-resource-collection&gt;
38+
* &lt;auth-constraint&gt;
39+
* &lt;role-name&gt;*&lt;/role-name&gt;
40+
* &lt;/auth-constraint&gt;
41+
* &lt;/security-constraint&gt;
42+
* </pre>
43+
*
44+
* <p>Sample usage:
45+
*
46+
* <pre>
47+
* public class ServletCallbackSample extends AbstractAppEngineAuthorizationCodeCallbackServlet {
48+
*
49+
* &#64;Override
50+
* protected void onSuccess(HttpServletRequest req, HttpServletResponse resp, Credential credential)
51+
* throws ServletException, IOException {
52+
* resp.sendRedirect("/");
53+
* }
54+
*
55+
* &#64;Override
56+
* protected void onError(
57+
* HttpServletRequest req, HttpServletResponse resp, AuthorizationCodeResponseUrl errorResponse)
58+
* throws ServletException, IOException {
59+
* // handle error
60+
* }
61+
*
62+
* &#64;Override
63+
* protected String getRedirectUri(HttpServletRequest req) throws ServletException, IOException {
64+
* GenericUrl url = new GenericUrl(req.getRequestURL().toString());
65+
* url.setRawPath("/oauth2callback");
66+
* return url.build();
67+
* }
68+
*
69+
* &#64;Override
70+
* protected AuthorizationCodeFlow initializeFlow() throws IOException {
71+
* return new AuthorizationCodeFlow.Builder(BearerToken.authorizationHeaderAccessMethod(),
72+
* new UrlFetchTransport(),
73+
* new GsonFactory(),
74+
* new GenericUrl("https://server.example.com/token"),
75+
* new BasicAuthentication("s6BhdRkqt3", "7Fjfp0ZBr1KtDRbnfVdmIw"),
76+
* "s6BhdRkqt3",
77+
* "https://server.example.com/authorize").setCredentialStore(new AppEngineCredentialStore())
78+
* .build();
79+
* }
80+
* </pre>
81+
*
82+
* @since 1.36.0
83+
*/
84+
public abstract class AbstractAppEngineAuthorizationCodeCallbackServlet
85+
extends AbstractAuthorizationCodeCallbackServlet {
86+
87+
private static final long serialVersionUID = 1L;
88+
89+
@Override
90+
protected String getUserId(HttpServletRequest req) throws ServletException, IOException {
91+
// Use GAE Standard's users service to fetch the current user of the application.
92+
return UserServiceFactory.getUserService().getCurrentUser().getUserId();
93+
}
94+
}

‎google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/jakarta/AbstractAppEngineAuthorizationCodeServlet.java

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
/*
2+
* Copyright (c) 2024 Google Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5+
* in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software distributed under the License
10+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11+
* or implied. See the License for the specific language governing permissions and limitations under
12+
* the License.
13+
*/
14+
15+
package com.google.api.client.extensions.appengine.auth.oauth2.jakarta;
16+
17+
import com.google.api.client.extensions.servlet.auth.oauth2.jakarta.AbstractAuthorizationCodeServlet;
18+
import com.google.appengine.api.users.UserServiceFactory;
19+
import jakarta.servlet.ServletException;
20+
import jakarta.servlet.http.HttpServletRequest;
21+
import java.io.IOException;
22+
23+
/**
24+
* Simple extension of {@link AbstractAuthorizationCodeServlet} that uses the currently logged-in
25+
* Google Account user, as directed in <a
26+
* href="https://cloud.google.com/appengine/docs/standard/java/config/webxml#security-auth">Security
27+
* and Authentication</a>. This uses the {@code jakarta.servlet} namespace.
28+
*
29+
* <p>Note that if there is no currently logged-in user, {@link #getUserId(HttpServletRequest)} will
30+
* throw a {@link NullPointerException}. Example to require login for all pages:
31+
*
32+
* <pre>
33+
* &lt;security-constraint&gt;
34+
* &lt;web-resource-collection&gt;
35+
* &lt;web-resource-name&gt;any&lt;/web-resource-name&gt;
36+
* &lt;url-pattern&gt;/*&lt;/url-pattern&gt;
37+
* &lt;/web-resource-collection&gt;
38+
* &lt;auth-constraint&gt;
39+
* &lt;role-name&gt;*&lt;/role-name&gt;
40+
* &lt;/auth-constraint&gt;
41+
* &lt;/security-constraint&gt;
42+
* </pre>
43+
*
44+
* <p>Sample usage:
45+
*
46+
* <pre>
47+
* public class ServletSample extends AbstractAppEngineAuthorizationCodeServlet {
48+
*
49+
* &#64;Override
50+
* protected void doGet(HttpServletRequest request, HttpServletResponse response)
51+
* throws IOException {
52+
* // do stuff
53+
* }
54+
*
55+
* &#64;Override
56+
* protected String getRedirectUri(HttpServletRequest req) throws ServletException, IOException {
57+
* GenericUrl url = new GenericUrl(req.getRequestURL().toString());
58+
* url.setRawPath("/oauth2callback");
59+
* return url.build();
60+
* }
61+
*
62+
* &#64;Override
63+
* protected AuthorizationCodeFlow initializeFlow() throws IOException {
64+
* return new AuthorizationCodeFlow.Builder(BearerToken.authorizationHeaderAccessMethod(),
65+
* new UrlFetchTransport(),
66+
* new GsonFactory(),
67+
* new GenericUrl("https://server.example.com/token"),
68+
* new BasicAuthentication("s6BhdRkqt3", "7Fjfp0ZBr1KtDRbnfVdmIw"),
69+
* "s6BhdRkqt3",
70+
* "https://server.example.com/authorize").setCredentialStore(new AppEngineCredentialStore())
71+
* .build();
72+
* }
73+
* }
74+
* </pre>
75+
*
76+
* @since 1.36.0
77+
*/
78+
public abstract class AbstractAppEngineAuthorizationCodeServlet
79+
extends AbstractAuthorizationCodeServlet {
80+
81+
private static final long serialVersionUID = 1L;
82+
83+
@Override
84+
protected String getUserId(HttpServletRequest req) throws ServletException, IOException {
85+
// Use GAE Standard's users service to fetch the current user of the application.
86+
return UserServiceFactory.getUserService().getCurrentUser().getUserId();
87+
}
88+
}

‎google-oauth-client-appengine/src/main/java/com/google/api/client/extensions/appengine/auth/oauth2/jakarta/package-info.java

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/*
2+
* Copyright (c) 2024 Google Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5+
* in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software distributed under the License
10+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11+
* or implied. See the License for the specific language governing permissions and limitations under
12+
* the License.
13+
*/
14+
15+
/**
16+
* OAuth 2.0 utilities that help simplify the authorization flow on Google App Engine. This package
17+
* uses the {@code jakarta.servlet} namespace.
18+
*
19+
* @since 1.36.0
20+
*/
21+
package com.google.api.client.extensions.appengine.auth.oauth2.jakarta;

‎google-oauth-client-servlet/pom.xml

+5
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,11 @@
116116
<groupId>com.google.http-client</groupId>
117117
<artifactId>google-http-client</artifactId>
118118
</dependency>
119+
<dependency>
120+
<groupId>jakarta.servlet</groupId>
121+
<artifactId>jakarta.servlet-api</artifactId>
122+
<scope>provided</scope>
123+
</dependency>
119124
<dependency>
120125
<groupId>javax.servlet</groupId>
121126
<artifactId>servlet-api</artifactId>

‎google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/jakarta/AbstractAuthorizationCodeCallbackServlet.java

+188
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
/*
2+
* Copyright (c) 2024 Google Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5+
* in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software distributed under the License
10+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11+
* or implied. See the License for the specific language governing permissions and limitations under
12+
* the License.
13+
*/
14+
15+
package com.google.api.client.extensions.servlet.auth.oauth2.jakarta;
16+
17+
import com.google.api.client.auth.oauth2.AuthorizationCodeFlow;
18+
import com.google.api.client.auth.oauth2.AuthorizationCodeResponseUrl;
19+
import com.google.api.client.auth.oauth2.Credential;
20+
import com.google.api.client.auth.oauth2.TokenResponse;
21+
import jakarta.servlet.ServletException;
22+
import jakarta.servlet.http.HttpServlet;
23+
import jakarta.servlet.http.HttpServletRequest;
24+
import jakarta.servlet.http.HttpServletResponse;
25+
import java.io.IOException;
26+
import java.util.concurrent.locks.Lock;
27+
import java.util.concurrent.locks.ReentrantLock;
28+
29+
/**
30+
* Thread-safe OAuth 2.0 authorization code callback servlet using the jakarta namespace to process
31+
* the authorization code or error response from authorization page redirect.
32+
*
33+
* <p>This is designed to simplify the flow in which an end-user authorizes your web application to
34+
* access their protected data. The main servlet class extends {@link
35+
* AbstractAuthorizationCodeServlet} which if the end-user credentials are not found, will redirect
36+
* the end-user to an authorization page. If the end-user grants authorization, they will be
37+
* redirected to this servlet that extends {@link AbstractAuthorizationCodeCallbackServlet} and the
38+
* {@link #onSuccess} will be called. Similarly, if the end-user grants authorization, they will be
39+
* redirected to this servlet and {@link #onError} will be called.
40+
*
41+
* <p>Sample usage:
42+
*
43+
* <pre>
44+
* public class ServletCallbackSample extends AbstractAuthorizationCodeCallbackServlet {
45+
*
46+
* &#64;Override
47+
* protected void onSuccess(HttpServletRequest req, HttpServletResponse resp, Credential credential)
48+
* throws ServletException, IOException {
49+
* resp.sendRedirect("/");
50+
* }
51+
*
52+
* &#64;Override
53+
* protected void onError(
54+
* HttpServletRequest req, HttpServletResponse resp, AuthorizationCodeResponseUrl errorResponse)
55+
* throws ServletException, IOException {
56+
* // handle error
57+
* }
58+
*
59+
* &#64;Override
60+
* protected String getRedirectUri(HttpServletRequest req) throws ServletException, IOException {
61+
* GenericUrl url = new GenericUrl(req.getRequestURL().toString());
62+
* url.setRawPath("/oauth2callback");
63+
* return url.build();
64+
* }
65+
*
66+
* &#64;Override
67+
* protected AuthorizationCodeFlow initializeFlow() throws IOException {
68+
* return new AuthorizationCodeFlow.Builder(BearerToken.authorizationHeaderAccessMethod(),
69+
* new NetHttpTransport(),
70+
* new GsonFactory(),
71+
* new GenericUrl("https://server.example.com/token"),
72+
* new BasicAuthentication("s6BhdRkqt3", "7Fjfp0ZBr1KtDRbnfVdmIw"),
73+
* "s6BhdRkqt3",
74+
* "https://server.example.com/authorize").setCredentialStore(
75+
* new JdoCredentialStore(JDOHelper.getPersistenceManagerFactory("transactions-optional")))
76+
* .build();
77+
* }
78+
*
79+
* &#64;Override
80+
* protected String getUserId(HttpServletRequest req) throws ServletException, IOException {
81+
* // return user ID
82+
* }
83+
* }
84+
* </pre>
85+
*
86+
* @since 1.36.0
87+
*/
88+
public abstract class AbstractAuthorizationCodeCallbackServlet extends HttpServlet {
89+
90+
private static final long serialVersionUID = 1L;
91+
92+
/** Lock on the flow. */
93+
private final Lock lock = new ReentrantLock();
94+
95+
/**
96+
* Authorization code flow to be used across all HTTP servlet requests or {@code null} before
97+
* initialized in {@link #initializeFlow()}.
98+
*/
99+
private AuthorizationCodeFlow flow;
100+
101+
@Override
102+
protected final void doGet(HttpServletRequest req, HttpServletResponse resp)
103+
throws ServletException, IOException {
104+
StringBuffer buf = req.getRequestURL();
105+
if (req.getQueryString() != null) {
106+
buf.append('?').append(req.getQueryString());
107+
}
108+
AuthorizationCodeResponseUrl responseUrl = new AuthorizationCodeResponseUrl(buf.toString());
109+
String code = responseUrl.getCode();
110+
if (responseUrl.getError() != null) {
111+
onError(req, resp, responseUrl);
112+
} else if (code == null) {
113+
resp.setStatus(HttpServletResponse.SC_BAD_REQUEST);
114+
resp.getWriter().print("Missing authorization code");
115+
} else {
116+
lock.lock();
117+
try {
118+
if (flow == null) {
119+
flow = initializeFlow();
120+
}
121+
String redirectUri = getRedirectUri(req);
122+
TokenResponse response = flow.newTokenRequest(code).setRedirectUri(redirectUri).execute();
123+
String userId = getUserId(req);
124+
Credential credential = flow.createAndStoreCredential(response, userId);
125+
onSuccess(req, resp, credential);
126+
} finally {
127+
lock.unlock();
128+
}
129+
}
130+
}
131+
132+
/**
133+
* Loads the authorization code flow to be used across all HTTP servlet requests (only called
134+
* during the first HTTP servlet request with an authorization code).
135+
*/
136+
protected abstract AuthorizationCodeFlow initializeFlow() throws ServletException, IOException;
137+
138+
/** Returns the redirect URI for the given HTTP servlet request. */
139+
protected abstract String getRedirectUri(HttpServletRequest req)
140+
throws ServletException, IOException;
141+
142+
/**
143+
* Returns the user ID for the given HTTP servlet request. This identifies your application's user
144+
* and is used to assign and persist credentials to that user. Most commonly, this will be a user
145+
* id stored in the session or even the session id itself.
146+
*/
147+
protected abstract String getUserId(HttpServletRequest req) throws ServletException, IOException;
148+
149+
/**
150+
* Handles a successfully granted authorization.
151+
*
152+
* <p>Default implementation is to do nothing, but subclasses should override and implement.
153+
* Sample implementation:
154+
*
155+
* <pre>
156+
* resp.sendRedirect("/granted");
157+
* </pre>
158+
*
159+
* @param req HTTP servlet request
160+
* @param resp HTTP servlet response
161+
* @param credential credential
162+
* @throws ServletException HTTP servlet exception
163+
* @throws IOException some I/O exception
164+
*/
165+
protected void onSuccess(HttpServletRequest req, HttpServletResponse resp, Credential credential)
166+
throws ServletException, IOException {}
167+
168+
/**
169+
* Handles an error to the authorization, such as when an end user denies authorization.
170+
*
171+
* <p>Default implementation is to do nothing, but subclasses should override and implement.
172+
* Sample implementation:
173+
*
174+
* <pre>
175+
* resp.sendRedirect("/denied");
176+
* </pre>
177+
*
178+
* @param req HTTP servlet request
179+
* @param resp HTTP servlet response
180+
* @param errorResponse error response ({@link AuthorizationCodeResponseUrl#getError()} is not
181+
* {@code null})
182+
* @throws ServletException HTTP servlet exception
183+
* @throws IOException some I/O exception
184+
*/
185+
protected void onError(
186+
HttpServletRequest req, HttpServletResponse resp, AuthorizationCodeResponseUrl errorResponse)
187+
throws ServletException, IOException {}
188+
}

‎google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/jakarta/AbstractAuthorizationCodeServlet.java

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
/*
2+
* Copyright (c) 2024 Google Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5+
* in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software distributed under the License
10+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11+
* or implied. See the License for the specific language governing permissions and limitations under
12+
* the License.
13+
*/
14+
15+
package com.google.api.client.extensions.servlet.auth.oauth2.jakarta;
16+
17+
import com.google.api.client.auth.oauth2.AuthorizationCodeFlow;
18+
import com.google.api.client.auth.oauth2.AuthorizationCodeRequestUrl;
19+
import com.google.api.client.auth.oauth2.Credential;
20+
import com.google.api.client.http.HttpResponseException;
21+
import jakarta.servlet.ServletException;
22+
import jakarta.servlet.http.HttpServlet;
23+
import jakarta.servlet.http.HttpServletRequest;
24+
import jakarta.servlet.http.HttpServletResponse;
25+
import java.io.IOException;
26+
import java.util.concurrent.locks.Lock;
27+
import java.util.concurrent.locks.ReentrantLock;
28+
29+
/**
30+
* Thread-safe OAuth 2.0 authorization code flow HTTP servlet using the jakarta namespace that
31+
* manages and persists end-user credentials.
32+
*
33+
* <p>This is designed to simplify the flow in which an end-user authorizes your web application to
34+
* access their protected data. Your application then has access to their data based on an access
35+
* token and a refresh token to refresh that access token when it expires. Your main servlet class
36+
* should extend {@link AbstractAuthorizationCodeServlet} and implement the abstract methods. To get
37+
* the persisted credential associated with the current request, call {@link #getCredential()}. It
38+
* is assumed that the end-user is authenticated by some external means by which a user ID is
39+
* obtained. This user ID is used as the primary key for persisting the end-user credentials, and
40+
* passed in via {@link #getUserId(HttpServletRequest)}. The first time an end-user arrives at your
41+
* servlet, they will be redirected in the browser to an authorization page. Next, they will be
42+
* redirected back to your site at the redirect URI selected in {@link
43+
* #getRedirectUri(HttpServletRequest)}. The servlet to process that should extend {@link
44+
* AbstractAuthorizationCodeCallbackServlet}, which should redirect back to this servlet on success.
45+
*
46+
* <p>Although this implementation is thread-safe, it can only process one request at a time. For a
47+
* more performance-critical multi-threaded web application, instead use {@link
48+
* AuthorizationCodeFlow} directly.
49+
*
50+
* <p>Sample usage:
51+
*
52+
* <pre>
53+
* public class ServletSample extends AbstractAuthorizationCodeServlet {
54+
*
55+
* &#64;Override
56+
* protected void doGet(HttpServletRequest request, HttpServletResponse response)
57+
* throws IOException {
58+
* // do stuff
59+
* }
60+
*
61+
* &#64;Override
62+
* protected String getRedirectUri(HttpServletRequest req) throws ServletException, IOException {
63+
* GenericUrl url = new GenericUrl(req.getRequestURL().toString());
64+
* url.setRawPath("/oauth2callback");
65+
* return url.build();
66+
* }
67+
*
68+
* &#64;Override
69+
* protected AuthorizationCodeFlow initializeFlow() throws IOException {
70+
* return new AuthorizationCodeFlow.Builder(BearerToken.authorizationHeaderAccessMethod(),
71+
* new NetHttpTransport(),
72+
* new GsonFactory(),
73+
* new GenericUrl("https://server.example.com/token"),
74+
* new BasicAuthentication("s6BhdRkqt3", "7Fjfp0ZBr1KtDRbnfVdmIw"),
75+
* "s6BhdRkqt3",
76+
* "https://server.example.com/authorize").setCredentialStore(
77+
* new JdoCredentialStore(JDOHelper.getPersistenceManagerFactory("transactions-optional")))
78+
* .build();
79+
* }
80+
*
81+
* &#64;Override
82+
* protected String getUserId(HttpServletRequest req) throws ServletException, IOException {
83+
* // return user ID
84+
* }
85+
* }
86+
* </pre>
87+
*
88+
* @since 1.36.0
89+
*/
90+
public abstract class AbstractAuthorizationCodeServlet extends HttpServlet {
91+
92+
private static final long serialVersionUID = 1L;
93+
94+
/** Lock on the flow and credential. */
95+
private final Lock lock = new ReentrantLock();
96+
97+
/** Persisted credential associated with the current request or {@code null} for none. */
98+
private Credential credential;
99+
100+
/**
101+
* Authorization code flow to be used across all HTTP servlet requests or {@code null} before
102+
* initialized in {@link #initializeFlow()}.
103+
*/
104+
private AuthorizationCodeFlow flow;
105+
106+
@Override
107+
protected void service(HttpServletRequest req, HttpServletResponse resp)
108+
throws IOException, ServletException {
109+
lock.lock();
110+
try {
111+
// load credential from persistence store
112+
String userId = getUserId(req);
113+
if (flow == null) {
114+
flow = initializeFlow();
115+
}
116+
credential = flow.loadCredential(userId);
117+
// if credential found with an access token, invoke the user code
118+
if (credential != null && credential.getAccessToken() != null) {
119+
try {
120+
super.service(req, resp);
121+
return;
122+
} catch (HttpResponseException e) {
123+
// if access token is null, assume it is because auth failed and we need to re-authorize
124+
// but if access token is not null, it is some other problem
125+
if (credential.getAccessToken() != null) {
126+
throw e;
127+
}
128+
}
129+
}
130+
// redirect to the authorization flow
131+
AuthorizationCodeRequestUrl authorizationUrl = flow.newAuthorizationUrl();
132+
authorizationUrl.setRedirectUri(getRedirectUri(req));
133+
onAuthorization(req, resp, authorizationUrl);
134+
credential = null;
135+
} finally {
136+
lock.unlock();
137+
}
138+
}
139+
140+
/**
141+
* Loads the authorization code flow to be used across all HTTP servlet requests (only called
142+
* during the first HTTP servlet request).
143+
*/
144+
protected abstract AuthorizationCodeFlow initializeFlow() throws ServletException, IOException;
145+
146+
/** Returns the redirect URI for the given HTTP servlet request. */
147+
protected abstract String getRedirectUri(HttpServletRequest req)
148+
throws ServletException, IOException;
149+
150+
/**
151+
* Returns the user ID for the given HTTP servlet request. This identifies your application's user
152+
* and is used to fetch persisted credentials for that user. Most commonly, this will be a user id
153+
* stored in the session or even the session id itself.
154+
*/
155+
protected abstract String getUserId(HttpServletRequest req) throws ServletException, IOException;
156+
157+
/**
158+
* Return the persisted credential associated with the current request or {@code null} for none.
159+
*/
160+
protected final Credential getCredential() {
161+
return credential;
162+
}
163+
164+
/**
165+
* Handles user authorization by redirecting to the OAuth 2.0 authorization server.
166+
*
167+
* <p>Default implementation is to call {@code resp.sendRedirect(authorizationUrl.build())}.
168+
* Subclasses may override to provide optional parameters such as the recommended state parameter.
169+
* Sample implementation:
170+
*
171+
* <pre>
172+
* &#64;Override
173+
* protected void onAuthorization(HttpServletRequest req, HttpServletResponse resp,
174+
* AuthorizationCodeRequestUrl authorizationUrl) throws ServletException, IOException {
175+
* authorizationUrl.setState("xyz");
176+
* super.onAuthorization(req, resp, authorizationUrl);
177+
* }
178+
* </pre>
179+
*
180+
* @param authorizationUrl authorization code request URL
181+
* @param req HTTP servlet request
182+
* @throws ServletException servlet exception
183+
*/
184+
protected void onAuthorization(
185+
HttpServletRequest req,
186+
HttpServletResponse resp,
187+
AuthorizationCodeRequestUrl authorizationUrl)
188+
throws ServletException, IOException {
189+
resp.sendRedirect(authorizationUrl.build());
190+
}
191+
}

‎google-oauth-client-servlet/src/main/java/com/google/api/client/extensions/servlet/auth/oauth2/jakarta/package-info.java

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/*
2+
* Copyright (c) 2024 Google Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
5+
* in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software distributed under the License
10+
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
11+
* or implied. See the License for the specific language governing permissions and limitations under
12+
* the License.
13+
*/
14+
15+
/**
16+
* OAuth 2.0 utilities that help simplify the authorization flow in HTTP servlets in the {@code
17+
* jakarta.servlet} namespace.
18+
*
19+
* @since 1.36.0
20+
*/
21+
package com.google.api.client.extensions.servlet.auth.oauth2.jakarta;

‎pom.xml

+7
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,11 @@
116116
<artifactId>jdo2-api</artifactId>
117117
<version>${project.jdo2-api.version}</version>
118118
</dependency>
119+
<dependency>
120+
<groupId>jakarta.servlet</groupId>
121+
<artifactId>jakarta.servlet-api</artifactId>
122+
<version>${project.jakarta-servlet-api.version}</version>
123+
</dependency>
119124
<dependency>
120125
<groupId>javax.servlet</groupId>
121126
<artifactId>servlet-api</artifactId>
@@ -462,6 +467,8 @@
462467
<project.appengine.version>2.0.6</project.appengine.version>
463468
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
464469
<project.http.version>1.43.3</project.http.version>
470+
<!-- jakarta-servlet-api 5.0.0 is the last version that works with Java 8 -->
471+
<project.jakarta-servlet-api.version>5.0.0</project.jakarta-servlet-api.version>
465472
<project.jsr305.version>3.0.2</project.jsr305.version>
466473
<project.guava.version>31.1-android</project.guava.version>
467474
<project.xpp3.version>1.1.4c</project.xpp3.version>

0 commit comments

Comments
 (0)
Please sign in to comment.