View Javadoc
1   /*
2    * The contents of this file are subject to the terms of the Common Development and
3    * Distribution License (the License). You may not use this file except in compliance with the
4    * License.
5    *
6    * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7    * specific language governing permission and limitations under the License.
8    *
9    * When distributing Covered Software, include this CDDL Header Notice in each file and include
10   * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11   * Header, with the fields enclosed by brackets [] replaced by your own identifying
12   * information: "Portions copyright [year] [name of copyright owner]".
13   *
14   * Copyright 2014-2016 ForgeRock AS.
15   */
16  
17  package org.forgerock.http.oauth2;
18  
19  import org.forgerock.services.context.Context;
20  import org.forgerock.util.promise.Promise;
21  
22  /** Resolves a given token against a dedicated OAuth2 Identity Provider (OpenAM, Google, Facebook, ...). */
23  public interface AccessTokenResolver {
24  
25      /**
26       * Resolves a given access token against an authorization server.
27       *
28       * @param context Context chain used to keep a relationship between requests (tracking)
29       * @param token token identifier to be resolved
30       * @return a promise completed either with a valid {@link AccessTokenInfo} (well-formed, known by the server),
31       * or by an exception
32       */
33      Promise<AccessTokenInfo, AccessTokenException> resolve(Context context, String token);
34  }