PaymentTask.java

/*
 jBilling - The Enterprise Open Source Billing System
 Copyright (C) 2003-2011 Enterprise jBilling Software Ltd. and Emiliano Conde

 This file is part of jbilling.

 jbilling is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 jbilling 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with jbilling.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.sapienter.jbilling.server.pluggableTask;

import com.sapienter.jbilling.server.payment.PaymentDTOEx;
import com.sapienter.jbilling.server.payment.db.PaymentAuthorizationDTO;
import com.sapienter.jbilling.server.pluggableTask.admin.PluggableTaskException;

/*
 * Consider a base class to facilitante notifiaction, suspension, and other 
 * actions for overdue users
 */
public interface PaymentTask {
    
    
    /**
     * Creation of a payment
     * @param paymentInfo This can be an extension of PaymentDTO, with the
     * additional information for this implementation. For example, a task
     * fro credit card processing would expect an extension of PaymentDTO with
     * the credit card information.
     * @return If the next pluggable task has to be called or not. True would 
     * be returned usually when the gatway is not available.
     */
    boolean process(PaymentDTOEx paymentInfo) throws PluggableTaskException;
    
    void failure(Integer userId, Integer retry);

    /**
     * Does the authorization, but not capture, of a payment. This means that
     * the amount is approved, but if this charge is not confirmed within X
     * number of days, the charge will be dropped and the credit card not charged.
     * The way to confirm the charge is by calling ConfirmPreAuth
     * @param paymentInfo 
     *   This object needs to have
     *   - currency
     *   - amount
     *   - credit card
     *   - the id of the existing payment row
     * @return If the next pluggable task has to be called or not. True would 
     * be returned usually when the gatway is not available.
     * @throws PluggableTaskException
     */
    boolean preAuth(PaymentDTOEx paymentInfo) 
            throws PluggableTaskException;
    
    /**
     * This will confirm a previously authorized charge, so it is 'captured'.
     * If this method is not called in a pre-auth, the charge will be dropped.
     * By calling this method, the end customer will see the charge in her 
     * credit card.
     * @param auth
     * @param amount
     * @param currencyId
     * @return If the next pluggable task has to be called or not. True would 
     * be returned usually when the gatway is not available.
     * @throws PluggableTaskException
     */
    boolean confirmPreAuth(PaymentAuthorizationDTO auth, 
            PaymentDTOEx paymentInfo) 
            throws PluggableTaskException;
    
}