Details
-
New Feature
-
Resolution: Won't Do
-
Major
-
None
-
None
-
None
Description
Currently customers use polling to determine when a locked document becomes unlocked. It might be preferable instead to have an observable or similar notification mechanism where the client would be alerted when a document of interest has become unlocked. This would avoid the need for polling and ideally reduce total round trip time. The client could elect to subscribe to one-or-many documents for unlock change notifications. Alternatively, an option to subscribe could be returned upon the first document request that would normally return a temporary error (locked).
A method signature might be similar to:
/**
- This method would notify callers when a document is not locked.
* - Using this method, clients can avoid polling for a result for cache-filling use-cases or
- for use-cases where updates require synchronization — i.e. waiting for a result upon locking.
* - The event can be subscribed to when a client desires to be notified through the provided observable.
* - @param <D> - this is the type parameter for the document-type requested.
- @param document – the document to be notified on
- @return Observable of the event, containing the document that was retrieved
*/
Observable<DocumentEvent<D>> notifyUnlock(D document)