Package com.google.appengine.api.users (2.0.0)

Provides facilities to check if a user has authenticated, retrieve their email address, and check if they are an administrator for this application. It can also be used to construct a URL for users to login or logout.

As an example, your application might, in a JSP file, have code like this:


 <%
   UserService userService = UserServiceFactory.getUserService();
   if (!userService.isUserLoggedIn()) {
 %>
    Please {@code ">log in>}
 <% } else { %>
    Welcome, <%= userService.getCurrentUser().getNickname(); %>!
      {@code (">log out>)}
 <%
   }
 %>>

See Also: com.google.appengine.api.users.UserService, The Users Java API in the Google App Engine Developer's Guide.

Classes

IUserServiceFactoryProvider

Creates IUserServiceFactory implementations.

Note: This class is not intended for end users.

User

User represents a specific user, represented by the combination of an email address and a specific Google Apps domain (which we call an authDomain). For normal Google login, authDomain will be set to "gmail.com".

UserServiceFactory

Creates a UserService.

Interfaces

IUserServiceFactory

This interface should be implemented by providers of the UserService and registered with com.google.appengine.spi.ServiceFactoryFactory.

UserService

The UserService provides information useful for forcing a user to log in or out, and retrieving information about the user who is currently logged-in.

Exceptions

UserServiceFailureException

UserServiceFailureException is thrown when any unknown error occurs while communicating with the user service.