| /* |
| * 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.sling.engine.auth; |
| |
| import java.io.IOException; |
| |
| import javax.servlet.http.HttpServletRequest; |
| import javax.servlet.http.HttpServletResponse; |
| |
| /** |
| * The <code>AuthenticationHandler</code> interface defines the service API used |
| * by the authentication implementation to support plugin various ways of |
| * extracting credentials from the request. |
| * |
| * @deprecated use |
| * {@link org.apache.sling.auth.core.spi.AuthenticationHandler} |
| * instead |
| */ |
| @Deprecated |
| public interface AuthenticationHandler { |
| |
| /** |
| * An authentication handler is associated with url paths. If the handler is |
| * not configured with a path, it is regarded as inactive. If the handler |
| * should be used for all requests, the path should be '/'. |
| */ |
| String PATH_PROPERTY = "path"; |
| |
| /** |
| * Extracts credential data from the request if at all contained. |
| * <p> |
| * The method returns any of the following values : |
| * <table summary=""> |
| * <tr> |
| * <th>value |
| * <th>description |
| * </tr> |
| * <tr> |
| * <td><code>null</code> |
| * <td>no user details were contained in the request or the handler is not |
| * capable or willing to extract credentials from the request |
| * </tr> |
| * <tr> |
| * <td>{@link AuthenticationInfo#DOING_AUTH} |
| * <td>the handler is in an ongoing authentication transaction with the |
| * client. Request processing should be aborted at this stage. |
| * <tr> |
| * <tr> |
| * <td><code>AuthenticationInfo</code> object |
| * <td>The user sent credentials. The returned object contains the |
| * credentials as well as the type of authentication transmission employed. |
| * </tr> |
| * </table> |
| * <p> |
| * The method must not request credential information from the client, if |
| * they are not found in the request. |
| * <p> |
| * The value of {@link #PATH_PROPERTY} service registration property value |
| * triggering this call is available as the <code>path</code> request |
| * attribute. If the service is registered with multiple path values, the |
| * value of the <code>path</code> request attribute may be used to implement |
| * specific handling. |
| * |
| * @param request The request object containing the information for the |
| * authentication. |
| * @param response The response object which may be used to send the |
| * information on the request failure to the user. |
| * @return A valid <code>AuthenticationInfo</code> instance identifying the |
| * request user, {@link AuthenticationInfo#DOING_AUTH} if the |
| * handler is in an authentication transaction with the client or |
| * null if the request does not contain authentication information. |
| * In case of {@link AuthenticationInfo#DOING_AUTH}, the method must |
| * have sent a response indicating that fact to the client. |
| */ |
| AuthenticationInfo authenticate(HttpServletRequest request, |
| HttpServletResponse response); |
| |
| /** |
| * Requests authentication information from the client. Returns |
| * <code>true</code> if the information has been requested and request |
| * processing can be terminated normally. Otherwise the authorization |
| * information could not be requested. |
| * <p> |
| * Any response sent by the handler though the <code>sendError</code> method |
| * is also handled by the error handler infrastructure. |
| * <p> |
| * The value of {@link #PATH_PROPERTY} service registration property value |
| * triggering this call is available as the <code>path</code> request |
| * attribute. If the service is registered with multiple path values, the |
| * value of the <code>path</code> request attribute may be used to implement |
| * specific handling. |
| * |
| * @param request The request object. |
| * @param response The response object to which to send the request. |
| * @return <code>true</code> if the handler is able to end an authentication |
| * inquiry for the given request. <code>false</code> otherwise. |
| * @throws IOException If an error occurrs sending the authentication |
| * inquiry to the client. |
| */ |
| boolean requestAuthentication(HttpServletRequest request, |
| HttpServletResponse response) throws IOException; |
| } |