AuthenticationDomain.java

/**
 * Licensed to the Austrian Association for Software Tool Integration (AASTI)
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. The AASTI 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.openengsb.domain.authentication;

import org.openengsb.core.api.Domain;
import org.openengsb.core.api.security.Credentials;
import org.openengsb.core.api.security.model.Authentication;

/**
 * provides a way of authenticating users with specific credentials
 */
public interface AuthenticationDomain extends Domain {

    /**
     * authenticates a user with the given credentials. if the authentication is successful an {@link Authentication}
     * containing the user is returned.
     *
     * @throws AuthenticationException if the authentication fails.
     */
    Authentication authenticate(String username, Credentials credentials) throws AuthenticationException;

    /**
     * checks whether the given credentials are supported by this connector
     */
    boolean supports(Credentials credentials);

}