Package com.broadleafcommerce.vendor.checkoutcom.autoconfigure

Class CheckoutComApplePayConfigurationProperties

java.lang.Object
com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties<CheckoutComApplePayConfigurationProperties>
com.broadleafcommerce.vendor.checkoutcom.autoconfigure.CheckoutComApplePayConfigurationProperties
@ConfigurationProperties("broadleaf.checkout-com.apple-pay") public class CheckoutComApplePayConfigurationProperties extends com.broadleafcommerce.paymentgateway.properties.DiscriminatedProperties<CheckoutComApplePayConfigurationProperties>
Properties used to configure the Apple Pay integration
Author:
Dima Myroniuk (dmyroniuk)
See Also:

  • Constructor Details

    • CheckoutComApplePayConfigurationProperties

      public CheckoutComApplePayConfigurationProperties()

  • Method Details

    • getApplePayCertificate

      @Deprecated(since="2.0.4", forRemoval=true) public String getApplePayCertificate(@Nullable String applicationId, @Nullable String tenantId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      it is advised to use StringBase64CheckoutComApplePayCertificateAndKeyProvider and it will use getApplePayCertificateString(String, String)
      Returns the path to the Apple Pay certificate, for example "applepay/certificate_sandbox.pem".
      Parameters:
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the path to the Apple Pay certificate

    • getApplePayPrivateKey

      @Deprecated(since="2.0.4", forRemoval=true) public String getApplePayPrivateKey(@Nullable String applicationId, @Nullable String tenantId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      it is advised to use StringBase64CheckoutComApplePayCertificateAndKeyProvider and it will use getApplePayPrivateKeyString(String, String)
      Returns the path to the Apple Pay private key, for example "applepay/private_key_sandbox.pem".
      Parameters:
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the path to the Apple Pay private key

    • getApplePayCertificateString

      public String getApplePayCertificateString(@Nullable String applicationId, @Nullable String tenantId)
      Returns the Apple Pay merchant identity certificate. The default provider implementation for this certificate expects the full PEM certificate file content provided here as a string, but without the 'BEGIN' and 'END' lines and without linebreaks. This value can be saved and exposed securely, i.e. from Broadleaf Config Server. Alternatively, it can be a base64 encoded DER file content
      Parameters:
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the path to the Apple Pay certificate
      Since:
      2.0.4

    • getApplePayPrivateKeyString

      public String getApplePayPrivateKeyString(@Nullable String applicationId, @Nullable String tenantId)
      Returns the Apple Pay merchant identity private key. The default provider implementation for this private key expects the full PEM private key file content provided here as a string, but without the 'BEGIN' and 'END' and without linebreaks. This value can be saved and exposed securely, i.e. from Broadleaf Config Server. Alternatively, it can be a base64 encoded DER file content
      Parameters:
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the path to the Apple Pay private key
      Since:
      2.0.4

    • getMerchantIdentifier

      public String getMerchantIdentifier(@Nullable String applicationId, @Nullable String tenantId)
      An identifier you register with Apple that uniquely identifies your business as a merchant able to accept payments
      Parameters:
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the merchant identifier
      See Also:

    • getDisplayName

      public String getDisplayName(@Nullable String applicationId, @Nullable String tenantId)
      A string of 64 or fewer UTF-8 characters containing the canonical name for your store, suitable for display. Don’t localize the name.
      Parameters:
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the name for your store

    • getInitiative

      public String getInitiative(@Nullable String applicationId, @Nullable String tenantId)
      A predefined value that identifies the e-commerce application making the request. Defaults to "web".
      Parameters:
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      a predefined value that identifies the e-commerce application making the request

    • getInitiativeContext

      public String getInitiativeContext(@Nullable String applicationId, @Nullable String tenantId)
      The values for initiative and initiativeContext depend on the kind of application you’re building: For Apple Pay on the web, use “web” for the initiative parameter. For the initiativeContext parameter, provide your fully qualified domain name associated with your Apple Pay Merchant Identity Certificate. For example, "my-store-domain.com". For Apple Messages for Business, use “messaging” for the initiative parameter. For the initiativeContext parameter, pass your payment gateway URL. See Type Interactive for more information. Please note, if initiative and initiativeContext are incorrect the validation of the Merchant session can fail.
      Parameters:
      applicationId - the application id
      tenantId - the tenant id
      Returns:
      the initiative context

    • setCertificate

      @Deprecated public void setCertificate(String certificate)
      Deprecated.
      it is advised to use StringBase64CheckoutComApplePayCertificateAndKeyProvider and it will consume certificateString

    • setPrivateKey

      @Deprecated public void setPrivateKey(String privateKey)
      Deprecated.
      it is advised to use StringBase64CheckoutComApplePayCertificateAndKeyProvider and it will consume privateKeyString

    • setCertificateString

      public void setCertificateString(String certificateString)
      Since:
      2.0.4
      See Also:

    • setPrivateKeyString

      public void setPrivateKeyString(String privateKeyString)
      Since:
      2.0.4
      See Also:

    • setMerchantIdentifier

      public void setMerchantIdentifier(String merchantIdentifier)

    • setDisplayName

      public void setDisplayName(String displayName)

    • setInitiative

      public void setInitiative(String initiative)

    • setInitiativeContext

      public void setInitiativeContext(String initiativeContext)

    • setValidMerchantValidationDomains

      public void setValidMerchantValidationDomains(List<String> validMerchantValidationDomains)
      The list of valid domains for merchant validation in production and testing.

    • getValidMerchantValidationDomains

      public List<String> getValidMerchantValidationDomains()
      The list of valid domains for merchant validation in production and testing.