contrib/jcr-server/server/src/java/org/apache/jackrabbit/server/CredentialsProvider.java

/*
 * Copyright 2004-2005 The Apache Software Foundation or its licensors,
 *                     as applicable.
 *
 * 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 org.apache.jackrabbit.server;

import javax.jcr.Credentials;
import javax.jcr.LoginException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.ServletException;

/**
 * This Interface defines a provider for the credentials.
 */
public interface CredentialsProvider {

    /**
     * Extracts the credentials from the given servlet request.
     *
     * @param request
     * @return the credentials or null
     * @throws LoginException if the credentials are invalid
     * @throws ServletException if an error occurrs
     */
    public Credentials getCredentials(HttpServletRequest request)
            throws LoginException, ServletException;
}