Package com.broadleafcommerce.common.messaging.provider.mongo.repository

Class MongoCustomizedResourceLockRepository

java.lang.Object

com.broadleafcommerce.common.messaging.provider.mongo.repository.MongoCustomizedResourceLockRepository

All Implemented Interfaces:

MongoResourceLockRepository, ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>, org.springframework.data.repository.Repository<MongoResourceLock,org.bson.types.ObjectId>

public class MongoCustomizedResourceLockRepository
extends Object
implements MongoResourceLockRepository

Specialized implementation of MongoResourceLockRepository.

Author:

Jeff Fischer, Chris Kittrell (ckittrell)

Constructor Summary

Constructors

Constructor	Description
MongoCustomizedResourceLockRepository(org.springframework.data.mongodb.core.MongoTemplate template, ResourceLockProperties resourceLockProperties)

Method Summary

Modifier and Type	Method	Description
<V> V	doWithLock(@NonNull String contextId, @NonNull Class<?> type, String sandboxId, String conceptKey, @NonNull Supplier<V> operation)	A convenience method for ResourceLockRepository.lockResource(String, Class, String, String) and ResourceLockRepository.unlockResource(String) to obtainin a lock, perform an operation and then unlock
<V> V	doWithTemporaryLock(@NonNull String contextId, @NonNull Class<?> type, String sandboxId, String conceptKey, @NonNull Supplier<V> operation)	A convenience method for ResourceLockRepository.lockResource(String, Class, String, String) and ResourceLockRepository.unlockResource(String) to obtain a temporary lock, perform an operation and then unlock
<V> V	doWithTemporaryLock(@NonNull String contextId, @NonNull Class<?> type, String sandboxId, String conceptKey, Duration stagnationThreshold, @NonNull Supplier<V> operation)	A convenience method for ResourceLockRepository.lockResource(String, Class, String, String) and ResourceLockRepository.unlockResource(String) to obtainin a lock, perform an operation and then unlock
protected String	getConceptKeyOrDefault(String conceptKey)
protected String	getSandboxIdOrDefault(String sandboxId)
protected List<MongoResourceLock>	identifyLocksToBePurged(@NonNull Class<?> type, @NonNull Duration lockTtl, org.bson.types.ObjectId startingId)	Identifies locks that are eligible to be purged
String	lockResource(@NonNull String contextId, @NonNull Class<?> type, String sandboxId, String conceptKey)	Lock a resource indefinitely based on identifying information.
String	lockResourceTemporarily(@NonNull String contextId, @NonNull Class<?> type, String sandboxId, String conceptKey)	Lock a resource temporarily based on identifying information.
String	lockResourceTemporarily(@NonNull String contextId, @NonNull Class<?> type, String sandboxId, String conceptKey, @NonNull Duration stagnationThreshold)	Lock a resource temporarily based on identifying information.
void	purgeLocks(@NonNull Class<?> type, @NonNull Duration lockTtl)	Deletes all non-expiring locks that are out of date according to the lockTtl and have JpaResourceLock.getTypeAlias() equal to the provided type.
protected void	releaseLock(MongoResourceLock lock)	Deletes the provided lock, if its lock timestamp has not been updated since the lock was identified
LockStatus	status(String token)	Report on the status of the lock.
void	unlockResource(@NonNull String token)	Unlock the resource so that other requesters can acquire the lock on the resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoCustomizedResourceLockRepository

public MongoCustomizedResourceLockRepository(org.springframework.data.mongodb.core.MongoTemplate template,
                                             ResourceLockProperties resourceLockProperties)

Method Detail

lockResource

public String lockResource(@NonNull
                           @NonNull String contextId,
                           @NonNull
                           @NonNull Class<?> type,
                           @Nullable
                           String sandboxId,
                           @Nullable
                           String conceptKey)

Description copied from interface: ResourceLockRepository

Lock a resource indefinitely based on identifying information. Will return a token representing the lock that is suitable to be passed to ResourceLockRepository.unlockResource(String) when the work requiring the lock is complete. If unable to acquire the lock, a ResourceLockException is thrown.

Specified by:

lockResource in interface ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>

Parameters:

contextId - a unique id of the obtain a lock for

type - grouping for the contextId

sandboxId - sandbox associated with the entity

conceptKey - a generally descriptive key that identifies the overall concept for which the lock is taking place

Returns:

The token that identifies the lock

lockResourceTemporarily

public String lockResourceTemporarily(@NonNull
                                      @NonNull String contextId,
                                      @NonNull
                                      @NonNull Class<?> type,
                                      @Nullable
                                      String sandboxId,
                                      @Nullable
                                      String conceptKey)

Description copied from interface: ResourceLockRepository

Lock a resource temporarily based on identifying information. Will return a token representing the lock that is suitable to be passed to ResourceLockRepository.unlockResource(String) when the work requiring the lock is complete. If unable to acquire the lock, a ResourceLockException is thrown.

Specified by:

lockResourceTemporarily in interface ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>

Parameters:

contextId - a unique id of the obtain a lock for

type - grouping for the contextId

sandboxId - sandbox associated with the entity

conceptKey - a generally descriptive key that identifies the overall concept for which the lock is taking place

Returns:

The token that identifies the lock

See Also:

ResourceLockProperties.getDefaultStagnationThreshold()

lockResourceTemporarily

public String lockResourceTemporarily(@NonNull
                                      @NonNull String contextId,
                                      @NonNull
                                      @NonNull Class<?> type,
                                      @Nullable
                                      String sandboxId,
                                      @Nullable
                                      String conceptKey,
                                      @NonNull
                                      @NonNull Duration stagnationThreshold)

Description copied from interface: ResourceLockRepository

