StoreObjectAccessorLocking (Apache Brooklyn)

java.lang.Object
- brooklyn.entity.rebind.persister.StoreObjectAccessorLocking

All Implemented Interfaces:

PersistenceObjectStore.StoreObjectAccessor, PersistenceObjectStore.StoreObjectAccessorWithLock
```
public class StoreObjectAccessorLocking
extends java.lang.Object
implements PersistenceObjectStore.StoreObjectAccessorWithLock
```
Wraps access to an object (the delegate PersistenceObjectStore.StoreObjectAccessor in a guarded read-write context such that callers will be blocked if another thread is accessing the object in an incompatible way (e.g. trying to read when someone is writing). See ReadWriteLock.
This has no visibility or control over other access to the delegate or underlying object, of course. It can only affect callers coming through this wrapper instance. Thus callers must share instances of this class for a given item.
No locking is done with respect to getLastModifiedDate().

Constructor Summary

Constructors
Constructor and Description

StoreObjectAccessorLocking(PersistenceObjectStore.StoreObjectAccessor delegate)

Constructors
Constructor and Description
`StoreObjectAccessorLocking(PersistenceObjectStore.StoreObjectAccessor delegate)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`append(java.lang.String val)`
`void`	`delete()`
`boolean`	`exists()`
`java.lang.String`	`get()` gets the object, or null if not found
`java.util.Date`	`getLastModifiedDate()` last modified date, null if not supported or does not exist
`java.util.concurrent.locks.ReadWriteLock`	`getLockObject()` returns the underlying lock in case callers need more complex synchronization control
`void`	`put(java.lang.String val)`
`java.lang.String`	`toString()`
`void`	`waitForCurrentWrites(Duration timeout)` waits for all currently scheduled write lock operations (puts, appends, and deletes) to complete; but does not wait on or prevent subsequent modifications.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StoreObjectAccessorLocking
```
public StoreObjectAccessorLocking(PersistenceObjectStore.StoreObjectAccessor delegate)
```
- Method Detail
  - get
```
public java.lang.String get()
```
    Description copied from interface: PersistenceObjectStore.StoreObjectAccessor
    
    gets the object, or null if not found
    
    Specified by:
    
    get in interface PersistenceObjectStore.StoreObjectAccessor
  - exists
```
public boolean exists()
```
    Specified by:
    
    exists in interface PersistenceObjectStore.StoreObjectAccessor
  - put
```
public void put(java.lang.String val)
```
    Specified by:
    
    put in interface PersistenceObjectStore.StoreObjectAccessor
  - append
```
public void append(java.lang.String val)
```
    Specified by:
    
    append in interface PersistenceObjectStore.StoreObjectAccessor
  - delete
```
public void delete()
```
    Specified by:
    
    delete in interface PersistenceObjectStore.StoreObjectAccessor
  - waitForCurrentWrites
```
public void waitForCurrentWrites(Duration timeout)
                          throws java.lang.InterruptedException,
                                 java.util.concurrent.TimeoutException
```
    Description copied from interface: PersistenceObjectStore.StoreObjectAccessorWithLock
    
    waits for all currently scheduled write lock operations (puts, appends, and deletes) to complete; but does not wait on or prevent subsequent modifications. this is suitable for a model where the caller is managing synchronization.
    for more complex uses, readers should getLockObject().readLock().lockInterruptibly() and ensure they subsequently unlock() it of course. see PersistenceObjectStore.StoreObjectAccessorWithLock.getLockObject().
    
    Specified by:
    
    waitForCurrentWrites in interface PersistenceObjectStore.StoreObjectAccessorWithLock
    
    Throws:
    
    java.lang.InterruptedException
    
    java.util.concurrent.TimeoutException
  - getLastModifiedDate
```
public java.util.Date getLastModifiedDate()
```
    Description copied from interface: PersistenceObjectStore.StoreObjectAccessor
    
    last modified date, null if not supported or does not exist
    
    Specified by:
    
    getLastModifiedDate in interface PersistenceObjectStore.StoreObjectAccessor
  - getLockObject
```
public java.util.concurrent.locks.ReadWriteLock getLockObject()
```
    Description copied from interface: PersistenceObjectStore.StoreObjectAccessorWithLock
    
    returns the underlying lock in case callers need more complex synchronization control
    
    Specified by:
    
    getLockObject in interface PersistenceObjectStore.StoreObjectAccessorWithLock
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class StoreObjectAccessorLocking

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StoreObjectAccessorLocking

Method Detail

get

exists

put

append

delete

waitForCurrentWrites

getLastModifiedDate

getLockObject

toString