com.google.appengine.api.users.UserService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of appengine-api-1.0-sdk
API for Google App Engine standard environment with some of the dependencies shaded (repackaged)
There is a newer version: 2.0.27
/*
 * 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.
 */

package com.google.appengine.api.users;

import java.util.Set;
import org.checkerframework.checker.nullness.qual.Nullable;

/**
 * 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.
 *
 */
public interface UserService {
  /**
   * Returns a URL that can be used to display a login page to the user.
   *
   * @param destinationURL where the user will be redirected after
   *                       they log in.
   * @return The URL that will present a login prompt.
   *
   * @throws IllegalArgumentException If the destinationURL is not valid.
   */
  public String createLoginURL(String destinationURL);

  /**
   * Returns a URL that can be used to display a login page to the user.
   *
   * @param destinationURL where the user will be redirected after they log in.
   * @param authDomain not used.
   * @return The URL that will present a login prompt.
   * @throws IllegalArgumentException If the destinationURL is not valid.
   */
  // TODO: As with User.authDomain, it would be "friendlier" to
  // somehow obscure this method from the general documentation.
  public String createLoginURL(String destinationURL, @Nullable String authDomain);

  /**
   * Returns a URL that can be used to redirect the user to a third party for federated login.
   *
   * @param destinationURL where the user will be redirected after they log in.
   * @param authDomain not used.
   * @param federatedIdentity Setting this parameter to a non-null value will throw an
   *     IllegalArgumentException. OpenID 2.0 support has been decommissioned. Please see
   *     https://cloud.google.com/appengine/docs/deprecations/open_id for details.
   * @param attributesRequest not used.
   * @return The URL that will present a login prompt.
   * @throws IllegalArgumentException If the destinationURL is not valid or if federatedIdentity is
   *     not null
   * @deprecated Use of federatedIdentity is no longer supported. Please change calls to a method
   *     that does not take the parameter.
   */
  @Deprecated
  public String createLoginURL(
      String destinationURL,
      String authDomain,
      String federatedIdentity,
      Set attributesRequest);

  /**
   * Returns a URL that can be used to log the current user out of this app.
   *
   * @param destinationURL where the user will be redirected after
   *                       they log out.
   * @return The URL that will log the user out.
   *
   * @throws IllegalArgumentException If the destinationURL is not valid.
   */
  public String createLogoutURL(String destinationURL);

  /**
   * Returns a URL that can be used to log the current user out of this app.
   *
   * @param destinationURL where the user will be redirected after they log out.
   * @param authDomain not used.
   * @return The URL that will log the user out.
   * @throws IllegalArgumentException If the destinationURL is not valid.
   */
  // TODO: As with User.authDomain, it would be "friendlier" to
  // somehow obscure this method from the general documentation.
  public String createLogoutURL(String destinationURL, @Nullable String authDomain);

  /**
   * Returns true if there is a user logged in, false otherwise.
   */
  public boolean isUserLoggedIn();

  /**
   * Returns true if the user making this request is an admin for this
   * application, false otherwise.
   *
   * @throws IllegalStateException If the current user is not logged in.
   */
  public boolean isUserAdmin();

  /**
   * If the user is logged in, this method will return a {@code User} that
   * contains information about them.
   *
   * Note that repeated calls may not necessarily return the same
   * {@code User} object.
   *
   * @return User if the user is logged in, null otherwise.
   */
  public @Nullable User getCurrentUser();
}