Lock a resource temporarily based on identifying information. Will return a token representing the lock that is suitable to be passed to ResourceLockRepository.unlockResource(String) when the work requiring the lock is complete. If unable to acquire the lock, a ResourceLockException is thrown.

Specified by:

lockResourceTemporarily in interface ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>

Parameters:

contextId - a unique id of the obtain a lock for

type - grouping for the contextId

sandboxId - sandbox associated with the entity

conceptKey - a generally descriptive key that identifies the overall concept for which the lock is taking place

stagnationThreshold - how long the lock should be held

Returns:

The token that identifies the lock

unlockResource

public void unlockResource(@NonNull
                           @NonNull String token)

Description copied from interface: ResourceLockRepository

Unlock the resource so that other requesters can acquire the lock on the resource.

Specified by:

unlockResource in interface ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>

Parameters:

token - The identifying token for the lock

status

public LockStatus status(String token)

Description copied from interface: ResourceLockRepository

Report on the status of the lock. Especially useful if the token is distributed outside of a discrete flow.

Specified by:

status in interface ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>

Parameters:

token - The identifying token for the lock

Returns:

The status of the lock

doWithLock

public <V> V doWithLock(@NonNull
                        @NonNull String contextId,
                        @NonNull
                        @NonNull Class<?> type,
                        @Nullable
                        String sandboxId,
                        @Nullable
                        String conceptKey,
                        @NonNull
                        @NonNull Supplier<V> operation)

Description copied from interface: ResourceLockRepository

A convenience method for ResourceLockRepository.lockResource(String, Class, String, String) and ResourceLockRepository.unlockResource(String) to obtainin a lock, perform an operation and then unlock

Specified by:

doWithLock in interface ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>

Type Parameters:

V - type returned from operation

Parameters:

contextId - a unique id of the obtain a lock for

type - grouping for the contextId

sandboxId - sandbox associated with the entity

conceptKey - a generally descriptive key that identifies the overall concept for which the lock is taking place

operation - the operation to perform within the lock

Returns:

the result of invoking operation

doWithTemporaryLock

public <V> V doWithTemporaryLock(@NonNull
                                 @NonNull String contextId,
                                 @NonNull
                                 @NonNull Class<?> type,
                                 @Nullable
                                 String sandboxId,
                                 @Nullable
                                 String conceptKey,
                                 @NonNull
                                 @NonNull Supplier<V> operation)

Description copied from interface: ResourceLockRepository

A convenience method for ResourceLockRepository.lockResource(String, Class, String, String) and ResourceLockRepository.unlockResource(String) to obtain a temporary lock, perform an operation and then unlock

Specified by:

doWithTemporaryLock in interface ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>

Type Parameters:

V - type returned from operation

Parameters:

contextId - a unique id of the obtain a lock for

type - grouping for the contextId

sandboxId - sandbox associated with the entity

conceptKey - a generally descriptive key that identifies the overall concept for which the lock is taking place

operation - the operation to perform within the lock

Returns:

the result of invoking operation

See Also:

ResourceLockProperties.getDefaultStagnationThreshold()

doWithTemporaryLock

public <V> V doWithTemporaryLock(@NonNull
                                 @NonNull String contextId,
                                 @NonNull
                                 @NonNull Class<?> type,
                                 @Nullable
                                 String sandboxId,
                                 @Nullable
                                 String conceptKey,
                                 @Nullable
                                 Duration stagnationThreshold,
                                 @NonNull
                                 @NonNull Supplier<V> operation)

Description copied from interface: ResourceLockRepository

A convenience method for ResourceLockRepository.lockResource(String, Class, String, String) and ResourceLockRepository.unlockResource(String) to obtainin a lock, perform an operation and then unlock

Specified by:

doWithTemporaryLock in interface ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>

Type Parameters:

V - type returned from operation

Parameters:

contextId - a unique id of the obtain a lock for

type - grouping for the contextId

sandboxId - sandbox associated with the entity

conceptKey - a generally descriptive key that identifies the overall concept for which the lock is taking place

stagnationThreshold - how long the lock should be held

operation - the operation to perform within the lock

Returns:

the result of invoking operation

purgeLocks

public void purgeLocks(@NonNull
                       @NonNull Class<?> type,
                       @NonNull
                       @NonNull Duration lockTtl)

Description copied from interface: ResourceLockRepository

Deletes all non-expiring locks that are out of date according to the lockTtl and have JpaResourceLock.getTypeAlias() equal to the provided type.

Specified by:

purgeLocks in interface ResourceLockRepository<MongoResourceLock,org.bson.types.ObjectId>

Parameters:

type - The type of lock that is to be removed

lockTtl - How long the lock should be held. If the lock is too old, then it should be removed.

identifyLocksToBePurged

protected List<MongoResourceLock> identifyLocksToBePurged(@NonNull
                                                          @NonNull Class<?> type,
                                                          @NonNull
                                                          @NonNull Duration lockTtl,
                                                          @Nullable
                                                          org.bson.types.ObjectId startingId)

Identifies locks that are eligible to be purged

Parameters:

type - The type of lock that should be identified

lockTtl - How long the lock should be held. If the lock is too old, then it should be removed.

startingId - The id from which to start the retrieval of a batch of candidate records.

Returns:

The list of locks that are eligible to be purged

releaseLock

protected void releaseLock(MongoResourceLock lock)

Deletes the provided lock, if its lock timestamp has not been updated since the lock was identified

Parameters:

lock - The lock that is to be released

getSandboxIdOrDefault

protected String getSandboxIdOrDefault(@Nullable
                                       String sandboxId)

getConceptKeyOrDefault

protected String getConceptKeyOrDefault(@Nullable
                                        String conceptKey)