ConflatingRecoveryPointAdapter (AMPS Java Client (5.3.4.0.14fbce6f.256885))

java.lang.Object
- com.crankuptheamps.client.ConflatingRecoveryPointAdapter

All Implemented Interfaces:

RecoveryPointAdapter, java.lang.AutoCloseable, java.lang.Iterable<RecoveryPoint>, java.util.Iterator<RecoveryPoint>
```
public class ConflatingRecoveryPointAdapter
extends java.lang.Object
implements RecoveryPointAdapter
```
An implementation of the RecoveryPointAdapter interface that is meant to act as a wrapper around another recovery point adapter instance, delegating periodic updates to its wrapped adapter on an asynchronous update thread (which this instance starts). The intent is to decouple recovery state updates from message discards on a bookmark replay subscriptions so that fast paced subscriptions don't cause a rate of updates that consume too much bandwidth or overwhelm recovery point adapter implementations that use slower storage (slowing message discards).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ConflatingRecoveryPointAdapter.UpdateThread` Internal thread for asynchronously delegating recovery state updates to the wrapper recovery point adapter.

Field Summary

Fields
Modifier and Type	Field and Description
`protected RecoveryPointAdapter`	`_adapter` The wrapped recovery point adapter instance we delegate to.
`protected boolean`	`_closed` Indicates whether this bookmark store has been closed.
`protected java.util.concurrent.ConcurrentHashMap<Field,java.lang.Long>`	`_counts` A concurrent hash map of subscription id's (known to this adapter) mapped to Long's that count how many updates have occurred for that subscription.
`protected java.beans.ExceptionListener`	`_exceptionListener` The exception listener for this client and both underlying HAClient instances.
`protected java.util.concurrent.ConcurrentHashMap<Field,RecoveryPoint>`	`_latestUpdates` A concurrent hash map of subscription id's mapped to the RecoveryPoint received from the most recent update.
`protected ConflatingRecoveryPointAdapter.UpdateThread`	`_thread` The background worker thread that persists subscription discard state to the SOW.
`protected long`	`_timeoutMillis` The threshold used to determine if a subscription is due for an update operation, based upon whether this many milliseconds have elapsed since the last update operation.
`protected java.util.concurrent.ConcurrentHashMap<Field,java.lang.Long>`	`_timers` A concurrent hash map of subscription id's (known to this adapter) mapped to Long's that represent the timestamp of when the subscription's state was last written to the adapter.
`protected boolean`	`_updateAll` Indicates whether all updates should be flushed regardless.
`protected long`	`_updateIntervalMillis` The threshold for idle time between updates when timers should be checked again.
`protected long`	`_updateThreshold` The threshold used to determine if a subscription is due for an update operation, based upon whether the subscription's update count exceeds this threshold since the last update operation.

Constructor Summary

Constructors
Constructor and Description
`ConflatingRecoveryPointAdapter(RecoveryPointAdapter adapter)` Constructs an instance of the recovery point adapter interface that is meant to act as a wrapper around another recovery point adapter instance, delegating periodic updates to its wrapped adapter on an asynchronous update thread (which this instance starts).
`ConflatingRecoveryPointAdapter(RecoveryPointAdapter adapter, long updateThreshold, long timeoutMillis, long updateIntervalMillis)` Constructs an instance of the recovery point adapter interface that is meant to act as a wrapper around another recovery point adapter instance, delegating periodic updates to its wrapped adapter on an asynchronous update thread (which this instance starts).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Force all updates to the underlying adapter, then close it.
`java.beans.ExceptionListener`	`getExceptionListener()` Returns the `ExceptionListener` instance used for communicating absorbed exceptions.
`boolean`	`hasNext()` Implements `Iterator.hasNext()`.
`java.util.Iterator<RecoveryPoint>`	`iterator()` Implements `Iterable.iterator()` to return this instance.
`RecoveryPoint`	`next()` Implements `Iterator.next()` for a message stream.
`void`	`purge()` This method is responsible for removing or purging all recovery point information from the instance(self) and from the wrapped adapter.
`void`	`purge(Field subId)` Remove all recovery point information for subId from self and adapter.
`void`	`remove()` Operation not supported.
`protected void`	`runUpdateAll()`
`void`	`setExceptionListener(java.beans.ExceptionListener exceptionListener)` Sets the `ExceptionListener` instance used for communicating absorbed exceptions.
`void`	`update(RecoveryPoint recoveryPoint)` Conflate an update to the newest recovery point.
`void`	`updateAll()` Force all held updates to be flushed to the underlying adapter.

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

