Package com.broadleafcommerce.subscription.service.impl

Class DefaultSubscriptionLockService

java.lang.Object

com.broadleafcommerce.subscription.service.impl.DefaultSubscriptionLockService

All Implemented Interfaces:

SubscriptionLockService

public class DefaultSubscriptionLockService
extends Object
implements SubscriptionLockService

Field Summary

Fields

Modifier and Type	Field	Description
protected final SubscriptionLockRepository<JpaSubscriptionLock>	lockRepository

Constructor Summary

Constructors

Constructor	Description
DefaultSubscriptionLockService(SubscriptionLockRepository<JpaSubscriptionLock> lockRepository)

Method Summary

Modifier and Type	Method	Description
LockStatus	clearLock(@NonNull String subscriptionId, boolean isRevert)	Releases all locks on the subscription, including all child locks.
LockStatus	createToken(@NonNull String subscriptionId, String childIdentifier)	Creates a child lock on the subscription's existing lock.
protected SubscriptionLockRepository<JpaSubscriptionLock>	getLockRepository()
LockStatus	lockSubscription(@NonNull SubscriptionLockRequest request)	Attempts to apply a lock to the Subscription identified by SubscriptionLockRequest.getSubscriptionId()
LockStatus	unlockToken(@NonNull String subscriptionId, @NonNull String token, boolean propagate)	Releases a specific child lock on the subscription

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.subscription.service.SubscriptionLockService

lockSubscription

Field Details

lockRepository

protected final SubscriptionLockRepository<JpaSubscriptionLock> lockRepository

Constructor Details

DefaultSubscriptionLockService

public DefaultSubscriptionLockService(SubscriptionLockRepository<JpaSubscriptionLock> lockRepository)

Method Details

lockSubscription

public LockStatus lockSubscription(@NonNull
 @NonNull SubscriptionLockRequest request)

Description copied from interface: SubscriptionLockService

Attempts to apply a lock to the Subscription identified by SubscriptionLockRequest.getSubscriptionId()

Specified by:

lockSubscription in interface SubscriptionLockService

Parameters:

request - Request describing the lock to apply to the subscription

Returns:

A LockStatus describing the result of the attempted lock

clearLock

public LockStatus clearLock(@NonNull
 @NonNull String subscriptionId,
 boolean isRevert)

Description copied from interface: SubscriptionLockService

Releases all locks on the subscription, including all child locks. Along with releasing the subscription lock, this will also deploy or revert sandbox changes to the subscription based on the isRevert parameter.

Specified by:

clearLock in interface SubscriptionLockService

Parameters:

subscriptionId - The id of the subscription that is locked

isRevert - Whether to revert (isRevert == true) or deploy (isRevert == false) the subscription's sandbox changes.

Returns:

A LockStatus describing the state of the lock

createToken

public LockStatus createToken(@NonNull
 @NonNull String subscriptionId,
 @Nullable
 String childIdentifier)

Description copied from interface: SubscriptionLockService

Creates a child lock on the subscription's existing lock.

Specified by:

createToken in interface SubscriptionLockService

Parameters:

subscriptionId - The id of the subscription for which to apply a child lock

childIdentifier - The identifier of the child lock that is to be created.

Returns:

A LockStatus describing the state of the lock

unlockToken

public LockStatus unlockToken(@NonNull
 @NonNull String subscriptionId,
 @NonNull
 @NonNull String token,
 boolean propagate)

Description copied from interface: SubscriptionLockService

Releases a specific child lock on the subscription

Specified by:

unlockToken in interface SubscriptionLockService

Parameters:

subscriptionId - The id of the subscription that is locked

token - The token used to identify the child lock

propagate - Whether to propagate the token unlock to the parent lock

Returns:

A LockStatus describing the state of the lock

getLockRepository

protected SubscriptionLockRepository<JpaSubscriptionLock> getLockRepository()