Package com.google.appengine.api.users.dev

Class LocalUserService

java.lang.Object

com.google.appengine.tools.development.AbstractLocalRpcService

com.google.appengine.api.users.dev.LocalUserService

All Implemented Interfaces:

LocalRpcService

@AutoService(LocalRpcService.class)
public final class LocalUserService
extends AbstractLocalRpcService

creates URLs that point to LocalLoginServlet and LocalLogoutServlet when used within the Development AppServer environment. There is a known discrepancy between this implementation and the production implementation. The production version will throw a ApiProxy.ApplicationException with applicationError set to UserServicePb.UserServiceError.ErrorCode.REDIRECT_URL_TOO_LONG when the url passed to createLoginURL(com.google.appengine.tools.development.LocalRpcService.Status, com.google.apphosting.api.UserServicePb.CreateLoginURLRequest) or createLogoutURL(com.google.appengine.tools.development.LocalRpcService.Status, com.google.apphosting.api.UserServicePb.CreateLogoutURLRequest) is too long. This implementation does not perform this check and therefore never returns this error.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.appengine.tools.development.LocalRpcService

LocalRpcService.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OAUTH_AUTH_DOMAIN_PROPERTY
static final String	OAUTH_CONSUMER_KEY_PROPERTY
static final String	OAUTH_EMAIL_PROPERTY
static final String	OAUTH_IS_ADMIN_PROPERTY
static final String	OAUTH_USER_ID_PROPERTY
static final String	PACKAGE	The package name for this service.

Constructor Summary

Constructors

Constructor	Description
LocalUserService()

Method Summary

Modifier and Type	Method	Description
UserServicePb.CreateLoginURLResponse	createLoginURL(LocalRpcService.Status status, UserServicePb.CreateLoginURLRequest request)
UserServicePb.CreateLogoutURLResponse	createLogoutURL(LocalRpcService.Status status, UserServicePb.CreateLogoutURLRequest request)
UserServicePb.GetOAuthUserResponse	getOAuthUser(LocalRpcService.Status status, UserServicePb.GetOAuthUserRequest request)
String	getPackage()	Returns the package for the service, for example, "datastore_v3".
void	init(LocalServiceContext context, Map<String,String> properties)	Initializes the service with a set of configuration properties.
void	start()	Puts a new service into "serving" mode.
void	stop()	Stops the service, releasing all of its resources.

Methods inherited from class com.google.appengine.tools.development.AbstractLocalRpcService

getDefaultDeadline, getMaxApiRequestSize, getMaximumDeadline

Methods inherited from class java.lang.Object

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

Field Details

OAUTH_CONSUMER_KEY_PROPERTY

public static final String OAUTH_CONSUMER_KEY_PROPERTY

See Also:

• Constant Field Values

OAUTH_EMAIL_PROPERTY

public static final String OAUTH_EMAIL_PROPERTY

See Also:

• Constant Field Values

OAUTH_USER_ID_PROPERTY

public static final String OAUTH_USER_ID_PROPERTY

See Also:

• Constant Field Values

OAUTH_AUTH_DOMAIN_PROPERTY

public static final String OAUTH_AUTH_DOMAIN_PROPERTY

See Also:

• Constant Field Values

OAUTH_IS_ADMIN_PROPERTY

public static final String OAUTH_IS_ADMIN_PROPERTY

See Also:

• Constant Field Values

PACKAGE

public static final String PACKAGE

The package name for this service.

See Also:

• Constant Field Values

Constructor Details

LocalUserService

public LocalUserService()

Method Details

createLoginURL

public UserServicePb.CreateLoginURLResponse createLoginURL(LocalRpcService.Status status,
 UserServicePb.CreateLoginURLRequest request)

createLogoutURL

public UserServicePb.CreateLogoutURLResponse createLogoutURL(LocalRpcService.Status status,
 UserServicePb.CreateLogoutURLRequest request)

getOAuthUser

public UserServicePb.GetOAuthUserResponse getOAuthUser(LocalRpcService.Status status,
 UserServicePb.GetOAuthUserRequest request)

getPackage

public String getPackage()

Description copied from interface: LocalRpcService

Returns the package for the service, for example, "datastore_v3".

Returns:

a not null package name.

init

public void init(LocalServiceContext context,
 Map<String,String> properties)

Description copied from interface: LocalRpcService

Initializes the service with a set of configuration properties. Must be called before a service is started.

Specified by:

init in interface LocalRpcService

Overrides:

init in class AbstractLocalRpcService

Parameters:

context - A context object for the application

properties - A read-only Map of properties.

start

public void start()

Description copied from interface: LocalRpcService

Puts a new service into "serving" mode. Aside from setting properties, the service is not functional until after having been started.

Specified by:

start in interface LocalRpcService

Overrides:

start in class AbstractLocalRpcService

stop

public void stop()

Description copied from interface: LocalRpcService

Stops the service, releasing all of its resources.

Specified by:

stop in interface LocalRpcService

Overrides:

stop in class AbstractLocalRpcService