/*
 * Copyright 2015 Red Hat, Inc.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *  The Eclipse Public License is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  The Apache License v2.0 is available at
 *  http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.ext.auth.oauth2.impl.flow;

import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.json.JsonObject;
import io.vertx.ext.auth.oauth2.AccessToken;
import io.vertx.ext.auth.oauth2.impl.OAuth2AuthProviderImpl;
import io.vertx.ext.auth.oauth2.impl.OAuth2TokenImpl;

import static io.vertx.ext.auth.oauth2.impl.OAuth2API.*;

Author:Paulo Lopes
/** * @author Paulo Lopes */
public class AuthCodeImpl extends AbstractOAuth2Flow implements OAuth2Flow { private final OAuth2AuthProviderImpl provider; public AuthCodeImpl(OAuth2AuthProviderImpl provider) { super(provider.getVertx(), provider.getConfig()); this.provider = provider; // validation throwIfNull("clientId", config.getClientID()); }
Construct the URL to be used to redirect the user to the authorization page of the OAuth "Authorization Server"
Params:
  • params – - redirectURI: A String that represents the registered application URI where the user is redirected after authorization. scope: A String that represents the application privileges. Set to "openid" for OpenID Connect. scopes: A array of strings that will encoded as a single string "scope" following the provider requirements state: A String that represents an optional opaque value used by the client to maintain state between the request and the callback.
/** * Construct the URL to be used to redirect the user to the authorization page of the OAuth "Authorization Server" * * @param params - redirectURI: A String that represents the registered application URI where the user is redirected after authorization. * scope: A String that represents the application privileges. Set to "openid" for OpenID Connect. * scopes: A array of strings that will encoded as a single string "scope" following the provider requirements * state: A String that represents an optional opaque value used by the client to maintain state between the request and the callback. */
@Override public String authorizeURL(JsonObject params) { final JsonObject query = params.copy(); if (query.containsKey("scopes")) { // scopes have been passed as a list so the provider must generate the correct string for it query.put("scope", String.join(config.getScopeSeparator(), query.getJsonArray("scopes").getList())); query.remove("scopes"); } query.put("response_type", "code"); query.put("client_id", config.getClientID()); final String path = config.getAuthorizationPath(); final String url = path.charAt(0) == '/' ? config.getSite() + path : path; return url + '?' + stringify(query); }
Returns the Access Token object.
Params:
  • params – - code: Authorization code (from previous step). redirectURI: A String that represents the callback uri.
  • handler – - The handler returning the results.
/** * Returns the Access Token object. * * @param params - code: Authorization code (from previous step). * redirectURI: A String that represents the callback uri. * @param handler - The handler returning the results. */
@Override public void getToken(JsonObject params, Handler<AsyncResult<AccessToken>> handler) { getToken("authorization_code", params, res -> { if (res.failed()) { handler.handle(Future.failedFuture(res.cause())); return; } AccessToken token; try { token = new OAuth2TokenImpl(provider, res.result()); } catch (RuntimeException e) { handler.handle(Future.failedFuture(e)); return; } handler.handle(Future.succeededFuture(token)); }); } }