Package com.broadleafcommerce.payment.service.gateway.autoconfigure

Class CheckoutConfigurationProperties

java.lang.Object
com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties<CheckoutConfigurationProperties>
com.broadleafcommerce.payment.service.gateway.autoconfigure.CheckoutConfigurationProperties
@ConfigurationProperties("broadleaf.checkout-com") public class CheckoutConfigurationProperties extends com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties<CheckoutConfigurationProperties>
Properties used to configure the Checkout.com integration library. Note: the secret & public keys can be declared globally, or for specific applications or tenants.
Author:
Jawad Tariq

  • Constructor Summary

    Constructors
    Constructor
    Description
    CheckoutConfigurationProperties()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.checkout.Environment
    getEnvironment()
    Gathers the configured Checkout.com environment.
    String
    getPublicKey(String applicationId, String tenantId)
    Gathers the configured Checkout.com public key based on the provided context attributes.
    String
    getSecretKey(String applicationId, String tenantId)
    Gathers the configured Checkout.com secret key based on the provided context attributes.
    String
    getSignatureKey(String applicationId, String tenantId)
    Gathers the configured Checkout.com signature key.
    void
    setEnvironment(String environment)
    Environment can be either PRODUCTION or SANDBOX.
    void
    setPublicKey(String publicKey)
    Along with the Secret Key, the Public Key is also used to authenticate with the Checkout.com SDK.
    void
    setSecretKey(String secretKey)
    This Secret Key is the unique identifier provided by the checkout.com which is used to authenticate with the Checkout.com SDK.
    void
    setSignatureKey(String signatureKey)
    The HMAC is generated by taking the contents of the notification and hashing it using this key.

    Methods inherited from class com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties

    getApplication, getField, getTenant, setApplication, setTenant

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CheckoutConfigurationProperties

      public CheckoutConfigurationProperties()

  • Method Details

    • getEnvironment

      public com.checkout.Environment getEnvironment()
      Gathers the configured Checkout.com environment. Note, this is intentionally not application and/or tenant discriminated since we expect this value to be declared for the entire environment, not specific applications or tenants.
      Returns:
      The configured Checkout.com environment

    • getSecretKey

      public String getSecretKey(@Nullable String applicationId, @Nullable String tenantId)
      Gathers the configured Checkout.com secret key based on the provided context attributes.
      Parameters:
      applicationId - the application ID
      tenantId - the tenant ID
      Returns:
      The configured Checkout.com secret key

    • getPublicKey

      public String getPublicKey(@Nullable String applicationId, @Nullable String tenantId)
      Gathers the configured Checkout.com public key based on the provided context attributes.
      Parameters:
      applicationId - the application ID
      tenantId - the tenant ID
      Returns:
      The configured Checkout.com public key

    • getSignatureKey

      public String getSignatureKey(@Nullable String applicationId, @Nullable String tenantId)
      Gathers the configured Checkout.com signature key.
      Parameters:
      applicationId - the application ID
      tenantId - the tenant ID
      Returns:
      The configured Checkout.com signature key
      See Also:

    • setSecretKey

      public void setSecretKey(String secretKey)
      This Secret Key is the unique identifier provided by the checkout.com which is used to authenticate with the Checkout.com SDK.

    • setPublicKey

      public void setPublicKey(String publicKey)
      Along with the Secret Key, the Public Key is also used to authenticate with the Checkout.com SDK. Both of these keys needs to be provided in order to complete the authentication with checkout.com.

    • setSignatureKey

      public void setSignatureKey(String signatureKey)
      The HMAC is generated by taking the contents of the notification and hashing it using this key. The HMAC will be in every notification to validate the request. This key is required to integrate with the webhook.
      See Also:

    • setEnvironment

      public void setEnvironment(String environment)
      Environment can be either PRODUCTION or SANDBOX. Sandbox Environment is required to test the SDK locally while Production Environment will be used on Production.