Methods inherited from interface java.util.Iterator
forEachRemaining

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - _adapter
```
protected RecoveryPointAdapter _adapter
```
    The wrapped recovery point adapter instance we delegate to.
  - _counts
```
protected final java.util.concurrent.ConcurrentHashMap<Field,java.lang.Long> _counts
```
    A concurrent hash map of subscription id's (known to this adapter) mapped to Long's that count how many updates have occurred for that subscription.
  - _timers
```
protected final java.util.concurrent.ConcurrentHashMap<Field,java.lang.Long> _timers
```
    A concurrent hash map of subscription id's (known to this adapter) mapped to Long's that represent the timestamp of when the subscription's state was last written to the adapter.
  - _latestUpdates
```
protected final java.util.concurrent.ConcurrentHashMap<Field,RecoveryPoint> _latestUpdates
```
    A concurrent hash map of subscription id's mapped to the RecoveryPoint received from the most recent update.
  - _updateThreshold
```
protected volatile long _updateThreshold
```
    The threshold used to determine if a subscription is due for an update operation, based upon whether the subscription's update count exceeds this threshold since the last update operation.
  - _timeoutMillis
```
protected volatile long _timeoutMillis
```
    The threshold used to determine if a subscription is due for an update operation, based upon whether this many milliseconds have elapsed since the last update operation.
  - _updateIntervalMillis
```
protected volatile long _updateIntervalMillis
```
    The threshold for idle time between updates when timers should be checked again.
  - _thread
```
protected ConflatingRecoveryPointAdapter.UpdateThread _thread
```
    The background worker thread that persists subscription discard state to the SOW.
  - _closed
```
protected volatile boolean _closed
```
    Indicates whether this bookmark store has been closed.
  - _updateAll
```
protected volatile boolean _updateAll
```
    Indicates whether all updates should be flushed regardless.
  - _exceptionListener
```
protected volatile java.beans.ExceptionListener _exceptionListener
```
    The exception listener for this client and both underlying HAClient instances.
- Constructor Detail
  - ConflatingRecoveryPointAdapter
```
public ConflatingRecoveryPointAdapter(RecoveryPointAdapter adapter)
```
    Constructs an instance of the recovery point adapter interface that is meant to act as a wrapper around another recovery point adapter instance, delegating periodic updates to its wrapped adapter on an asynchronous update thread (which this instance starts). The intent is to decouple recovery state updates from message discards on a bookmark replay subscriptions so that fast paced subscriptions don't cause a rate of updates that consume too much bandwidth or overwhelm recovery point adapter implementations that use slower storage (slowing message discards). The update threshold is set to default of 10. The update timeout is set to default 2,000 milliseconds. The update interval, at which the update thread will check for updates, is set to the default of 2,000 milliseconds. To use any non-default values, use the other constructor.
    
    Parameters:
    
    adapter - The adapter that is sent conflated updates.
  - ConflatingRecoveryPointAdapter
```
public ConflatingRecoveryPointAdapter(RecoveryPointAdapter adapter,
                                      long updateThreshold,
                                      long timeoutMillis,
                                      long updateIntervalMillis)
```
    Constructs an instance of the recovery point adapter interface that is meant to act as a wrapper around another recovery point adapter instance, delegating periodic updates to its wrapped adapter on an asynchronous update thread (which this instance starts). The intent is to decouple recovery state updates from message discards on a bookmark replay subscriptions so that fast paced subscriptions don't cause a rate of updates that consume too much bandwidth or overwhelm recovery point adapter implementations that use slower storage (slowing message discards).
    
    Parameters:
    
    adapter - The adapter that is sent conflated updates.
    
    updateThreshold - The maximum number of updates to a subId before a conflated update is delivered.
    
    timeoutMillis - The maximum amount of time in milliseconds between conflated updates for each subId.
    
    updateIntervalMillis - The maximum amount of time in milliseconds the update thread can sit idle before checking for timeouts.
