com.paypal.api.payments.FuturePayment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-api-sdk Show documentation
PayPal SDK for integrating with the REST APIs
There is a newer version: 1.14.0
// Generated by delombok at Tue Jan 31 13:36:37 CST 2017
package com.paypal.api.payments;

import com.paypal.api.openidconnect.CreateFromAuthorizationCodeParameters;
import com.paypal.api.openidconnect.CreateFromRefreshTokenParameters;
import com.paypal.api.openidconnect.Tokeninfo;
import com.paypal.base.Constants;
import com.paypal.base.rest.APIContext;
import com.paypal.base.rest.PayPalRESTException;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

public class FuturePayment extends Payment {
	/**
	 * Creates a future payment using either authorization code or refresh token
	 * with correlation ID. 

	 * https://developer.paypal.com/webapps/developer/docs/integration/mobile/
	 * make-future-payment/
	 *
	 * @param accessToken
	 * an access token
	 * @param correlationId
	 * paypal application correlation ID
	 * @return a Payment object
	 * @throws PayPalRESTException
	 * @throws IOException
	 * thrown when config file cannot be read properly
	 * @throws FileNotFoundException
	 * thrown when config file does not exist
	 */
	public Payment create(String accessToken, String correlationId) throws PayPalRESTException, FileNotFoundException, IOException {
		if (correlationId == null || correlationId.equals("")) {
			throw new IllegalArgumentException("correlation ID cannot be null or empty");
		}
		APIContext apiContext = new APIContext(accessToken);
		apiContext.addHTTPHeader("PAYPAL-CLIENT-METADATA-ID", correlationId);
		return this.create(apiContext);
	}

	/**
	 * Creates a future payment using either authorization code or refresh token
	 * with correlation ID. 

	 * https://developer.paypal.com/webapps/developer/docs/integration/mobile/
	 * make-future-payment/
	 *
	 * @param apiContext {@link APIContext}
	 * @param correlationId
	 * paypal application correlation ID
	 * @return a Payment object
	 * @throws PayPalRESTException
	 * @throws IOException
	 * thrown when config file cannot be read properly
	 * @throws FileNotFoundException
	 * thrown when config file does not exist
	 */
	public Payment create(APIContext apiContext, String correlationId) throws PayPalRESTException, FileNotFoundException, IOException {
		if (correlationId == null || correlationId.equals("")) {
			throw new IllegalArgumentException("correlation ID cannot be null or empty");
		}
		apiContext.addHTTPHeader("PAYPAL-CLIENT-METADATA-ID", correlationId);
		return this.create(apiContext);
	}

	/**
	 * @deprecated Please use {@link #fetchRefreshToken(APIContext, String)} instead.
	 * In this method, we need to pass clientID, secret information that is already known to apiContext. The newer method allows for better
	 * code readability, and make it less error prone.
	 *
	 * @param params Authorization code params
	 * @return {@link Tokeninfo}
	 * @throws PayPalRESTException
	 */
	public Tokeninfo getTokeninfo(CreateFromAuthorizationCodeParameters params) throws PayPalRESTException {
		Map configurationMap = new HashMap();
		configurationMap.put(Constants.CLIENT_ID, params.getClientID());
		configurationMap.put(Constants.CLIENT_SECRET, params.getClientSecret());
		configurationMap.put("response_type", "token");
		APIContext apiContext = new APIContext();
		apiContext.setConfigurationMap(configurationMap);
		params.setRedirectURI("urn:ietf:wg:oauth:2.0:oob");
		Tokeninfo info = Tokeninfo.createFromAuthorizationCodeForFpp(apiContext, params);
		return info;
	}

	/**
	 * @deprecated Please use {@link #fetchRefreshToken(APIContext, String)} instead.
	 * In this method, we need to pass clientID, secret information that is already known to apiContext. The newer method allows for better
	 * code readability, and make it less error prone.
	 *
	 * @param params parameters
	 * @return {@link Tokeninfo}
	 * @throws PayPalRESTException
	 */
	public Tokeninfo getTokeninfo(CreateFromRefreshTokenParameters params, Tokeninfo info) throws PayPalRESTException {
		Map configurationMap = new HashMap();
		APIContext apiContext = new APIContext();
		apiContext.setConfigurationMap(configurationMap);
		info = info.createFromRefreshToken(apiContext, params);
		return info;
	}

	/**
	 * Fetches long lived refresh token from authorization code, for future payment use. 
	 *
	 * @param context {@link APIContext}
	 * @param authorizationCode code returned from mobile
	 * @return String of refresh token
	 * @throws PayPalRESTException
	 */
	public static String fetchRefreshToken(APIContext context, String authorizationCode) throws PayPalRESTException {
		CreateFromAuthorizationCodeParameters params = new CreateFromAuthorizationCodeParameters();
		params.setClientID(context.getClientID());
		params.setClientSecret(context.getClientSecret());
		params.setCode(authorizationCode);
		Tokeninfo info = Tokeninfo.createFromAuthorizationCodeForFpp(context, params);
		return info.getRefreshToken();
	}

	@java.lang.Override
	@java.lang.SuppressWarnings("all")
	public boolean equals(final java.lang.Object o) {
		if (o == this) return true;
		if (!(o instanceof FuturePayment)) return false;
		final FuturePayment other = (FuturePayment) o;
		if (!other.canEqual((java.lang.Object) this)) return false;
		if (!super.equals(o)) return false;
		return true;
	}

	@java.lang.SuppressWarnings("all")
	protected boolean canEqual(final java.lang.Object other) {
		return other instanceof FuturePayment;
	}

	@java.lang.Override
	@java.lang.SuppressWarnings("all")
	public int hashCode() {
		final int PRIME = 59;
		int result = 1;
		result = result * PRIME + super.hashCode();
		return result;
	}
}