de.hybris.platform.integration.cis.subscription.service.impl

Class DefaultCisSubscriptionService

java.lang.Object

de.hybris.platform.integration.cis.subscription.service.impl.DefaultCisSubscriptionService

All Implemented Interfaces:

CisSubscriptionService

public class DefaultCisSubscriptionService
extends java.lang.Object
implements CisSubscriptionService

Implementing class for delegating requests to the CIS server

Constructor Summary

Constructors

Constructor and Description
DefaultCisSubscriptionService()

Method Summary

Modifier and Type	Method and Description
RestResponse	cancelSubscription(java.lang.String cisClientRef, java.lang.String merchantSubscriptionId, java.lang.String effectiveFrom) Cancels an existing subscription
RestResponse	changePaymentMethod(java.lang.String cisClientRef, CisChangePaymentMethodRequest changePaymentRequest) Deprecated. as of SBG API 5.2
RestResponse	changeSubscriptionState(java.lang.String cisClientRef, CisSubscriptionChangeStateRequest subscriptionChangeStateRequest) This methods calls the CIS server in order to change the status of an existing subscription
RestResponse	createCustomerProfile(java.lang.String cisClientRef, CisSubscriptionProfileRequest createAccountRequest) The methods calls the CIS server in order to create a customer profile.
RestResponse	createSubscription(java.lang.String cisClientRef, 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
RestResponse	finalizeTransaction(java.lang.String cisClientRef, CisSubscriptionSessionFinalizeRequest finalizeRequest) Calls the CIS Server in order to finalize the Web Session
RestResponse	getBillingActivityDetail(java.lang.String cisClientRef, java.lang.String billingActivityId) Returns the billing activity detail for the given id.
RestResponse	getBillingActivityList(java.lang.String cisClientRef, java.lang.String subscriptionId, java.util.Date fromDate, java.util.Date toDate) Returns the billing activity list for the given subscription optionally filtered by date.
RestResponse	getCustomerProfile(java.lang.String cisClientRef, java.lang.String merchantAccountId) The methods calls the CIS server in order to retrieve a customer's profile data (including subscriptions).
protected SubscriptionClient	getSubscriptionClient()
RestResponse	hpfUrl(java.lang.String cisClientRef) Retrieves the URL for the silent order page
RestResponse	initializeTransaction(java.lang.String cisClientRef, CisSubscriptionSessionInitRequest initRequest) Calls the CIS Server in order to initialize the Web Session
RestResponse	post(java.lang.String cisClientRef, CisSubscriptionOrderPostRequest orderPostRequest) Deprecated. as of SBG API 5.2
RestResponse	processPayNow(java.lang.String cisClientRef, CisSubscriptionPayNowRequest payNowRequest) Calls the CIS Service to process the paynow prices of an order at the payment provider
RestResponse	replacePaymentMethod(java.lang.String cisClientRef, CisSubscriptionReplacePaymentMethodRequest replacePaymentRequest) Deprecated. as of SBG API 5.2
RestResponse	replacePaymentMethod(java.lang.String cisClientRef, java.lang.String merchantSubscriptionId, java.lang.String merchantPaymentMethodId, java.lang.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(SubscriptionClient subscriptionClient)
RestResponse	updatePaymentMethod(java.lang.String cisClientRef, CisPaymentMethodUpdateRequest updatePaymentRequest) This methods calls the CIS server in order to perform changes on an existing payment method.
RestResponse	updateProfile(java.lang.String cisClientRef, CisSubscriptionProfileRequest profileRequest) Updates a customer account by calling the SBG API method with updated profile data and a existing merchant account id
RestResponse	updateSubscription(java.lang.String cisClientRef, CisSubscriptionUpdateRequest subscriptionUpdateRequest) This methods calls the CIS server in order to update an existing subscription
RestResponse	updateSubscription(java.lang.String cisClientRef, java.lang.String subscriptionId, boolean force, CisSubscriptionUpdateAction updateAction)
RestResponse	upgradeSubscription(java.lang.String cisClientRef, 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 Detail

DefaultCisSubscriptionService

public DefaultCisSubscriptionService()

Method Detail

post

@Deprecated
public RestResponse post(java.lang.String cisClientRef,
                                     CisSubscriptionOrderPostRequest orderPostRequest)

Deprecated. as of SBG API 5.2

Description copied from interface: CisSubscriptionService

This methods calls the CIS server so that informations about the order can be delegated for example to a billing provider

Specified by:

post in interface CisSubscriptionService

Parameters:

cisClientRef - String

orderPostRequest - CisSubscriptionOrderPostRequest

Returns:

result object from the CIS server

createSubscription

public RestResponse createSubscription(java.lang.String cisClientRef,
                                       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

@Deprecated
public RestResponse replacePaymentMethod(java.lang.String cisClientRef,
                                                     CisSubscriptionReplacePaymentMethodRequest replacePaymentRequest)

Deprecated. as of SBG API 5.2

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

replacePaymentRequest - CisSubscriptionReplacePaymentMethodRequest

Returns:

result object from the CIS server

replacePaymentMethod

public RestResponse replacePaymentMethod(java.lang.String cisClientRef,
                                         java.lang.String merchantSubscriptionId,
                                         java.lang.String merchantPaymentMethodId,
                                         java.lang.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 RestResponse processPayNow(java.lang.String cisClientRef,
                                  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 RestResponse initializeTransaction(java.lang.String cisClientRef,
                                          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 RestResponse hpfUrl(java.lang.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 RestResponse finalizeTransaction(java.lang.String cisClientRef,
                                        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 RestResponse updateProfile(java.lang.String cisClientRef,
                                  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

changePaymentMethod

@Deprecated
public RestResponse changePaymentMethod(java.lang.String cisClientRef,
                                                    CisChangePaymentMethodRequest changePaymentRequest)

Deprecated. as of SBG API 5.2

Description copied from interface: CisSubscriptionService

This methods calls the CIS server in order to perform changes on an existing payment method.

Specified by:

changePaymentMethod in interface CisSubscriptionService

Parameters:

cisClientRef - String

changePaymentRequest - CisChangePaymentMethodRequest

Returns:

result object from the CIS server

updatePaymentMethod

public RestResponse updatePaymentMethod(java.lang.String cisClientRef,
                                        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 RestResponse cancelSubscription(java.lang.String cisClientRef,
                                       java.lang.String merchantSubscriptionId,
                                       java.lang.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 RestResponse createCustomerProfile(java.lang.String cisClientRef,
                                          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 RestResponse getCustomerProfile(java.lang.String cisClientRef,
                                       java.lang.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 SubscriptionClient getSubscriptionClient()

setSubscriptionClient

public void setSubscriptionClient(SubscriptionClient subscriptionClient)

updateSubscription

public RestResponse updateSubscription(java.lang.String cisClientRef,
                                       java.lang.String subscriptionId,
                                       boolean force,
                                       CisSubscriptionUpdateAction updateAction)

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 RestResponse upgradeSubscription(java.lang.String cisClientRef,
                                        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 RestResponse updateSubscription(java.lang.String cisClientRef,
                                       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 RestResponse changeSubscriptionState(java.lang.String cisClientRef,
                                            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 RestResponse getBillingActivityList(java.lang.String cisClientRef,
                                           java.lang.String subscriptionId,
                                           java.util.Date fromDate,
                                           java.util.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 RestResponse getBillingActivityDetail(java.lang.String cisClientRef,
                                             java.lang.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