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

Class AbstractAppEngineCallbackServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.google.api.client.extensions.servlet.auth.AbstractCallbackServlet

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

All Implemented Interfaces:

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

@Beta
public abstract class AbstractAppEngineCallbackServlet
extends AbstractCallbackServlet

Beta
This servlet fills in some of the required information for the AbstractCallbackServlet with reasonable defaults for App Engine. It will default the servlet to creating UrlFetchTransport objects whenever an HttpTransport is needed. It will also default the user identifier to the logged in App Engine user. This servlet requires that the App Engine user must be logged in to work correctly. This can be accomplished by adding a security constraint in your web.xml for the path at which this servlet will live.

Example that requires 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>
 
 

Warning: starting with version 1.7, usage of this for OAuth 2.0 is deprecated. Instead use AbstractAppEngineAuthorizationCodeCallbackServlet.

Upgrade warning: in version 1.15 there was an implementation of AbstractCallbackServlet.newJsonFactoryInstance() that used com.google.api.client.json.jackson.JacksonFactory, but starting with version 1.16 there is no such implementation.

Since:

1.4

Author:

moshenko@google.com (Jacob Moshenko)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractAppEngineCallbackServlet()

Method Summary

Modifier and Type	Method and Description
protected String	getUserId() Return the user ID of the user that is logged in.
protected HttpTransport	newHttpTransportInstance() Create a new HttpTransport instance.

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

doGet, getCompletionCodeQueryParam, getConcreteFlowType, getDeniedRedirectUrl, getHttpTransport, getJsonFactory, getPersistenceManagerFactory, getSuccessRedirectUrl, newJsonFactoryInstance

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

AbstractAppEngineCallbackServlet

public AbstractAppEngineCallbackServlet()

Method Detail

getUserId

protected String getUserId()

Return the user ID of the user that is logged in.

Specified by:

getUserId in class AbstractCallbackServlet

Returns:

Get a string representation of a userId that can be used to associate credentials and flows with a specific user.

Throws:

IllegalStateException - Thrown when no user is logged in.

newHttpTransportInstance

protected HttpTransport newHttpTransportInstance()

Description copied from class: AbstractCallbackServlet

Create a new HttpTransport instance. Implementations can create any type of applicable transport and should be as simple as:

  new NetHttpTransport();
 

Specified by:

newHttpTransportInstance in class AbstractCallbackServlet

Returns:

HttpTransport instance for your particular environment