com.google.api.auth

Class Authenticator

java.lang.Object

com.google.api.auth.Authenticator

public class Authenticator
extends java.lang.Object

An authenticator that extracts the auth token from the HTTP request and constructs a UserInfo object based on the claims contained in the auth token.

Method Summary

Modifier and Type	Method and Description
UserInfo	authenticate(javax.servlet.http.HttpServletRequest httpServletRequest, com.google.api.control.model.MethodRegistry.AuthInfo authInfo, java.lang.String serviceName) Authenticate the current HTTP request.
static Authenticator	create() Create an instance of Authenticator using the service configuration fetched from Google Service Management APIs.

Methods inherited from class java.lang.Object

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

Method Detail

authenticate

public UserInfo authenticate(javax.servlet.http.HttpServletRequest httpServletRequest,
                             com.google.api.control.model.MethodRegistry.AuthInfo authInfo,
                             java.lang.String serviceName)

Authenticate the current HTTP request.

Parameters:

httpServletRequest - is the incoming HTTP request object.

authInfo - contains authentication configurations of the API method being called.

serviceName - is the name of this service.

Returns:

a constructed UserInfo object representing the identity of the caller.

create

public static Authenticator create()

Create an instance of Authenticator using the service configuration fetched from Google Service Management APIs.

Returns:

an Authenticator

Throws:

java.lang.IllegalArgumentException - if the authentication message is not defined in the fetched service config.