Class DefaultCisSubscriptionService
java.lang.Object
de.hybris.platform.integration.cis.subscription.service.impl.DefaultCisSubscriptionService
- All Implemented Interfaces:
CisSubscriptionService
Implementing class for delegating requests to the CIS server
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntitycancelSubscription(String cisClientRef, String merchantSubscriptionId, String effectiveFrom) Cancels an existing subscriptionorg.springframework.http.ResponseEntitychangeSubscriptionState(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 subscriptionorg.springframework.http.ResponseEntitycreateCustomerProfile(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.ResponseEntitycreateSubscription(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 subscriptionorg.springframework.http.ResponseEntityfinalizeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionFinalizeRequest finalizeRequest) Calls the CIS Server in order to finalize the Web Sessionorg.springframework.http.ResponseEntitygetBillingActivityDetail(String cisClientRef, String billingActivityId) Returns the billing activity detail for the given id.org.springframework.http.ResponseEntitygetBillingActivityList(String cisClientRef, String subscriptionId, Date fromDate, Date toDate) Returns the billing activity list for the given subscription optionally filtered by date.org.springframework.http.ResponseEntitygetCustomerProfile(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.SubscriptionClientorg.springframework.http.ResponseEntityRetrieves the URL for the silent order pageorg.springframework.http.ResponseEntityinitializeTransaction(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionSessionInitRequest initRequest) Calls the CIS Server in order to initialize the Web Sessionorg.springframework.http.ResponseEntityprocessPayNow(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 providerorg.springframework.http.ResponseEntityreplacePaymentMethod(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.voidsetSubscriptionClient(com.hybris.cis.client.rest.subscription.SubscriptionClient subscriptionClient) org.springframework.http.ResponseEntityupdatePaymentMethod(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.ResponseEntityupdateProfile(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 idorg.springframework.http.ResponseEntityupdateSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpdateRequest subscriptionUpdateRequest) This methods calls the CIS server in order to update an existing subscriptionorg.springframework.http.ResponseEntityupdateSubscription(String cisClientRef, String subscriptionId, boolean force, CisSubscriptionUpdateAction updateAction) Updates an existing subscriptionorg.springframework.http.ResponseEntityupgradeSubscription(String cisClientRef, com.hybris.cis.api.subscription.model.CisSubscriptionUpgradeRequest subscriptionUpgradeRequest) This methods calls the CIS server in order to upgrade an existing subscription
-
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:CisSubscriptionServiceThis methods calls the CIS server so that informations about the order can be delegated to a billing provider to create a subscription- Specified by:
createSubscriptionin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringcreateSubscriptionRequest-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:CisSubscriptionServiceThis methods calls the CIS server in order to replace the payment method for an existing subscription with another (existing) payment method.- Specified by:
replacePaymentMethodin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringmerchantSubscriptionId- id of the subscription to be updatedStringmerchantPaymentMethodId- id of the substituting payment methodStringeffectiveFrom- when the new payment method should be effectiveString- 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:CisSubscriptionServiceCalls the CIS Service to process the paynow prices of an order at the payment provider- Specified by:
processPayNowin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringpayNowRequest-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:CisSubscriptionServiceCalls the CIS Server in order to initialize the Web Session- Specified by:
initializeTransactionin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringinitRequest-CisSubscriptionSessionInitRequest- Returns:
- result object from the CIS server
-
hpfUrl
Description copied from interface:CisSubscriptionServiceRetrieves the URL for the silent order page- Specified by:
hpfUrlin interfaceCisSubscriptionService- 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:CisSubscriptionServiceCalls the CIS Server in order to finalize the Web Session- Specified by:
finalizeTransactionin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringfinalizeRequest-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:CisSubscriptionServiceUpdates a customer account by calling the SBG API method with updated profile data and a existing merchant account id- Specified by:
updateProfilein interfaceCisSubscriptionService- Parameters:
cisClientRef-StringprofileRequest-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:CisSubscriptionServiceThis methods calls the CIS server in order to perform changes on an existing payment method.- Specified by:
updatePaymentMethodin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringupdatePaymentRequest-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:CisSubscriptionServiceCancels an existing subscription- Specified by:
cancelSubscriptionin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringmerchantSubscriptionId-StringeffectiveFrom-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:CisSubscriptionServiceThe methods calls the CIS server in order to create a customer profile.- Specified by:
createCustomerProfilein interfaceCisSubscriptionService- Parameters:
cisClientRef-StringcreateAccountRequest-CisSubscriptionProfileRequest- Returns:
- result object from the CIS server
-
getCustomerProfile
public org.springframework.http.ResponseEntity getCustomerProfile(String cisClientRef, String merchantAccountId) Description copied from interface:CisSubscriptionServiceThe methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions).- Specified by:
getCustomerProfilein interfaceCisSubscriptionService- Parameters:
cisClientRef-StringmerchantAccountId-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:CisSubscriptionServiceUpdates an existing subscription- Specified by:
updateSubscriptionin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringsubscriptionId-Stringforce- boolean flag set in requestupdateAction-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:CisSubscriptionServiceThis methods calls the CIS server in order to upgrade an existing subscription- Specified by:
upgradeSubscriptionin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringsubscriptionUpgradeRequest-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:CisSubscriptionServiceThis methods calls the CIS server in order to update an existing subscription- Specified by:
updateSubscriptionin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringsubscriptionUpdateRequest-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:CisSubscriptionServiceThis methods calls the CIS server in order to change the status of an existing subscription- Specified by:
changeSubscriptionStatein interfaceCisSubscriptionService- Parameters:
cisClientRef-StringsubscriptionChangeStateRequest-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:CisSubscriptionServiceReturns the billing activity list for the given subscription optionally filtered by date.- Specified by:
getBillingActivityListin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringsubscriptionId-StringfromDate-StringtoDate-String- Returns:
- result object from the CIS server
-
getBillingActivityDetail
public org.springframework.http.ResponseEntity getBillingActivityDetail(String cisClientRef, String billingActivityId) Description copied from interface:CisSubscriptionServiceReturns the billing activity detail for the given id.- Specified by:
getBillingActivityDetailin interfaceCisSubscriptionService- Parameters:
cisClientRef-StringbillingActivityId-String- Returns:
- result object from the CIS server
-