Class AbstractAuthorizationCodeCallbackServlet (1.39.0)

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 will be called. Similarly, if the end-user grants authorization, they will be redirected to this servlet and #onError 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
 }
 }
 

Returns the redirect URI for the given HTTP servlet request.

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.

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).

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");

Handles a successfully granted authorization.

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

resp.sendRedirect("/granted");