leap.oauth2.webapp.authc.OAuth2Authenticator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of leap-oauth2-webapp Show documentation

The newest version!

/*
 * Copyright 2017 the original author or authors.
 *
 * 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 leap.oauth2.webapp.authc;

import leap.oauth2.webapp.OAuth2Exception;
import leap.oauth2.webapp.token.Token;

public interface OAuth2Authenticator {

    /**
     * Authenticates the token and returns the result.
     *
     * 
     * Returns null if the token is invalid.
     *
     * @throws OAuth2Exception if error.
     */
    OAuth2Authentication authenticate(Token token) throws OAuth2Exception;

}