001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.servicemix.jbi.security.auth;
018    
019    import java.security.GeneralSecurityException;
020    
021    import javax.security.auth.Subject;
022    
023    /**
024     * Interface for the authentication service.
025     * 
026     */
027    public interface AuthenticationService {
028    
029        /**
030         * Authenticate a user given its name and credentials.
031         * Upon sucessfull completion, the subject should be populated
032         * with the user known principals.
033         * 
034         * @param subject the subject to populate
035         * @param domain the security domain to use
036         * @param user the user name
037         * @param credentials the user credntials
038         * @throws GeneralSecurityException if the user can not be authenticated
039         */
040        void authenticate(Subject subject, String domain, String user, Object credentials) throws GeneralSecurityException;
041        
042    }