/*
 * Copyright 2009 Inspire-Software.com
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package org.yes.cart.service.payment;

import org.yes.cart.payment.persistence.entity.PaymentGatewayCallback;
import org.yes.cart.service.order.OrderException;

import javax.servlet.ServletRequest;
import java.util.Map;

/**
 *
 * Responsible to handle call back call from payment gateway with external form processing.
 *
 * User: Igor Azarny iazarny@yahoo.com
 * Date: 09-May-2011
 * Time: 14:12:54
 */
public interface PaymentCallBackHandlerFacade {

    /**
     * Register callback for given payment gateway.
     *
     * @param parameters          callback parameters (usually {@link ServletRequest#getParameterMap()})
     * @param paymentGatewayLabel label for this payment gateway
     * @param shopCode            shop code
     * @param requestDump         string representation of all information in this callback
     *
     * @return callback object
     */
    PaymentGatewayCallback registerCallback(Map parameters,
                                            String paymentGatewayLabel,
                                            String shopCode,
                                            String requestDump);

    /**
     * Handle call back from payment gateway
     *
     * @param callback                  callback object to handle
     * @param forceProcessing           force processing of parameters (will create callback even when parameters
     *                                  are not validated)
     */
    void handlePaymentCallback(PaymentGatewayCallback callback, boolean forceProcessing) throws OrderException;

}
