com.google.api.client.extensions.servlet.auth.oauth2.jakarta

Class AbstractAuthorizationCodeCallbackServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

com.google.api.client.extensions.servlet.auth.oauth2.jakarta.AbstractAuthorizationCodeCallbackServlet

All Implemented Interfaces:

jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public abstract class AbstractAuthorizationCodeCallbackServlet
extends jakarta.servlet.http.HttpServlet

Thread-safe OAuth 2.0 authorization code callback servlet using the jakarta namespace to process the authorization code or error response from authorization page redirect.

This is designed to simplify the flow in which an end-user authorizes your web application to access their protected data. The main servlet class extends AbstractAuthorizationCodeServlet which if the end-user credentials are not found, will redirect the end-user to an authorization page. If the end-user grants authorization, they will be redirected to this servlet that extends AbstractAuthorizationCodeCallbackServlet and the onSuccess(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, com.google.api.client.auth.oauth2.Credential) will be called. Similarly, if the end-user grants authorization, they will be redirected to this servlet and onError(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, com.google.api.client.auth.oauth2.AuthorizationCodeResponseUrl) will be called.

Sample usage:

 public class ServletCallbackSample extends AbstractAuthorizationCodeCallbackServlet {

 @Override
 protected void onSuccess(HttpServletRequest req, HttpServletResponse resp, Credential credential)
 throws ServletException, IOException {
 resp.sendRedirect("/");
 }

 @Override
 protected void onError(
 HttpServletRequest req, HttpServletResponse resp, AuthorizationCodeResponseUrl errorResponse)
 throws ServletException, IOException {
 // handle error
 }

 @Override
 protected String getRedirectUri(HttpServletRequest req) throws ServletException, IOException {
 GenericUrl url = new GenericUrl(req.getRequestURL().toString());
 url.setRawPath("/oauth2callback");
 return url.build();
 }

 @Override
 protected AuthorizationCodeFlow initializeFlow() throws IOException {
 return new AuthorizationCodeFlow.Builder(BearerToken.authorizationHeaderAccessMethod(),
 new NetHttpTransport(),
 new GsonFactory(),
 new GenericUrl("https://server.example.com/token"),
 new BasicAuthentication("s6BhdRkqt3", "7Fjfp0ZBr1KtDRbnfVdmIw"),
 "s6BhdRkqt3",
 "https://server.example.com/authorize").setCredentialStore(
 new JdoCredentialStore(JDOHelper.getPersistenceManagerFactory("transactions-optional")))
 .build();
 }

 @Override
 protected String getUserId(HttpServletRequest req) throws ServletException, IOException {
 // return user ID
 }
 }
 

Since:

1.36.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAuthorizationCodeCallbackServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp)
protected abstract String	getRedirectUri(jakarta.servlet.http.HttpServletRequest req) Returns the redirect URI for the given HTTP servlet request.
protected abstract String	getUserId(jakarta.servlet.http.HttpServletRequest req) Returns the user ID for the given HTTP servlet request.
protected abstract AuthorizationCodeFlow	initializeFlow() Loads the authorization code flow to be used across all HTTP servlet requests (only called during the first HTTP servlet request with an authorization code).
protected void	onError(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp, AuthorizationCodeResponseUrl errorResponse) Handles an error to the authorization, such as when an end user denies authorization.
protected void	onSuccess(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse resp, Credential credential) Handles a successfully granted authorization.

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAuthorizationCodeCallbackServlet

public AbstractAuthorizationCodeCallbackServlet()

Method Detail

doGet

protected final void doGet(jakarta.servlet.http.HttpServletRequest req,
                           jakarta.servlet.http.HttpServletResponse resp)
                    throws jakarta.servlet.ServletException,
                           IOException

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Throws:

jakarta.servlet.ServletException

IOException

initializeFlow

protected abstract AuthorizationCodeFlow initializeFlow()
                                                 throws jakarta.servlet.ServletException,
                                                        IOException

Loads the authorization code flow to be used across all HTTP servlet requests (only called during the first HTTP servlet request with an authorization code).

Throws:

jakarta.servlet.ServletException

IOException

getRedirectUri

protected abstract String getRedirectUri(jakarta.servlet.http.HttpServletRequest req)
                                  throws jakarta.servlet.ServletException,
                                         IOException

Returns the redirect URI for the given HTTP servlet request.

Throws:

jakarta.servlet.ServletException

IOException

getUserId

protected abstract String getUserId(jakarta.servlet.http.HttpServletRequest req)
                             throws jakarta.servlet.ServletException,
                                    IOException

Returns the user ID for the given HTTP servlet request. This identifies your application's user and is used to assign and persist credentials to that user. Most commonly, this will be a user id stored in the session or even the session id itself.

Throws:

jakarta.servlet.ServletException

IOException

onSuccess

protected void onSuccess(jakarta.servlet.http.HttpServletRequest req,
                         jakarta.servlet.http.HttpServletResponse resp,
                         Credential credential)
                  throws jakarta.servlet.ServletException,
                         IOException

Handles a successfully granted authorization.

Default implementation is to do nothing, but subclasses should override and implement. Sample implementation:

 resp.sendRedirect("/granted");
 

Parameters:

req - HTTP servlet request

resp - HTTP servlet response

credential - credential

Throws:

jakarta.servlet.ServletException - HTTP servlet exception

IOException - some I/O exception

onError

protected void onError(jakarta.servlet.http.HttpServletRequest req,
                       jakarta.servlet.http.HttpServletResponse resp,
                       AuthorizationCodeResponseUrl errorResponse)
                throws jakarta.servlet.ServletException,
                       IOException

Handles an error to the authorization, such as when an end user denies authorization.

Default implementation is to do nothing, but subclasses should override and implement. Sample implementation:

 resp.sendRedirect("/denied");
 

Parameters:

req - HTTP servlet request

resp - HTTP servlet response

errorResponse - error response (AuthorizationCodeResponseUrl.getError() is not null)

Throws:

jakarta.servlet.ServletException - HTTP servlet exception

IOException - some I/O exception