org.fabric3.spi.security.AuthenticationService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fabric3-spi Show documentation

Fabric3

There is a newer version: 3.1.0

/*
 * Fabric3
 * Copyright (c) 2009-2015 Metaform Systems
 *
 * 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.fabric3.spi.security;

import org.fabric3.api.SecuritySubject;

/**
 * Implemented by security providers that perform authentication.
 */
public interface AuthenticationService {

    /**
     * Authenticates a user.
     *
     * @param token the authentication token
     * @return the authenticated subject
     * @throws AuthenticationException if the authentication attempt was unsuccessful. The exception will wrap an underlying cause typically thrown by
     *                                 the security provider.
     */
    SecuritySubject authenticate(AuthenticationToken token) throws AuthenticationException;
}