HTTPAuthenticator.java

/*
 * Copyright 2015 floragunn UG (haftungsbeschränkt)
 * 
 * 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.floragunn.searchguard.auth;

import org.elasticsearch.ElasticsearchSecurityException;
import org.elasticsearch.rest.RestChannel;
import org.elasticsearch.rest.RestRequest;

import com.floragunn.searchguard.user.AuthCredentials;

public interface HTTPAuthenticator {

    String getType();

    /**
     * 
     * @param request
     * @param channel
     * @param authenticationBackend
     * @param authorizationBackend
     * @return The authenticated user, null means another roundtrip
     * @throws ElasticsearchSecurityException
     */
    AuthCredentials extractCredentials(RestRequest request) throws ElasticsearchSecurityException;
    
    boolean reRequestAuthentication(final RestChannel channel, AuthCredentials credentials);
}