001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2014 ForgeRock AS.
015 */
016
017package org.forgerock.openig.filter.oauth2;
018
019/**
020 * Resolves a given token against a dedicated OAuth2 Identity Provider (OpenAM, Google, Facebook, ...).
021 */
022public interface AccessTokenResolver {
023
024    /**
025     * Resolves a given access token against a authorization server.
026     *
027     * @param token
028     *         token identifier to be resolved
029     * @return a valid {@link AccessToken} (well formed, known by the server)
030     * @throws OAuth2TokenException
031     *         if the token is unknown by the server
032     */
033    AccessToken resolve(String token) throws OAuth2TokenException;
034}