Package com.broadleafcommerce.subscriptionoperation.service.modification

Class InitiateCancelSubscriptionHandler

java.lang.Object

com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

All Implemented Interfaces:

ModifySubscriptionHandler

public class InitiateCancelSubscriptionHandler
extends AbstractModifySubscriptionHandler
implements ModifySubscriptionHandler

Handles initiating a Subscription cancellation flow.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor

Description

InitiateCancelSubscriptionHandler(com.broadleafcommerce.common.extension.TypeFactory typeFactory, SubscriptionModificationUtils subscriptionModificationUtils, CancellationPolicyProvider<CancellationPolicy> cancellationPolicyProvider, CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart> cartOperationProvider, SubscriptionCancellationProperties subscriptionCancellationProperties, SubscriptionOperationUtils subscriptionOperationUtils, SubscriptionProvider<SubscriptionWithItems,Subscription,SubscriptionOwnerInfo> subscriptionProvider, SubscriptionOperationServiceProperties subOpsServiceProperties)

Method Summary

Modifier and Type	Method	Description
protected AddItemRequest	buildAddItemRequest(@NonNull SubscriptionItem subscriptionItem, @NonNull Subscription subscription, @NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds an AddItemRequest from the given subscriptionItem, subscription and the flowName
protected List<AddItemRequest>	buildAddItemRequestsForCancellationFeeProducts(@NonNull ModifySubscriptionRequest request)	Builds a List of AddItemRequest for products containing cancellation-fees.
protected CreateCartRequest	buildCreateCartRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a CreateCartRequest from the ModifySubscriptionRequest
protected <I extends PendingSubscriptionItemAdjustmentRemoval> I	buildPendingSubscriptionItemAdjustmentRemovalDetail(@NonNull SubscriptionItemAdjustment itemAdj, @NonNull SubscriptionItem item, @NonNull Map<String,Subscription> subscriptionById)	Builds a PendingSubscriptionItemAdjustmentRemoval detail for the given SubscriptionItemAdjustment.
protected <I extends PendingSubscriptionItemAdjustmentRemoval> List<I>	buildPendingSubscriptionItemAdjustmentRemovalDetails(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a list of SubscriptionItemAdjustmentToRemoves representing details of the subscription item adjustments that will be removed as a result of the subscription cancellation.
protected <I extends PendingSubscriptionItemAdjustmentRemoval> List<I>	buildPendingSubscriptionItemAdjustmentRemovalDetailsForItem(@NonNull Set<String> itemIdsBeingCancelled, @NonNull SubscriptionItem item, @NonNull Map<String,Subscription> subscriptionById)
protected boolean	canCancelSubscription(@NonNull SubscriptionWithItems subscriptionWithItems, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether the current subscription can be cancelled.
boolean	canHandle(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether the handler can handle the ModifySubscriptionRequest.
protected List<String>	getCancellationFeeProductIds(@NonNull SubscriptionWithItems subscriptionWithItems, @NonNull CancellationPolicyDetail cancellationPolicyDetail)	Fetches the Ids of the extra (cancellation) fee products including the grace fee cancellation product (if applicable) from the given CancellationPolicyDetail.
protected CancellationPolicyProvider<CancellationPolicy>	getCancellationPolicyProvider()
protected CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart>	getCartOperationProvider()
protected int	getDefaultSWIPageSize()	Returns the default page size for gathering SubscriptionWithItems
protected String	getFlowName()	Produces the name of the modification flow.
protected com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils	getPolicyUtils()
protected String[]	getRequiredPermissions(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to supply the permissions required to perform the given SubscriptionAction.
protected SubscriptionOperationServiceProperties	getSubOpsServiceProperties()
protected SubscriptionCancellationProperties	getSubscriptionCancellationProperties()
protected SubscriptionOperationUtils	getSubscriptionOperationUtils()
protected SubscriptionProvider<SubscriptionWithItems,Subscription,SubscriptionOwnerInfo>	getSubscriptionProvider()
protected ModifySubscriptionResponse	handleInternal(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hookpoint for custom logic specific to a particular modification request.
protected void	hydrateAdditionalContextOntoRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handles hydrating any additional contextual information onto the ModifySubscriptionRequest that the handler needs.
protected void	populateCartAttributesOnCreateCartRequest(@NonNull ModifySubscriptionRequest request, @NonNull CreateCartRequest createCartRequest)	Stores additional values in CreateCartRequest.getCartAttributes() that would be used in downstream flows.
protected void	setNonCatalogItemDetailsOnCancelItem(@NonNull ModifySubscriptionRequest request, @NonNull AddItemRequest cancelItem)	Sets the NonCatalogItemDetails on the cancelItem
void	setPolicyUtils(com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils policyUtils)
protected void	validateBusinessRules(@NonNull ModifySubscriptionRequest request, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to supply custom business rules for specific action types.

Methods inherited from class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

addDependentsToParents, buildPriceCartRequest, generateCartName, getChildOptions, getSubscriptionModificationUtils, getTypeFactory, handle, hydrateProductsAndItemChoices, validateActionType, validateAdditionalPermissionRules, validateCurrentSubscriptionState, validateRequest, validateUserAccessToSubscription

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.subscriptionoperation.service.modification.ModifySubscriptionHandler

handle

Constructor Details

InitiateCancelSubscriptionHandler

public InitiateCancelSubscriptionHandler(com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 SubscriptionModificationUtils subscriptionModificationUtils,
 CancellationPolicyProvider<CancellationPolicy> cancellationPolicyProvider,
 CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart> cartOperationProvider,
 SubscriptionCancellationProperties subscriptionCancellationProperties,
 SubscriptionOperationUtils subscriptionOperationUtils,
 SubscriptionProvider<SubscriptionWithItems,Subscription,SubscriptionOwnerInfo> subscriptionProvider,
 SubscriptionOperationServiceProperties subOpsServiceProperties)

Method Details

canHandle

public boolean canHandle(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: ModifySubscriptionHandler

Determines whether the handler can handle the ModifySubscriptionRequest.

Specified by:

canHandle in interface ModifySubscriptionHandler

Parameters:

request - The incoming request to modify a Subscription

contextInfo - Additional sandbox and multitenant info

Returns:

Whether this handler can handle the ModifySubscriptionRequest.

hydrateAdditionalContextOntoRequest

protected void hydrateAdditionalContextOntoRequest(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractModifySubscriptionHandler

Handles hydrating any additional contextual information onto the ModifySubscriptionRequest that the handler needs. By default, this does nothing.

Overrides:

hydrateAdditionalContextOntoRequest in class AbstractModifySubscriptionHandler

Parameters:

request - The ModifySubscriptionRequest to hydrate.

contextInfo - Additional sandbox and multitenant info.

handleInternal

protected ModifySubscriptionResponse handleInternal(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractModifySubscriptionHandler

Hookpoint for custom logic specific to a particular modification request.

Specified by:

handleInternal in class AbstractModifySubscriptionHandler

Parameters:

request - The incoming request to modify a Subscription

contextInfo - Additional sandbox and multitenant info

Returns:

Whether this handler can handle the ModifySubscriptionRequest.

See Also:

• AbstractModifySubscriptionHandler.handle(ModifySubscriptionRequest, ContextInfo)

validateBusinessRules

protected void validateBusinessRules(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @NonNull
 @NonNull org.springframework.validation.Errors errors,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractModifySubscriptionHandler

Hook point to supply custom business rules for specific action types. Called by AbstractModifySubscriptionHandler.validateRequest(ModifySubscriptionRequest, ContextInfo).

Overrides:

validateBusinessRules in class AbstractModifySubscriptionHandler

Parameters:

request - The ModifySubscriptionRequest with the details related to the modification to make.

errors - Object storing validation errors for the `request`

contextInfo - the current sandbox and multitenant context

getRequiredPermissions

protected String[] getRequiredPermissions(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractModifySubscriptionHandler

Hook point to supply the permissions required to perform the given SubscriptionAction. These may be different depending on the type of user requesting the modification.

Specified by:

getRequiredPermissions in class AbstractModifySubscriptionHandler

Parameters:

request - The ModifySubscriptionRequest with the details related to the modification to make.

contextInfo - the current sandbox and multitenant context

Returns:

The required permissions for the requester to perform the modification.

getFlowName

protected String getFlowName()

Description copied from class: AbstractModifySubscriptionHandler

Produces the name of the modification flow.

Specified by:

getFlowName in class AbstractModifySubscriptionHandler

Returns:

The name of the modification flow.

See Also:

• DefaultSubscriptionActionFlow

buildCreateCartRequest

protected CreateCartRequest buildCreateCartRequest(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds a CreateCartRequest from the ModifySubscriptionRequest

Overrides:

buildCreateCartRequest in class AbstractModifySubscriptionHandler

Parameters:

request - the ModifySubscriptionRequest containing request details.

contextInfo - the contextInfo.

Returns:

the CreateCartRequest to hydrate.

buildAddItemRequest

protected AddItemRequest buildAddItemRequest(@NonNull
 @NonNull SubscriptionItem subscriptionItem,
 @NonNull
 @NonNull Subscription subscription,
 @NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractModifySubscriptionHandler

Builds an AddItemRequest from the given subscriptionItem, subscription and the flowName

Overrides:

buildAddItemRequest in class AbstractModifySubscriptionHandler

Parameters:

subscriptionItem - the subscriptionItem

subscription - the subscription

request - the ModifySubscriptionRequest

Returns:

a AddItemRequest

canCancelSubscription

protected boolean canCancelSubscription(@NonNull
 @NonNull SubscriptionWithItems subscriptionWithItems,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Determines whether the current subscription can be cancelled.

Parameters:

subscriptionWithItems - The SubscriptionWithItems that may be acted against.

contextInfo - Additional sandbox and multitenant info

Returns:

whether the current subscription can be cancelled.

setNonCatalogItemDetailsOnCancelItem

protected void setNonCatalogItemDetailsOnCancelItem(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @NonNull
 @NonNull AddItemRequest cancelItem)

Sets the NonCatalogItemDetails on the cancelItem

Parameters:

request - the ModifySubscriptionRequest containing request details.

cancelItem - the item on which the NonCatalogItemDetails are set.

populateCartAttributesOnCreateCartRequest

protected void populateCartAttributesOnCreateCartRequest(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @NonNull
 @NonNull CreateCartRequest createCartRequest)

Stores additional values in CreateCartRequest.getCartAttributes() that would be used in downstream flows.

Overrides:

populateCartAttributesOnCreateCartRequest in class AbstractModifySubscriptionHandler

Parameters:

request - the ModifySubscriptionRequest containing request details.

createCartRequest - The CreateCartRequest to populate with attributes.

buildAddItemRequestsForCancellationFeeProducts

protected List<AddItemRequest> buildAddItemRequestsForCancellationFeeProducts(@NonNull
 @NonNull ModifySubscriptionRequest request)

Builds a List of AddItemRequest for products containing cancellation-fees.

Parameters:

request - the ModifySubscriptionRequest containing request details.

Returns:

A List of AddItemRequest for products containing cancellation-fees

getCancellationFeeProductIds

protected List<String> getCancellationFeeProductIds(@NonNull
 @NonNull SubscriptionWithItems subscriptionWithItems,
 @NonNull
 @NonNull CancellationPolicyDetail cancellationPolicyDetail)

Fetches the Ids of the extra (cancellation) fee products including the grace fee cancellation product (if applicable) from the given CancellationPolicyDetail.

Parameters:

subscriptionWithItems - The SubscriptionWithItems that stores the subscription with its items.

cancellationPolicyDetail - The CancellationPolicyDetail containing more details about the current subscription's CancellationPolicy

Returns:

A List of cancellation fee product ids

buildPendingSubscriptionItemAdjustmentRemovalDetails

protected <I extends PendingSubscriptionItemAdjustmentRemoval>
List<I> buildPendingSubscriptionItemAdjustmentRemovalDetails(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds a list of SubscriptionItemAdjustmentToRemoves representing details of the subscription item adjustments that will be removed as a result of the subscription cancellation.

Type Parameters:

I - the type of PendingSubscriptionItemAdjustmentRemoval

Parameters:

request - the ModifySubscriptionRequest containing request details.

contextInfo - the contextInfo.

Returns:

a list of SubscriptionItemAdjustmentToRemoves

getDefaultSWIPageSize

protected int getDefaultSWIPageSize()

Returns the default page size for gathering SubscriptionWithItems

Returns:

the default page size for gathering SubscriptionWithItems

buildPendingSubscriptionItemAdjustmentRemovalDetailsForItem

protected <I extends PendingSubscriptionItemAdjustmentRemoval>
List<I> buildPendingSubscriptionItemAdjustmentRemovalDetailsForItem(@NonNull
 @NonNull Set<String> itemIdsBeingCancelled,
 @NonNull
 @NonNull SubscriptionItem item,
 @NonNull
 @NonNull Map<String,Subscription> subscriptionById)

buildPendingSubscriptionItemAdjustmentRemovalDetail

protected <I extends PendingSubscriptionItemAdjustmentRemoval>
I buildPendingSubscriptionItemAdjustmentRemovalDetail(@NonNull
 @NonNull SubscriptionItemAdjustment itemAdj,
 @NonNull
 @NonNull SubscriptionItem item,
 @NonNull
 @NonNull Map<String,Subscription> subscriptionById)

Builds a PendingSubscriptionItemAdjustmentRemoval detail for the given SubscriptionItemAdjustment.

Type Parameters:

I - the type of PendingSubscriptionItemAdjustmentRemoval

Parameters:

itemAdj - the SubscriptionItemAdjustment to build the detail for.

item - the SubscriptionItem that the SubscriptionItemAdjustment belongs to

subscriptionById - a map of subscription ids to Subscriptions

Returns:

the PendingSubscriptionItemAdjustmentRemoval detail

getPolicyUtils

@Nullable
protected com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils getPolicyUtils()

Specified by:

getPolicyUtils in class AbstractModifySubscriptionHandler

setPolicyUtils

@Autowired(required=false)
public void setPolicyUtils(com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils policyUtils)

getCancellationPolicyProvider

protected CancellationPolicyProvider<CancellationPolicy> getCancellationPolicyProvider()

getCartOperationProvider

protected CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart> getCartOperationProvider()

getSubscriptionOperationUtils

protected SubscriptionOperationUtils getSubscriptionOperationUtils()

getSubscriptionCancellationProperties

protected SubscriptionCancellationProperties getSubscriptionCancellationProperties()

getSubscriptionProvider

protected SubscriptionProvider<SubscriptionWithItems,Subscription,SubscriptionOwnerInfo> getSubscriptionProvider()

getSubOpsServiceProperties

protected SubscriptionOperationServiceProperties getSubOpsServiceProperties()