001/*
002 * Copyright 2020 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.GbifUser;
019
020import javax.annotation.Nullable;
021
022/**
023 * Identity service accessing a single user, in read-only.
024 * This is a replacement of the deprecated {@link UserService}.
025 */
026public interface IdentityAccessService {
027
028  /**
029   * Get a {@link GbifUser} by identifier (username or email).
030   *
031   * @param identifier username or email
032   *
033   * @return the user or null if the user is not found
034   */
035  @Nullable
036  GbifUser get(String identifier);
037
038  /**
039   * Authenticates a user.
040   *
041   * @param identifier username or email
042   * @param password clear text password
043   *
044   * @return the authenticated user or null if not found or wrong credentials provided
045   */
046  @Nullable
047  GbifUser authenticate(String identifier, String password);
048
049}