com.plenigo.sdk.builders.CheckoutSnippetBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-sdk Show documentation
Show all versions of java-sdk Show documentation
Java SDK wrapping plenigo REST-API for easier usage.
package com.plenigo.sdk.builders;
import com.plenigo.sdk.PlenigoException;
import com.plenigo.sdk.PlenigoManager;
import com.plenigo.sdk.internal.ApiParams;
import com.plenigo.sdk.internal.ErrorCode;
import com.plenigo.sdk.internal.util.EncryptionUtils;
import com.plenigo.sdk.internal.util.SdkUtils;
import com.plenigo.sdk.models.Product;
import com.plenigo.sdk.models.ProductType;
import java.math.BigDecimal;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
*
* This class builds a plenigo's Javascript API checkout
* snippet based on a {@link Product} object that is
* compliant.
*
*
* Thread safety: This class is not thread safe.
*
*/
public class CheckoutSnippetBuilder {
private static final Logger LOGGER = Logger.getLogger(CheckoutSnippetBuilder.class.getName());
public static final String DECIMAL_FORMAT = "%.2f";
/**
* The Product object used to build the link.
*/
private Product product;
/**
* This flag is used to indicate that you want a confirmation check before
* generating the link.
*/
private Boolean alreadyPayedConfirmation;
/**
* This flag is used to indicate that you want a confirmation check before
* generating the link.
*/
private Boolean paymentConfirmation;
/**
* This is used to indicate that want to use cross-site request forgery
* (CSRF)
* tokens.
*/
private String csrfToken;
/**
* The redirect URL used for the single sign on process.
*/
private String redirectUrl;
/**
* This flag is used to indicate that you want to show the failed payments of the current user.
*/
private Boolean failedPayments;
/**
* Shipping costs related to the product checkout.
*/
private BigDecimal shippingCost;
/**
* Enables override mode.
*/
private Boolean overrideMode;
/**
* Login token.
*/
private String loginToken;
/**
* The checkout event template, this can be interpreted as a javascript
* snippet.
*/
private static final String CHECKOUT_SNIPPET_TPL = "plenigo.checkout(%s);";
private static final String CHECKOUT_LOGIN_SNIPPET_TPL = "plenigo.checkoutWithRemoteLogin(%s);";
private static final String CHECKOUT_PARAMETER_TPL = "'%s'";
private static final String CHECKOUT_PARAMETER_SEPARATOR = ",";
/**
* This constructor takes a {@link Product} object as a parameter.
*
* @param productToChkOut The product object to build the link from
*/
public CheckoutSnippetBuilder(final Product productToChkOut) {
this.product = productToChkOut;
}
/**
* Builds a checkout snippet builder with the failed payment flag set.
*/
public CheckoutSnippetBuilder() {
this.failedPayments = true;
}
/**
* This method is used to build the link once all the information and
* options have been selected, this will produce a Javascript snippet of
* code that can be used as an event on a webpage.
*
* @return A Javascript snippet that is compliant with plenigo's Javascript SDK.
*
* @throws com.plenigo.sdk.PlenigoException whenever an error happens
*/
public String build() throws PlenigoException {
String snippetTpl = CHECKOUT_SNIPPET_TPL;
String encodedData = buildEncodedData();
String parameters = String.format(CHECKOUT_PARAMETER_TPL, encodedData);
if (loginToken != null && !loginToken.isEmpty()) {
String loginParameter = String.format(CHECKOUT_PARAMETER_TPL, loginToken);
parameters += CHECKOUT_PARAMETER_SEPARATOR + loginParameter;
snippetTpl = CHECKOUT_LOGIN_SNIPPET_TPL;
}
String snippet = String
.format(snippetTpl, parameters);
LOGGER.log(Level.FINEST, "Built checkout snippet: {0}.", snippet);
return snippet;
}
/**
* This method builds the encoded data from the Checkout Object.
*
* @return The encoded data
*
* @throws com.plenigo.sdk.PlenigoException whenever an error happens
*/
private String buildEncodedData() throws PlenigoException {
String dataString = SdkUtils.getStringFromMap(convertToMap());
return EncryptionUtils.get().encryptWithAES(
PlenigoManager.get().getSecret(), dataString);
}
/**
* This method puts the non null parameters
* of the {@link Product} object into a {@link Map}.
*
* @return A map with the non null values of a {@link Product} object
*/
private Map convertToMap() {
LOGGER.log(Level.FINEST, "Data: {0} is being added to a map.", this);
Map map = new LinkedHashMap();
if (this.failedPayments != null) {
map.put(ApiParams.FAILED_PAYMENT, failedPayments);
} else {
// LinkedHashMap is used to maintain order
String price = formatPriceIfNotNull(product.getPrice());
LOGGER.log(Level.FINEST, "Formatted price: {0}", price);
String taxType = null;
if (product.getTaxType() != null) {
taxType = product.getTaxType().name();
}
LOGGER.log(Level.FINEST, "Tax type: {0}", taxType);
SdkUtils.addIfNotNull(map, ApiParams.PROD_PRICE, price);
SdkUtils.addIfNotNull(map, ApiParams.CURRENCY, product.getCurrency());
SdkUtils.addIfNotNull(map, ApiParams.PROD_TAX_TYPE, taxType);
SdkUtils.addIfNotNull(map, ApiParams.PROD_TITLE, product.getTitle());
SdkUtils.addIfNotNull(map, ApiParams.PROD_ID, product.getId());
SdkUtils.addIfNotNull(map, ApiParams.CUSTOM_AMOUNT, product.isCustomPrice());
SdkUtils.addIfNotNull(map, ApiParams.INFO_SCRN_SHOWN_ON_RETRY, alreadyPayedConfirmation);
SdkUtils.addIfNotNull(map, ApiParams.INFO_SCRN_SHOWN_AT_END_OF_PAYMENT, paymentConfirmation);
SdkUtils.addIfNotNull(map, ApiParams.TEST_TRANSACTION, PlenigoManager.get().isTestMode());
SdkUtils.addIfNotNull(map, ApiParams.SINGLE_SIGN_ON, redirectUrl);
SdkUtils.addIfNotNull(map, ApiParams.CATEGORY_ID, product.getCategoryId());
SdkUtils.addIfNotNull(map, ApiParams.SUBSCRIPTION_RENEWAL, product.getSubscriptionRenewal());
SdkUtils.addIfNotNull(map, ApiParams.SHIPPING_COST, shippingCost);
SdkUtils.addIfNotNull(map, ApiParams.OVERRIDE_MODE, overrideMode);
if (csrfToken != null) {
LOGGER.log(Level.FINEST, "The used CSRF Token: {0}", csrfToken);
map.put(ApiParams.CSRF_TOKEN, csrfToken);
}
LOGGER.log(Level.FINEST, "Map result: {0}", map);
}
return map;
}
/**
* Fornats the given price to the appropriate decimal format.
*
* @param price The price to convert
*
* @return A String with the price using the correct format
*/
private String formatPriceIfNotNull(Double price) {
if (price != null) {
return String.format(DECIMAL_FORMAT, price);
}
return null;
}
/**
* When this method is called before the {@link CheckoutSnippetBuilder#build()}
* method, when doing a checkout there will be a verification
* to see if a product has been already paid.
*
* @return The same {@link CheckoutSnippetBuilder} instance
*/
public CheckoutSnippetBuilder withAlreadyPayedConfirmation() {
alreadyPayedConfirmation = true;
return this;
}
/**
* When this method is called before the {@link CheckoutSnippetBuilder#build()}
* method, when doing a checkout there will be Single Sign On support.
*
* @param pageRedirectUrl The URI to redirect to when the login is done.
*
* @return The same {@link CheckoutSnippetBuilder} instance
*/
public CheckoutSnippetBuilder withSSO(String pageRedirectUrl) {
redirectUrl = pageRedirectUrl;
return this;
}
/**
* When this method is called before the {@link CheckoutSnippetBuilder#build()}
* method, when doing a checkout an info screen should
* be shown to users who try to buy the same product again,
* otherwise the user will be redirected to the product directly.
*
* @return The same {@link CheckoutSnippetBuilder} instance
*/
public CheckoutSnippetBuilder withPaymentConfirmation() {
paymentConfirmation = true;
return this;
}
/**
* When this method is called before the {@link CheckoutSnippetBuilder#build()}
* method, when doing a checkout the generated snippet
* will be using a cross-site request forgery (CSRF) token.
*
* @param token The provided CSRF token
*
* @return The same {@link CheckoutSnippetBuilder} instance
*/
public CheckoutSnippetBuilder withCSRFToken(String token) {
csrfToken = token;
return this;
}
/**
* Adds the shipping cost to the snippet builder.
*
* @param shippingCost shipping cost of product
* @param productType the product type related to the product
*
* @return The same {@link CheckoutSnippetBuilder} instance
*
* @throws PlenigoException if a validation error happens
*/
public CheckoutSnippetBuilder withShipping(BigDecimal shippingCost, ProductType productType) throws PlenigoException {
if (!productType.isShippingAllowed()) {
throw new PlenigoException(ErrorCode.SHIPPING_NOT_ALLOWED.getCode(), ErrorCode.SHIPPING_NOT_ALLOWED.getMsg());
}
this.shippingCost = shippingCost;
return this;
}
/**
* Enables override mode.
*
* @return The same {@link CheckoutSnippetBuilder} instance
*
* @throws PlenigoException if a validation error happens
*/
public CheckoutSnippetBuilder withOverrideMode() throws PlenigoException {
this.overrideMode = true;
if (product.getPrice() == null) {
ErrorCode errorCode = ErrorCode.OVERRIDE_MODE_REQUIRES_PRICE;
throw new PlenigoException(errorCode.getCode(), errorCode.getMsg());
}
return this;
}
/**
* Creates a checkout snippet with a login token.
*
* @param loginToken Login token
*
* @return The same {@link CheckoutSnippetBuilder} instance
*/
public CheckoutSnippetBuilder withLoginToken(String loginToken) {
this.loginToken = loginToken;
return this;
}
@Override
public String toString() {
return "CheckoutSnippetBuilder{" + "product=" + product + ", alreadyPayedConfirmation=" + alreadyPayedConfirmation + ", paymentConfirmation="
+ paymentConfirmation + ", csrfToken='" + csrfToken + '\'' + ", redirectUrl='" + redirectUrl + '\'' + ", failedPayments=" + failedPayments
+ ", shippingCost=" + shippingCost + '}';
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy