UserAuthenticator.java

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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.cloud.server.auth;

import java.util.Map;

import com.cloud.utils.Pair;
import com.cloud.utils.component.Adapter;

/**
 * which UserAuthenticator to user in components.xml.
 *
 */
public interface UserAuthenticator extends Adapter {
    public enum ActionOnFailedAuthentication {
        INCREMENT_INCORRECT_LOGIN_ATTEMPT_COUNT;
    }

    /**
     *
     * @param username
     * @param password
     * @param domainId
     * @return the pair of 2 booleans - first identifies the success of authenciation, the second - whether to increase incorrect login attempts count in case of failed authentication
     */
    public Pair<Boolean, ActionOnFailedAuthentication> authenticate(String username, String password, Long domainId, Map<String, Object[]> requestParameters);

    /**
     * @param password
     * @return the encoded password
     */
    public String encode(String password);
}