Class DefaultCisSubscriptionService

java.lang.Object
de.hybris.platform.integration.cis.subscription.service.impl.DefaultCisSubscriptionService
All Implemented Interfaces:
CisSubscriptionService

public class DefaultCisSubscriptionService extends Object implements CisSubscriptionService
Implementing class for delegating requests to the CIS server
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.http.ResponseEntity
    cancelSubscription(String cisClientRef, String merchantSubscriptionId, String effectiveFrom)
    Cancels an existing subscription
    org.springframework.http.ResponseEntity
    changeSubscriptionState(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionChangeStateRequest subscriptionChangeStateRequest)
    This methods calls the CIS server in order to change the status of an existing subscription
    org.springframework.http.ResponseEntity
    createCustomerProfile(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionProfileRequest createAccountRequest)
    The methods calls the CIS server in order to create a customer profile.
    org.springframework.http.ResponseEntity
    createSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionCreateRequest createSubscriptionRequest)
    This methods calls the CIS server so that informations about the order can be delegated to a billing provider to create a subscription
    org.springframework.http.ResponseEntity
    finalizeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionFinalizeRequest finalizeRequest)
    Calls the CIS Server in order to finalize the Web Session
    org.springframework.http.ResponseEntity
    getBillingActivityDetail(String cisClientRef, String billingActivityId)
    Returns the billing activity detail for the given id.
    org.springframework.http.ResponseEntity
    getBillingActivityList(String cisClientRef, String subscriptionId, Date fromDate, Date toDate)
    Returns the billing activity list for the given subscription optionally filtered by date.
    org.springframework.http.ResponseEntity
    getCustomerProfile(String cisClientRef, String merchantAccountId)
    The methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions).
    protected com.hybris.cis.client.rest.subscription.SubscriptionClient
     
    org.springframework.http.ResponseEntity
    hpfUrl(String cisClientRef)
    Retrieves the URL for the silent order page
    org.springframework.http.ResponseEntity
    initializeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionInitRequest initRequest)
    Calls the CIS Server in order to initialize the Web Session
    org.springframework.http.ResponseEntity
    processPayNow(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionPayNowRequest payNowRequest)
    Calls the CIS Service to process the paynow prices of an order at the payment provider
    org.springframework.http.ResponseEntity
    replacePaymentMethod(String cisClientRef, String merchantSubscriptionId, String merchantPaymentMethodId, String effectiveFrom)
    This methods calls the CIS server in order to replace the payment method for an existing subscription with another (existing) payment method.
    void
    setSubscriptionClient(com.hybris.cis.client.rest.subscription.SubscriptionClient subscriptionClient)
     
    org.springframework.http.ResponseEntity
    updatePaymentMethod(String cisClientRef, com.hybris.cis.api.subscription.model.CisPaymentMethodUpdateRequest updatePaymentRequest)
    This methods calls the CIS server in order to perform changes on an existing payment method.
    org.springframework.http.ResponseEntity
    updateProfile(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionProfileRequest profileRequest)
    Updates a customer account by calling the SBG API method with updated profile data and a existing merchant account id
    org.springframework.http.ResponseEntity
    updateSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpdateRequest subscriptionUpdateRequest)
    This methods calls the CIS server in order to update an existing subscription
    org.springframework.http.ResponseEntity
    updateSubscription(String cisClientRef, String subscriptionId, boolean force, CisSubscriptionUpdateAction updateAction)
    Updates an existing subscription
    org.springframework.http.ResponseEntity
    upgradeSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpgradeRequest subscriptionUpgradeRequest)
    This methods calls the CIS server in order to upgrade an existing subscription

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • DefaultCisSubscriptionService

      public DefaultCisSubscriptionService()
  • Method Details

    • createSubscription

      public org.springframework.http.ResponseEntity createSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionCreateRequest createSubscriptionRequest)
      Description copied from interface: CisSubscriptionService
      This methods calls the CIS server so that informations about the order can be delegated to a billing provider to create a subscription
      Specified by:
      createSubscription in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      createSubscriptionRequest - CisSubscriptionCreateRequest
      Returns:
      result object from the CIS server
    • replacePaymentMethod

      public org.springframework.http.ResponseEntity replacePaymentMethod(String cisClientRef, String merchantSubscriptionId, String merchantPaymentMethodId, String effectiveFrom)
      Description copied from interface: CisSubscriptionService
      This methods calls the CIS server in order to replace the payment method for an existing subscription with another (existing) payment method.
      Specified by:
      replacePaymentMethod in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      merchantSubscriptionId - id of the subscription to be updated String
      merchantPaymentMethodId - id of the substituting payment method String
      effectiveFrom - when the new payment method should be effective String
      Returns:
      result object from the CIS server
    • processPayNow

      public org.springframework.http.ResponseEntity processPayNow(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionPayNowRequest payNowRequest)
      Description copied from interface: CisSubscriptionService
      Calls the CIS Service to process the paynow prices of an order at the payment provider
      Specified by:
      processPayNow in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      payNowRequest - CisSubscriptionPayNowRequest
      Returns:
      result object from the CIS server
    • initializeTransaction

      public org.springframework.http.ResponseEntity initializeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionInitRequest initRequest)
      Description copied from interface: CisSubscriptionService
      Calls the CIS Server in order to initialize the Web Session
      Specified by:
      initializeTransaction in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      initRequest - CisSubscriptionSessionInitRequest
      Returns:
      result object from the CIS server
    • hpfUrl

      public org.springframework.http.ResponseEntity hpfUrl(String cisClientRef)
      Description copied from interface: CisSubscriptionService
      Retrieves the URL for the silent order page
      Specified by:
      hpfUrl in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      Returns:
      url as String
    • finalizeTransaction

      public org.springframework.http.ResponseEntity finalizeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionFinalizeRequest finalizeRequest)
      Description copied from interface: CisSubscriptionService
      Calls the CIS Server in order to finalize the Web Session
      Specified by:
      finalizeTransaction in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      finalizeRequest - CisSubscriptionSessionFinalizeRequest
      Returns:
      result object from the CIS server
    • updateProfile

      public org.springframework.http.ResponseEntity updateProfile(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionProfileRequest profileRequest)
      Description copied from interface: CisSubscriptionService
      Updates a customer account by calling the SBG API method with updated profile data and a existing merchant account id
      Specified by:
      updateProfile in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      profileRequest - CisSubscriptionProfileRequest
      Returns:
      result object from the CIS server
    • updatePaymentMethod

      public org.springframework.http.ResponseEntity updatePaymentMethod(String cisClientRef, com.hybris.cis.api.subscription.model.CisPaymentMethodUpdateRequest updatePaymentRequest)
      Description copied from interface: CisSubscriptionService
      This methods calls the CIS server in order to perform changes on an existing payment method.
      Specified by:
      updatePaymentMethod in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      updatePaymentRequest - CisPaymentMethodUpdateRequest
      Returns:
      result object from the CIS server
    • cancelSubscription

      public org.springframework.http.ResponseEntity cancelSubscription(String cisClientRef, String merchantSubscriptionId, String effectiveFrom)
      Description copied from interface: CisSubscriptionService
      Cancels an existing subscription
      Specified by:
      cancelSubscription in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      merchantSubscriptionId - String
      effectiveFrom - String
      Returns:
      result object from the CIS server
    • createCustomerProfile

      public org.springframework.http.ResponseEntity createCustomerProfile(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionProfileRequest createAccountRequest)
      Description copied from interface: CisSubscriptionService
      The methods calls the CIS server in order to create a customer profile.
      Specified by:
      createCustomerProfile in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      createAccountRequest - CisSubscriptionProfileRequest
      Returns:
      result object from the CIS server
    • getCustomerProfile

      public org.springframework.http.ResponseEntity getCustomerProfile(String cisClientRef, String merchantAccountId)
      Description copied from interface: CisSubscriptionService
      The methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions).
      Specified by:
      getCustomerProfile in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      merchantAccountId - String
      Returns:
      result object from the CIS server
    • getSubscriptionClient

      protected com.hybris.cis.client.rest.subscription.SubscriptionClient getSubscriptionClient()
    • setSubscriptionClient

      public void setSubscriptionClient(com.hybris.cis.client.rest.subscription.SubscriptionClient subscriptionClient)
    • updateSubscription

      public org.springframework.http.ResponseEntity updateSubscription(String cisClientRef, String subscriptionId, boolean force, CisSubscriptionUpdateAction updateAction)
      Description copied from interface: CisSubscriptionService
      Updates an existing subscription
      Specified by:
      updateSubscription in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      subscriptionId - String
      force - boolean flag set in request
      updateAction - CisSubscriptionUpdateAction
      Returns:
      result object from the CIS server
    • upgradeSubscription

      public org.springframework.http.ResponseEntity upgradeSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpgradeRequest subscriptionUpgradeRequest)
      Description copied from interface: CisSubscriptionService
      This methods calls the CIS server in order to upgrade an existing subscription
      Specified by:
      upgradeSubscription in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      subscriptionUpgradeRequest - CisSubscriptionUpgradeRequest
      Returns:
      result object from the CIS server
    • updateSubscription

      public org.springframework.http.ResponseEntity updateSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpdateRequest subscriptionUpdateRequest)
      Description copied from interface: CisSubscriptionService
      This methods calls the CIS server in order to update an existing subscription
      Specified by:
      updateSubscription in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      subscriptionUpdateRequest - CisSubscriptionUpdateRequest
      Returns:
      result object from the CIS server
    • changeSubscriptionState

      public org.springframework.http.ResponseEntity changeSubscriptionState(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionChangeStateRequest subscriptionChangeStateRequest)
      Description copied from interface: CisSubscriptionService
      This methods calls the CIS server in order to change the status of an existing subscription
      Specified by:
      changeSubscriptionState in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      subscriptionChangeStateRequest - CisSubscriptionChangeStateRequest
      Returns:
      result object from the CIS server
    • getBillingActivityList

      public org.springframework.http.ResponseEntity getBillingActivityList(String cisClientRef, String subscriptionId, Date fromDate, Date toDate)
      Description copied from interface: CisSubscriptionService
      Returns the billing activity list for the given subscription optionally filtered by date.
      Specified by:
      getBillingActivityList in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      subscriptionId - String
      fromDate - String
      toDate - String
      Returns:
      result object from the CIS server
    • getBillingActivityDetail

      public org.springframework.http.ResponseEntity getBillingActivityDetail(String cisClientRef, String billingActivityId)
      Description copied from interface: CisSubscriptionService
      Returns the billing activity detail for the given id.
      Specified by:
      getBillingActivityDetail in interface CisSubscriptionService
      Parameters:
      cisClientRef - String
      billingActivityId - String
      Returns:
      result object from the CIS server