com.google.api.server.spi.request

Class Attribute

java.lang.Object

com.google.api.server.spi.request.Attribute

public class Attribute
extends java.lang.Object

Defines attribute constants passed in Request.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	API_METHOD_CONFIG A ApiMethodConfig with the current API method's configuration.
static java.lang.String	AUTH_TOKEN A String with the current request's auth token.
static java.lang.String	AUTHENTICATED_APPENGINE_USER A User with the currently authenticated App Engine user.
static java.lang.String	ENABLE_CLIENT_ID_WHITELIST A Boolean indicating if client id whitelist should be checked.
static java.lang.String	ID_TOKEN If set, contains a cached instance of a parsed and valid JWT GoogleIdToken corresponding to the String token in the AUTH_TOKEN "endpoints:Auth-Token" attribute.
static java.lang.String	REQUIRE_APPENGINE_USER A Boolean indicating if the App Engine user should be populated.
static java.lang.String	RESTRICT_SERVLET Deprecated.
static java.lang.String	SKIP_TOKEN_AUTH A Boolean indicating if token-based authentications (OAuth2 and JWT) should be skipped.
static java.lang.String	TOKEN_INFO If set, contains a cached OAuth2 GoogleAuth.TokenInfo corresponding to the String token in the AUTH_TOKEN "endpoints:Auth-Token" attribute.

Method Summary

Modifier and Type	Method and Description
static Attribute	bindStandardRequestAttributes(javax.servlet.http.HttpServletRequest request, ApiMethodConfig methodConfig, ServletInitializationParameters initParameters)
static Attribute	from(javax.servlet.http.HttpServletRequest request)
<T> T	get(java.lang.String attr)
boolean	isEnabled(java.lang.String attr)
void	remove(java.lang.String attr)
void	set(java.lang.String attr, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Field Detail

AUTHENTICATED_APPENGINE_USER

public static final java.lang.String AUTHENTICATED_APPENGINE_USER

A User with the currently authenticated App Engine user.

See Also:

Constant Field Values

API_METHOD_CONFIG

public static final java.lang.String API_METHOD_CONFIG

A ApiMethodConfig with the current API method's configuration.

See Also:

Constant Field Values

ENABLE_CLIENT_ID_WHITELIST

public static final java.lang.String ENABLE_CLIENT_ID_WHITELIST

A Boolean indicating if client id whitelist should be checked.

See Also:

Constant Field Values

RESTRICT_SERVLET

public static final java.lang.String RESTRICT_SERVLET

Deprecated.

See Also:

Constant Field Values

REQUIRE_APPENGINE_USER

public static final java.lang.String REQUIRE_APPENGINE_USER

A Boolean indicating if the App Engine user should be populated.

See Also:

Constant Field Values

SKIP_TOKEN_AUTH

public static final java.lang.String SKIP_TOKEN_AUTH

A Boolean indicating if token-based authentications (OAuth2 and JWT) should be skipped.

See Also:

Constant Field Values

AUTH_TOKEN

public static final java.lang.String AUTH_TOKEN

A String with the current request's auth token.

See Also:

Constant Field Values

TOKEN_INFO

public static final java.lang.String TOKEN_INFO

If set, contains a cached OAuth2 GoogleAuth.TokenInfo corresponding to the String token in the AUTH_TOKEN "endpoints:Auth-Token" attribute. The authentication from GoogleOAuth2Authenticator might have failed anyway because of unauthorized client id or scopes.

See Also:

Constant Field Values

ID_TOKEN

public static final java.lang.String ID_TOKEN

If set, contains a cached instance of a parsed and valid JWT GoogleIdToken corresponding to the String token in the AUTH_TOKEN "endpoints:Auth-Token" attribute. The authentication from GoogleJwtAuthenticator might have failed anyway because of unauthorized client id or audience.

See Also:

Constant Field Values

Method Detail

from

public static Attribute from(javax.servlet.http.HttpServletRequest request)

get

public <T> T get(java.lang.String attr)

set

public void set(java.lang.String attr,
                java.lang.Object value)

remove

public void remove(java.lang.String attr)

isEnabled

public boolean isEnabled(java.lang.String attr)

bindStandardRequestAttributes

public static Attribute bindStandardRequestAttributes(javax.servlet.http.HttpServletRequest request,
                                                      ApiMethodConfig methodConfig,
                                                      ServletInitializationParameters initParameters)