- Method Detail
  - setExceptionListener
```
public void setExceptionListener(java.beans.ExceptionListener exceptionListener)
```
    Sets the ExceptionListener instance used for communicating absorbed exceptions.
    
    Parameters:
    
    exceptionListener - The exception listener instance to invoke for internal exceptions.
  - getExceptionListener
```
public java.beans.ExceptionListener getExceptionListener()
```
    Returns the ExceptionListener instance used for communicating absorbed exceptions.
    
    Returns:
    
    The current exception listener.
  - update
```
public void update(RecoveryPoint recoveryPoint)
```
    Conflate an update to the newest recovery point. It ensures that updates are correctly handled for both repeat and new subscription data.
    
    Specified by:
    
    update in interface RecoveryPointAdapter
    
    Parameters:
    
    recoveryPoint - The newest recovery point to save.
  - purge
```
public void purge()
           throws java.lang.Exception
```
    This method is responsible for removing or purging all recovery point information from the instance(self) and from the wrapped adapter.
    
    Specified by:
    
    purge in interface RecoveryPointAdapter
    
    Throws:
    
    java.lang.Exception - Should be thrown for any error deleting recovery state from the external store.
    
    See Also:
    
    BookmarkStore.purge()
  - purge
```
public void purge(Field subId)
           throws java.lang.Exception
```
    Remove all recovery point information for subId from self and adapter.
    
    Specified by:
    
    purge in interface RecoveryPointAdapter
    
    Parameters:
    
    subId - The subId to remove.
    
    Throws:
    
    java.lang.Exception - Should be thrown for any error deleting recovery state from the external store.
    
    See Also:
    
    BookmarkStore.purge(com.crankuptheamps.client.fields.Field)
  - close
```
public void close()
           throws java.lang.Exception
```
    Force all updates to the underlying adapter, then close it.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.lang.Exception
  - hasNext
```
public boolean hasNext()
```
    Implements Iterator.hasNext(). This method is part of an iterator and checks if there is another element to be iterated over. It delegates the hasNext() functionality to another object _adapter, which likely represents an underlying data source or collection. If _adapter says there's a next element, this method returns true. If there isn't a nest element, it returns false.
    
    Specified by:
    
    hasNext in interface java.util.Iterator<RecoveryPoint>
  - next
```
public RecoveryPoint next()
```
    Implements Iterator.next() for a message stream. This is another iterator method and is used to get the next element in the iteration. Similar to hasNext(), it delegates the functionality to _adapter, which provides the next element. It returns this next element.
    
    Specified by:
    
    next in interface java.util.Iterator<RecoveryPoint>
  - remove
```
public void remove()
```
    Operation not supported. Implements Iterator.remove() to throw UnsupportedOperationException. This method is intended to remove elements from the underlying data source, but it's not supported. It throws an UnsupportedOperationException, indicating that the removal operation is not allowed.
    
    Specified by:
    
    remove in interface java.util.Iterator<RecoveryPoint>
  - iterator
```
public java.util.Iterator<RecoveryPoint> iterator()
```
    Implements Iterable.iterator() to return this instance. This method is used to obtain an iterator for the elements in this class, effectively allowing you to iterate over its elements. It returns the current instance (i.e., this) as an iterator.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<RecoveryPoint>
  - updateAll
```
public void updateAll()
```
    Force all held updates to be flushed to the underlying adapter.
  - runUpdateAll
```
protected void runUpdateAll()
```

Class ConflatingRecoveryPointAdapter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Methods inherited from interface java.lang.Iterable

Field Detail

_adapter

_counts

_timers

_latestUpdates

_updateThreshold

_timeoutMillis

_updateIntervalMillis

_thread

_closed

_updateAll

_exceptionListener

Constructor Detail

ConflatingRecoveryPointAdapter

ConflatingRecoveryPointAdapter

Method Detail

setExceptionListener

getExceptionListener

update

purge

purge

close

hasNext

next

remove

iterator

updateAll

runUpdateAll