com.google.api.client.extensions.appengine.auth.oauth2

Class AbstractAppEngineAuthorizationCodeCallbackServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

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

com.google.api.client.extensions.appengine.auth.oauth2.AbstractAppEngineAuthorizationCodeCallbackServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class AbstractAppEngineAuthorizationCodeCallbackServlet
extends AbstractAuthorizationCodeCallbackServlet

Simple extension of AbstractAuthorizationCodeCallbackServlet that uses the currently logged-in Google Account user, as directed in Security and Authentication.

Note that if there is no currently logged-in user, getUserId(HttpServletRequest) will throw a NullPointerException. Example to require login for all pages:

  <security-constraint>
    <web-resource-collection>
      <web-resource-name>any</web-resource-name>
      <url-pattern>/*</url-pattern>
    </web-resource-collection>
    <auth-constraint>
      <role-name>*</role-name>
    </auth-constraint>
  </security-constraint>
 

Sample usage:

public class ServletCallbackSample extends AbstractAppEngineAuthorizationCodeCallbackServlet {

  @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 UrlFetchTransport(),
        new JacksonFactory(),
        new GenericUrl("https://server.example.com/token"),
        new BasicAuthentication("s6BhdRkqt3", "7Fjfp0ZBr1KtDRbnfVdmIw"),
        "s6BhdRkqt3",
        "https://server.example.com/authorize").setCredentialStore(new AppEngineCredentialStore())
        .build();
  }
 

Since:

1.7

Author:

Yaniv Inbar

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAppEngineAuthorizationCodeCallbackServlet()

Method Summary

Modifier and Type	Method and Description
protected String	getUserId(javax.servlet.http.HttpServletRequest req) Returns the user ID for the given HTTP servlet request.

Methods inherited from class com.google.api.client.extensions.servlet.auth.oauth2.AbstractAuthorizationCodeCallbackServlet

doGet, getRedirectUri, initializeFlow, onError, onSuccess

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.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

AbstractAppEngineAuthorizationCodeCallbackServlet

public AbstractAppEngineAuthorizationCodeCallbackServlet()

Method Detail

getUserId

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

Description copied from class: AbstractAuthorizationCodeCallbackServlet

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.

Specified by:

getUserId in class AbstractAuthorizationCodeCallbackServlet

Throws:

javax.servlet.ServletException

IOException