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-2016 ForgeRock AS.
015 */
016
017package org.forgerock.http.oauth2;
018
019import org.forgerock.services.context.Context;
020import org.forgerock.util.promise.Promise;
021
022/** Resolves a given token against a dedicated OAuth2 Identity Provider (OpenAM, Google, Facebook, ...). */
023public interface AccessTokenResolver {
024
025    /**
026     * Resolves a given access token against an authorization server.
027     *
028     * @param context Context chain used to keep a relationship between requests (tracking)
029     * @param token token identifier to be resolved
030     * @return a promise completed either with a valid {@link AccessTokenInfo} (well-formed, known by the server),
031     * or by an exception
032     */
033    Promise<AccessTokenInfo, AccessTokenException> resolve(Context context, String token);
034}