Package com.broadleafcommerce.cartoperation.service.provider.external

Class ExternalSubscriptionOpsProvider

java.lang.Object

com.broadleafcommerce.cartoperation.service.provider.external.AbstractExternalProvider

com.broadleafcommerce.cartoperation.service.provider.external.ExternalSubscriptionOpsProvider

All Implemented Interfaces:

SubscriptionOpsProvider

public class ExternalSubscriptionOpsProvider
extends AbstractExternalProvider
implements SubscriptionOpsProvider

Field Summary

Fields inherited from class com.broadleafcommerce.cartoperation.service.provider.external.AbstractExternalProvider

ENTITY_NOT_FOUND

Constructor Summary

Constructors

Constructor	Description
ExternalSubscriptionOpsProvider(org.springframework.web.reactive.function.client.WebClient webClient, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory, ExternalSubscriptionOpsProviderProperties properties)

Method Summary

Modifier and Type	Method	Description
LockStatus	clearLock(String subscriptionId)	Clears a lock for a subscription.
protected ExternalSubscriptionOpsProviderProperties	getProperties()
protected String	getServiceClient()
IdentifyCancellationPolicyResponse	identifyCancellationPolicy(IdentifyCancellationPolicyRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Identifies the cancellation policy based on the given IdentifyCancellationPolicyRequest.
LockStatus	lockSubscription(String subscriptionId)	Locks a subscription.
UserSubscriptionSummary	readUserSubscriptionSummary(@NonNull String userRefType, @NonNull String userRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Fetches a UserSubscriptionSummary containing information about a user's active and former subscriptions.
CancellationPolicy	retrieveCancellationPolicyById(@NonNull String cancellationPolicyId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves a CancellationPolicy by its id.
List<SubscriptionPriceResponse>	retrieveSubscriptionPricing(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves SubscriptionPriceResponses describing how much the customer should be charged now, & estimations for how much & when they'll be charged in the future as part of subscription billing.

Methods inherited from class com.broadleafcommerce.cartoperation.service.provider.external.AbstractExternalProvider

addOffsetOrPageNumber, buildNotFoundException, executeRequest, getHeaders, getObjectMapper, getTypeFactory, getWebClient, isEntityNotFound, pageableToParams, uriVars

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalSubscriptionOpsProvider

public ExternalSubscriptionOpsProvider(org.springframework.web.reactive.function.client.WebClient webClient,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 ExternalSubscriptionOpsProviderProperties properties)

Method Details

retrieveSubscriptionPricing

public List<SubscriptionPriceResponse> retrieveSubscriptionPricing(@NonNull
 @NonNull com.broadleafcommerce.cart.client.domain.Cart cart,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOpsProvider

Retrieves SubscriptionPriceResponses describing how much the customer should be charged now, & estimations for how much & when they'll be charged in the future as part of subscription billing.

Specified by:

retrieveSubscriptionPricing in interface SubscriptionOpsProvider

Parameters:

cart - The cart that we are pricing.

contextInfo - Context information around sandbox and multitenant state.

Returns:

a list of SubscriptionPriceResponses

identifyCancellationPolicy

public IdentifyCancellationPolicyResponse identifyCancellationPolicy(IdentifyCancellationPolicyRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOpsProvider

Identifies the cancellation policy based on the given IdentifyCancellationPolicyRequest.

Specified by:

identifyCancellationPolicy in interface SubscriptionOpsProvider

Parameters:

request - The request containing the cart items to identify the cancellation policies for.

contextInfo - Context information around sandbox and multitenant state.

Returns:

The IdentifyCancellationPolicyResponse containing the identified cancellation policies.

retrieveCancellationPolicyById

public CancellationPolicy retrieveCancellationPolicyById(@NonNull
 @NonNull String cancellationPolicyId,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOpsProvider

Retrieves a CancellationPolicy by its id.

Specified by:

retrieveCancellationPolicyById in interface SubscriptionOpsProvider

Parameters:

cancellationPolicyId - The Id of the CancellationPolicy to retrieve.

contextInfo - Context information around sandbox and multitenant state.

Returns:

The retrieved CancellationPolicy

readUserSubscriptionSummary

public UserSubscriptionSummary readUserSubscriptionSummary(@NonNull
 @NonNull String userRefType,
 @NonNull
 @NonNull String userRef,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOpsProvider

Fetches a UserSubscriptionSummary containing information about a user's active and former subscriptions.

Specified by:

readUserSubscriptionSummary in interface SubscriptionOpsProvider

Parameters:

userRefType - The type of user reference

userRef - The reference to a user

contextInfo - Context information around sandbox and multitenant state.

Returns:

A UserSubscriptionSummary containing information about a user's active and former subscriptions.

lockSubscription

public LockStatus lockSubscription(String subscriptionId)

Description copied from interface: SubscriptionOpsProvider

Locks a subscription.

Specified by:

lockSubscription in interface SubscriptionOpsProvider

Parameters:

subscriptionId - The subscription ID to lock.

Returns:

The status of the lock operation.

clearLock

public LockStatus clearLock(String subscriptionId)

Description copied from interface: SubscriptionOpsProvider

Clears a lock for a subscription.

Specified by:

clearLock in interface SubscriptionOpsProvider

Parameters:

subscriptionId - The subscription ID to clear the lock for.

Returns:

The status of the lock operation.

getServiceClient

protected String getServiceClient()

getProperties

protected ExternalSubscriptionOpsProviderProperties getProperties()