Session.java

package com.paypal.sdk.openidconnect;

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import com.paypal.core.ClientCredentials;
import com.paypal.core.ConfigManager;
import com.paypal.core.Constants;
import com.paypal.core.SDKUtil;
import com.paypal.core.rest.APIContext;

public final class Session {

	private Session() {
	}

	/**
	 * Returns the PayPal URL to which the user must be redirected to start the
	 * authentication / authorization process.
	 * 
	 * @param redirectURI
	 *            Uri on merchant website to where the user must be redirected
	 *            to post paypal login
	 * 
	 * @param scope
	 *            The access privilges that you are requesting for from the
	 *            user. Pass empty array for all scopes. See
	 *            https://developer.paypal
	 *            .com/webapps/developer/docs/classic/loginwithpaypal
	 *            /ht_OpenIDConnect/#parameters for more information
	 * 
	 * @param apiContext
	 *            {@link APIContext} to be used for the call.
	 * @return Redirect URL
	 */
	public static String getRedirectURL(String redirectURI, List<String> scope,
			APIContext apiContext) {
		return getRedirectURL(redirectURI, scope, apiContext, null);
	}

	public static String getRedirectURL(String redirectURI, List<String> scope,
			APIContext apiContext, ClientCredentials clientCredentials) {
		String redirectURL = null;
		Map<String, String> configurationMap;
		try {
			if (apiContext.getConfigurationMap() == null) {
				configurationMap = SDKUtil.combineDefaultMap(ConfigManager
						.getInstance().getConfigurationMap());
			} else {
				configurationMap = SDKUtil.combineDefaultMap(apiContext
						.getConfigurationMap());
			}
			String baseURL = configurationMap
					.get(Constants.OPENID_REDIRECT_URI);
			if (baseURL == null || baseURL.trim().length() <= 0) {
				if (configurationMap.get(Constants.MODE) == null
						|| (!Constants.LIVE.equalsIgnoreCase(configurationMap
								.get(Constants.MODE)) && !Constants.SANDBOX
								.equalsIgnoreCase(configurationMap
										.get(Constants.MODE)))) {
					throw new RuntimeException(
							"Mode parameter not set in dynamic configuration map");
				} else {
					if (Constants.LIVE.equalsIgnoreCase(configurationMap
							.get(Constants.MODE))) {
						baseURL = Constants.OPENID_REDIRECT_URI_CONSTANT_LIVE;
					} else if (Constants.SANDBOX
							.equalsIgnoreCase(configurationMap
									.get(Constants.MODE))) {
						baseURL = Constants.OPENID_REDIRECT_URI_CONSTANT_SANDBOX;
					}
				}
			}
			if (scope == null || scope.size() <= 0) {
				scope = new ArrayList<String>();
				scope.add("openid");
				scope.add("profile");
				scope.add("address");
				scope.add("email");
				scope.add("phone");
				scope.add("https://uri.paypal.com/services/paypalattributes");
				scope.add("https://uri.paypal.com/services/expresscheckout");
			}
			if (!scope.contains("openid")) {
				scope.add("openid");
			}
			StringBuilder stringBuilder = new StringBuilder();

			// TODO revisit method while removing the similar method without
			// ClientCredentials; ClientID and ClientSecret should not be included
			// in configuration map - add them to the ClientCredentials class
			String clientID;
			if (clientCredentials == null) {
				clientID = configurationMap.get(Constants.CLIENT_ID) != null ? configurationMap
						.get(Constants.CLIENT_ID) : "";
			} else {
				clientID = clientCredentials.getClientID() != null ? clientCredentials
						.getClientID() : "";
			}
			stringBuilder
					.append("client_id=")
					.append(URLEncoder.encode(clientID,
							Constants.ENCODING_FORMAT))
					.append("&response_type=").append("code").append("&scope=");
			StringBuilder scpBuilder = new StringBuilder();
			for (String str : scope) {
				scpBuilder.append(str).append(" ");

			}
			stringBuilder.append(URLEncoder.encode(scpBuilder.toString(),
					Constants.ENCODING_FORMAT));
			stringBuilder.append("&redirect_uri=").append(
					URLEncoder.encode(redirectURI, Constants.ENCODING_FORMAT));
			redirectURL = baseURL + "/signin/authorize?" + stringBuilder.toString();
		} catch (UnsupportedEncodingException exe) {
			// Ignore
		}
		return redirectURL;
	}

	/**
	 * Returns the URL to which the user must be redirected to logout from the
	 * OpenID provider (i.e. PayPal)
	 * 
	 * @param redirectURI
	 *            URI on merchant website to where the user must be redirected
	 *            to post logout
	 * @param idToken
	 *            id_token from the TokenInfo object
	 * @param apiContext
	 *            {@link APIContext} to be used for the call.
	 * @return Logout URL
	 */
	public static String getLogoutUrl(String redirectURI, String idToken,
			APIContext apiContext) {
		String logoutURL = null;
		Map<String, String> configurationMap;
		try {
			if (apiContext.getConfigurationMap() == null) {
				configurationMap = SDKUtil.combineDefaultMap(ConfigManager
						.getInstance().getConfigurationMap());
			} else {
				configurationMap = SDKUtil.combineDefaultMap(apiContext
						.getConfigurationMap());
			}
			String baseURL = configurationMap
					.get(Constants.OPENID_REDIRECT_URI);
			if (baseURL == null || baseURL.trim().length() <= 0) {
				if (configurationMap.get(Constants.MODE) == null
						|| (!Constants.LIVE.equalsIgnoreCase(configurationMap
								.get(Constants.MODE)) && !Constants.SANDBOX
								.equalsIgnoreCase(configurationMap
										.get(Constants.MODE)))) {
					throw new RuntimeException(
							"Mode parameter not set in dynamic configuration map");
				} else {
					if (Constants.LIVE.equalsIgnoreCase(configurationMap
							.get(Constants.MODE))) {
						baseURL = Constants.OPENID_REDIRECT_URI_CONSTANT_LIVE;
					} else if (Constants.SANDBOX
							.equalsIgnoreCase(configurationMap
									.get(Constants.MODE))) {
						baseURL = Constants.OPENID_REDIRECT_URI_CONSTANT_SANDBOX;
					}
				}
			}
			StringBuilder stringBuilder = new StringBuilder();
			stringBuilder
					.append("id_token=")
					.append(URLEncoder.encode(idToken,
							Constants.ENCODING_FORMAT))
					.append("&redirect_uri=")
					.append(URLEncoder.encode(redirectURI,
							Constants.ENCODING_FORMAT)).append("&logout=true");
			logoutURL = baseURL + "/webapps/auth/protocol/openidconnect/v1/endsession?" + stringBuilder.toString();
		} catch (UnsupportedEncodingException exe) {
			// Ignore
		}
		return logoutURL;
	}

}