Package com.coditory.sherlock

Class RxSherlockStub

java.lang.Object
com.coditory.sherlock.RxSherlockStub
All Implemented Interfaces:
RxSherlock
public final class RxSherlockStub extends Object implements RxSherlock
Use to stub RxSherlock in tests.

  • Constructor Details

    • RxSherlockStub

      public RxSherlockStub()

  • Method Details

    • withReleasedLocks

      public static RxSherlockStub withReleasedLocks()
      Make the stub produce released locks by default
      Returns:
      the instance

    • withAcquiredLocks

      public static RxSherlockStub withAcquiredLocks()
      Make the stub produce acquired locks by default
      Returns:
      the instance

    • withLock

      public RxSherlockStub withLock(RxDistributedLock lock)
      Make the stub produce return a predefined lock.
      Parameters:
      lock - returned when creating a lock with the same id
      Returns:
      the instance

    • initialize

      public io.reactivex.Single<com.coditory.sherlock.connector.InitializationResult> initialize()
      Description copied from interface: RxSherlock
      Initializes underlying infrastructure. If this method is not invoked explicitly then it can be invoked implicitly when acquiring or releasing a lock for the first time.

      Most often initialization is related with creating indexes and tables.

      Specified by:
      initialize in interface RxSherlock
      Returns:
      InitializationResult.SUCCESS if initialization was successful, otherwise InitializationResult.FAILURE is returned

    • createLock

      public com.coditory.sherlock.DistributedLockBuilder<RxDistributedLock> createLock()
      Description copied from interface: RxSherlock
      Creates a distributed lock. Created lock may be acquired only once by the same owner: 
      
 assert lock.acquire() == true
 assert lock.acquire() == false
      Specified by:
      createLock in interface RxSherlock
      Returns:
      the lock builder

    • createReentrantLock

      public com.coditory.sherlock.DistributedLockBuilder<RxDistributedLock> createReentrantLock()
      Description copied from interface: RxSherlock
      Creates a distributed reentrant lock. Reentrant lock may be acquired multiple times by the same owner: 
      
 assert reentrantLock.acquire() == true
 assert reentrantLock.acquire() == true
      Specified by:
      createReentrantLock in interface RxSherlock
      Returns:
      the reentrant lock builder

    • createOverridingLock

      public com.coditory.sherlock.DistributedLockBuilder<RxDistributedLock> createOverridingLock()
      Description copied from interface: RxSherlock
      Create a distributed overriding lock. Returned lock may acquire or release any other lock without checking its state: 
      
 assert someLock.acquire() == true
 assert overridingLock.acquire() == true

      It could be used for administrative actions.

      Specified by:
      createOverridingLock in interface RxSherlock
      Returns:
      the overriding lock builder

    • forceReleaseAllLocks

      public io.reactivex.Single<com.coditory.sherlock.connector.ReleaseResult> forceReleaseAllLocks()
      Description copied from interface: RxSherlock
      Force releases all acquired locks.

      It could be used for administrative actions.

      Specified by:
      forceReleaseAllLocks in interface RxSherlock
      Returns:
      ReleaseResult.SUCCESS if lock was released, otherwise ReleaseResult.FAILURE is returned