com.google.appengine.api.users.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of runtime-impl-jetty12 Show documentation

There is a newer version: 2.0.31

/*
 * Copyright 2021 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * 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:
 *
 * 
{@code
 * <%
 *   UserService userService = UserServiceFactory.getUserService();
 *   if (!userService.isUserLoggedIn()) {
 * %>
 *    Please {@code ">log in>}
 * <% } else { %>
 *    Welcome, <%= userService.getCurrentUser().getNickname(); %>!
 *      {@code (">log out>)}
 * <%
 *   }
 * %>
 * }
 *
 * @see com.google.appengine.api.users.UserService
 * @see The Users Java API in the
 *     Google App Engine Developer's Guide.
 */
package com.google.appengine.api.users;