001/*
002 * Copyright 2014 Global Biodiversity Information Facility (GBIF)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.gbif.api.service.common;
017
018import org.gbif.api.model.common.User;
019
020import javax.annotation.Nullable;
021
022/**
023 * This read only service used to connect to a Drupal DB is deprecated in favour of the IdentityAccessService.
024 */
025@Deprecated
026public interface UserService {
027
028  /**
029   * Authenticates a user.
030   *
031   * @param password clear text password
032   *
033   * @return the authenticated user or null if not found or wrong credentials provided
034   */
035  @Nullable
036  User authenticate(String username, String password);
037
038  /**
039   * Retrieves a user by its case insensitive username.
040   */
041  @Nullable
042  User get(String username);
043
044  /**
045   * Retrieves a user by a currently open Drupal (login) session.
046   * The session name is stored by Drupal clientside in a cookie.
047   * @param session the drupal session name as found in the drupal cookie
048   * @return the user of an existing session or NULL if not found
049   */
050  @Nullable
051  User getBySession(String session);
052
053}