DoAuthorization.java

/*
 * Copyright (C) 2010 Pete Reisinger <p.reisinger@gmail.com>.
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with this program. If
 * not, see <http://www.gnu.org/licenses/>.
 */

package paypalnvp.request;

import paypalnvp.fields.Currency;
import paypalnvp.util.Validator;

import java.util.HashMap;
import java.util.Map;

/**
 * Authorize a payment.
 *
 * @author Pete Reisinger
 *         <p.reisinger@gmail.com>
 */
@SuppressWarnings("serial")
public final class DoAuthorization implements Request {

    /**
     * Method value of this request
     */
    private static final String METHOD_NAME = "DoAuthorization";

    /**
     * map that holds name value pair request values
     */
    private final Map<String, String> nvpRequest;

    /**
     * map that holds name value pair response values
     */
    private Map<String, String> nvpResponse;

    /**
     * @param transactionId The value of the order's transaction identification number returned by
     *                      PayPal Character length and limits: 19 single-byte characters maximum.
     * @param amount        Amount to authorize. Limitations: Value is a positive number which cannot exceed
     *                      $10,000 USD in any currency. No currency symbol. Must have two decimal places, decimal
     *                      separator must be a period (.).
     * @throws IllegalArgumentException
     */
    public DoAuthorization(String transactionId, String amount) throws IllegalArgumentException {

    /* validation */
        if (transactionId == null || transactionId.length() > 19) {
            throw new IllegalArgumentException("Transaction id can be maximum " + "19 characters long.");
        }
        if (!Validator.isValidAmount(amount)) {
            throw new IllegalArgumentException("Amount is not valid");
        }

    /* instance variables */
        nvpResponse = new HashMap<String, String>();
        nvpRequest = new HashMap<String, String>();

        nvpRequest.put("METHOD", METHOD_NAME);
        nvpRequest.put("TRANSACTIONID", transactionId);
        nvpRequest.put("AMT", amount);
    }

    /**
     * Sets type of transaction to authorize to Order, which means that the transaction represents a
     * customer order that can be fulfilled over 29 days.
     */
    public void setOrder() {
        nvpRequest.put("TRANSACTIONENTITY", "Order");
    }

    /**
     * Sets currency.
     *
     * @param currency
     */
    public void setCurrency(Currency currency) {
        nvpRequest.put("CURRENCYCODE", currency.toString());
    }

    public Map<String, String> getNVPRequest() {
        return new HashMap<String, String>(nvpRequest);
    }

    public Map<String, String> getNVPResponse() {
        return new HashMap<String, String>(nvpResponse);
    }

    public void setNVPResponse(Map<String, String> nvpResponse) {
        this.nvpResponse = new HashMap<String, String>(nvpResponse);
    }

    @Override
    public String toString() {

        StringBuffer str = new StringBuffer("instance of AddressVerify");
        str.append("class with the vlues: nvpRequest - ");
        str.append(nvpRequest.toString());
        str.append("; nvpResponse - ");
        str.append(nvpResponse.toString());

        return str.toString();
    }
}