com.commercetools.payment.service.PaymentAdapterService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common Show documentation
The commercetools java payment project intend is to make payment integration easy
The newest version!
package com.commercetools.payment.service;

import com.commercetools.payment.domain.PaymentServiceProvider;
import com.commercetools.payment.model.CreatePaymentData;
import com.commercetools.payment.model.CreatePaymentTransactionData;
import com.commercetools.payment.model.PaymentCreationResult;
import com.commercetools.payment.model.PaymentTransactionCreationResult;
import io.sphere.sdk.payments.PaymentMethodInfo;

import java.util.List;
import java.util.Optional;
import java.util.concurrent.CompletionStage;
import java.util.function.Function;

/**
 * Defines the methods that the shop could call to handle its payment.
 * The shop should never directly call a {@link PaymentServiceProvider} implementation.
 *
 * Created by mgatz on 7/18/16.
 */
public interface PaymentAdapterService {

    /**
     * @return the default instance of the payment adapter service
     */
    static PaymentAdapterService of() {
        return new PaymentAdapterServiceImpl();
    }
    /**
     * Find all payment services (implementing {@link PaymentServiceProvider} on the classpath and return a list of their
     * service entry points.
     * @return list of payment service implementation entry points
     */
     List findAllPaymentServiceProviders();

    /**
     * Get a list of available payment methods collected from all available {@link PaymentServiceProvider} instances {@link #findAllPaymentServiceProviders()}
     * @return list of payment method objects
     */
    List findAvailablePaymentMethods();

    /**
     * Get a filtered list of available payment methods collected from all available {@link PaymentServiceProvider} instances {@link #findAllPaymentServiceProviders()}
     * @param filter the filterfunction that will be applied
     * @return list of payment method objects
     */
    List findAvailablePaymentMethods(Function, List> filter);

    /**
     * Creates a new payment object at the CTP and thereby starts a new payment transaction workflow.
     * @param data the wrapper object for all possibly needed data
     * @return {@link CompletionStage} of {@link PaymentCreationResult} with the result of {@code data} payment creation
     */
    CompletionStage createPayment(CreatePaymentData data);

    /**
     * Create and handle a new payment transaction for the payment with the passed reference.
     * @param data the wrapper object for all possibly needed data
     * @return {@link CompletionStage} of {@link PaymentTransactionCreationResult} with the result of {@code data}
     * transaction creation.
     */
    CompletionStage createPaymentTransaction(CreatePaymentTransactionData data);

    /**
     * Get the full {@link PaymentMethodInfo} object from the configuration.
     * @param interfaceId payment interface id name
     * @param method payment method name
     * @return {@link Optional} of {@link PaymentMethodInfo} if such method for such interface exists.
     */
    Optional getPaymentMethodInfo(String interfaceId, String method);
}