/*
 * 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 org.apache.catalina;

import java.io.IOException;

import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletResponse;

import org.apache.catalina.connector.Request;


/**
 * An <b>Authenticator</b> is a component (usually a Valve or Container) that provides some sort of authentication
 * service.
 */
public interface Authenticator {

    /**
     * Authenticate the user making this request, based on the login configuration of the {@link Context} with which
     * this Authenticator is associated.
     *
     * @param request  Request we are processing
     * @param response Response we are populating
     *
     * @return <code>true</code> if any specified constraints have been satisfied, or <code>false</code> if one or more
     *             constraints were not satisfied (in which case an authentication challenge will have been written to
     *             the response).
     *
     * @exception IOException if an input/output error occurs
     */
    boolean authenticate(Request request, HttpServletResponse response) throws IOException;

    /**
     * Logs in the specified user for the given request.
     *
     * @param userName the user name
     * @param password the password
     * @param request the request being processed
     *
     * @throws ServletException if a login error occurs
     */
    void login(String userName, String password, Request request) throws ServletException;

    /**
     * Logs out the user associated with the given request.
     *
     * @param request the request being processed
     */
    void logout(Request request);
}
