Class AbstractAppEngineAuthorizationCodeServlet (1.32.1)

Version 1.32.1

• 1.36.0 (latest)
• 1.34.1
• 1.33.3
• 1.32.1

public abstract class AbstractAppEngineAuthorizationCodeServlet extends AbstractAuthorizationCodeServlet

Simple extension of AbstractAuthorizationCodeServlet 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 ServletSample extends AbstractAppEngineAuthorizationCodeServlet {

@Override protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException { // do stuff }

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

Inheritance

java.lang.Object > javax.servlet.GenericServlet > HttpServlet > AbstractAuthorizationCodeServlet > AbstractAppEngineAuthorizationCodeServlet

Inherited Members

AbstractAuthorizationCodeServlet.getCredential()

AbstractAuthorizationCodeServlet.getRedirectUri(HttpServletRequest)

AbstractAuthorizationCodeServlet.getUserId(HttpServletRequest)

AbstractAuthorizationCodeServlet.initializeFlow()

AbstractAuthorizationCodeServlet.onAuthorization(HttpServletRequest,HttpServletResponse,AuthorizationCodeRequestUrl)

AbstractAuthorizationCodeServlet.service(HttpServletRequest,HttpServletResponse)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

GenericServlet.destroy()

GenericServlet.getInitParameter(String)

GenericServlet.getInitParameterNames()

GenericServlet.getServletConfig()

GenericServlet.getServletContext()

GenericServlet.getServletInfo()

GenericServlet.getServletName()

GenericServlet.init()

GenericServlet.init(ServletConfig)

GenericServlet.log(String)

GenericServlet.log(String,Throwable)

HttpServlet.doDelete(HttpServletRequest,HttpServletResponse)

HttpServlet.doGet(HttpServletRequest,HttpServletResponse)

HttpServlet.doHead(HttpServletRequest,HttpServletResponse)

HttpServlet.doOptions(HttpServletRequest,HttpServletResponse)

HttpServlet.doPost(HttpServletRequest,HttpServletResponse)

HttpServlet.doPut(HttpServletRequest,HttpServletResponse)

HttpServlet.doTrace(HttpServletRequest,HttpServletResponse)

HttpServlet.getLastModified(HttpServletRequest)

HttpServlet.service(ServletRequest,ServletResponse)

Constructors

AbstractAppEngineAuthorizationCodeServlet()

public AbstractAppEngineAuthorizationCodeServlet()

Methods

getUserId(HttpServletRequest req)

protected String getUserId(HttpServletRequest req)

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

Parameter

Name	Description
req	HttpServletRequest

Returns

Type	Description
String

Overrides

AbstractAuthorizationCodeServlet.getUserId(HttpServletRequest req)

Exceptions

Type	Description
ServletException
IOException