// Copyright (C) 2012 The Android Open Source Project
//
// 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
//
// http://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.gerrit.server.auth;

import com.google.common.base.Objects;
import com.google.gerrit.common.Nullable;

/**
 * Defines an abstract request for user authentication to Gerrit.
 */
public abstract class AuthRequest {
  private final String username;
  private final String password;

  protected AuthRequest(String username, String password) {
    this.username = username;
    this.password = password;
  }

  /**
   * Returns the username to be authenticated.
   *
   * @return username for authentication or null for anonymous access.
   */
  @Nullable
  public final String getUsername() {
    return username;
  }

  /**
   * Returns the user's credentials
   *
   * @return user's credentials or null
   */
  @Nullable
  public final String getPassword() {
    return password;
  }

  public void checkPassword(String pwd) throws AuthException {
    if (!Objects.equal(getPassword(), pwd)) {
      throw new InvalidCredentialsException();
    }
  }
}