org.rvpf.store.client

Class AbstractStore

Object

Proxied.Abstract

AbstractStore

All Implemented Interfaces:

Comparable<Store>, Store, Proxied

Direct Known Subclasses:

AbstractSink, RMIStore

public abstract class AbstractStore
extends Proxied.Abstract
implements Store

Abstract store.

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUERIES_BATCH_LIMIT_PROPERTY Limits the size of a batch of queries.
static String	RESPONSE_LIMIT_PROPERTY Limits the maximum number of point values that may be grouped in a single response.

Fields inherited from interface Store

ARCHIVE_TIME_PARAM, BIND_POINTS_PARAM, BINDING_PARAM, CONFIRM_PARAM, CONFIRM_RETRIES_PARAM, CONFIRM_RETRY_DELAY_PARAM, DEFAULT_STORE_NAME, LIFE_TIME_PARAM, NAME_PARAM, NULL_REMOVES_PARAM, PASSWORD_PARAM, QUEUE_PARAM, RESPECT_VERSION_PARAM, SECURITY_PARAM, USER_PARAM

Constructor Summary

Constructors

Constructor and Description
AbstractStore()

Method Summary

Modifier and Type	Method and Description
protected StoreAccessException	accessException(SessionException cause) Returns an access exception.
boolean	addQuery(StoreValuesQuery query) Adds a store query for point values.
void	addUpdate(PointValue pointValue) Added an update for a point value.
void	bind(Point point) Requests the binding of a point.
protected void	bindPoints() Binds points to their UUID.
protected void	bindPoints(Set<Point> points) Binds points to their UUID.
boolean	canConfirm() Asks if this store can confirm point values.
void	close() Closes the store.
int	compareTo(Store other)
boolean	confirm(PointValue pointValue, boolean confirmValue) Confirms a point value.
StoreValues	deliver(int limit, long timeout) Delivers subscribed point values from store update events.
protected abstract void	doAddQuery(StoreValuesQuery query) Does add a store query for point values.
protected int	getConfirmRetries() Gets the confirm retries.
protected long	getConfirmRetryDelay() Gets the confirm retry delay.
int	getQueriesBatchLimit() Gets the queries batch limit.
int	getResponseLimit() Gets the response limit.
Optional<StoreValues[]>	getSubscribedValues() Gets the values from the subscribed call.
protected Logger	getThisLogger() Gets the logger.
int	getUpdateCount() Gets the update count.
Collection<PointValue>	getUpdates() Gets the updates not yet sent.
UUID	getUUID() Gest the store entity UUID.
void	impersonate(Optional<String> user) Impersonates an other user.
boolean	isNullRemoves() Asks if a null value removes that value.
Iterable<PointValue>	iterate(StoreValuesQuery query) Iterates on the point values returned for a store query.
StoreValues	pull(StoreValuesQuery query, long timeout) Pulls points values.
int	purge(UUID[] pointUUIDs, TimeInterval timeInterval) Purges point values.
protected void	reset() Resets.
boolean	sendUpdates() Sends the pending updates.
protected void	setConfirmRetries() Sets the confirm retries.
protected void	setQueriesBatchLimit(Config config) Sets the queries batch limit.
protected void	setResponseLimit(Config config) Sets the response limit.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.
boolean	subscribe(Collection<UUID> points) Subscribes to point values store update events.
boolean	subscribe(UUID[] points) Subscribes to point values store update events.
protected abstract String	supportedValueTypeCodes() Returns a string of supported value type codes.
EnumSet<Externalizer.ValueType>	supportedValueTypes() Gets the value types supported by this store.
boolean	supportsCount() Asks if this store supports count.
boolean	supportsDelete() Asks if this store supports delete.
boolean	supportsDeliver() Asks if this store supports deliver.
boolean	supportsPull() Asks if this store supports pull queries.
boolean	supportsPurge() Asks if this store supports purge.
boolean	supportsSubscribe() Asks if this store supports subscribe.
void	tearDown() Tears down what has been set up.
boolean	unsubscribe(UUID[] points) Unsubscribes from points values events.

Methods inherited from class Proxied.Abstract

getMetadata, getName, getParams, getProxyEntity

Methods inherited from class Object

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

Methods inherited from interface Store

connect, getExceptions, getName, getParams, nextValues, probe, select, sendUpdates

Field Detail

QUERIES_BATCH_LIMIT_PROPERTY

public static final String QUERIES_BATCH_LIMIT_PROPERTY

Limits the size of a batch of queries.

See Also:

Constant Field Values

RESPONSE_LIMIT_PROPERTY

public static final String RESPONSE_LIMIT_PROPERTY

Limits the maximum number of point values that may be grouped in a single response.

See Also:

Constant Field Values

Constructor Detail

AbstractStore

public AbstractStore()

Method Detail

addQuery

public final boolean addQuery(StoreValuesQuery query)

Adds a store query for point values.

The queries will be sent on the next call to Store.nextValues().

Specified by:

addQuery in interface Store

Parameters:

query - The store query.

Returns:

True unless cancelled.

addUpdate

public final void addUpdate(PointValue pointValue)

Added an update for a point value.

The updates will be sent on the next call to Store.sendUpdates().

Specified by:

addUpdate in interface Store

Parameters:

pointValue - The point value.

See Also:

Store.supportsDelete()

bind

public final void bind(Point point)

Requests the binding of a point.

This allows communications with stores on different metadata domains. The client and server will try to map the possibly different UUID using the point's 'Tag' parameter (the point's name will be used when this parameter is absent).

Specified by:

bind in interface Store

Parameters:

point - The point.

canConfirm

public boolean canConfirm()

Asks if this store can confirm point values.

Specified by:

canConfirm in interface Store

Returns:

True if it can confirm point values.

close

public void close()

Closes the store.

May be called redundantly.

Specified by:

close in interface Store

compareTo

public final int compareTo(Store other)

Specified by:

compareTo in interface Comparable<Store>

confirm

public boolean confirm(PointValue pointValue,
                       boolean confirmValue)
                throws InterruptedException,
                       StoreAccessException

Confirms a point value.

Specified by:

confirm in interface Store

Parameters:

pointValue - The point value.

confirmValue - When true, PointValue.sameValueAs(org.rvpf.base.value.PointValue) should be called.

Returns:

True to confirm.

Throws:

InterruptedException - When interrupted.

StoreAccessException - On store access problem.

deliver

public StoreValues deliver(int limit,
                           long timeout)
                    throws InterruptedException,
                           StoreAccessException

Delivers subscribed point values from store update events.

A 'deliver' request is an alternative to a 'pull' request. Starting values are taken as the return of the 'subscribe' request; the follow up is then made with 'deliver' request.

Specified by:

deliver in interface Store

Parameters:

limit - A limit for the number of values.

timeout - A time limit in millis to wait for the first message (negative for infinite).

Returns:

The store values.

Throws:

InterruptedException - When the service is stopped.

StoreAccessException - On store access problem.

See Also:

Store.supportsDeliver()

getQueriesBatchLimit

public final int getQueriesBatchLimit()

Gets the queries batch limit.

Specified by:

getQueriesBatchLimit in interface Store

Returns:

The queries batch limit.

getResponseLimit

public final int getResponseLimit()

Gets the response limit.

Specified by:

getResponseLimit in interface Store

Returns:

The response limit.

getSubscribedValues

public Optional<StoreValues[]> getSubscribedValues()

Gets the values from the subscribed call.

Specified by:

getSubscribedValues in interface Store

Returns:

The optional values.

getUUID

public UUID getUUID()

Gest the store entity UUID.

Specified by:

getUUID in interface Store

Returns:

The store entity UUID.

getUpdateCount

public final int getUpdateCount()

Gets the update count.

Specified by:

getUpdateCount in interface Store

Returns:

The update count.

getUpdates

public final Collection<PointValue> getUpdates()

Gets the updates not yet sent.

Specified by:

getUpdates in interface Store

Returns:

The updates.

impersonate

public void impersonate(Optional<String> user)
                 throws StoreAccessException

Impersonates an other user.

Ends the current impersonation, if any, and begins a new one if the user argument is not empty.

Specified by:

impersonate in interface Store

Parameters:

user - The other user (empty string for anonymous, empty to cancel).

Throws:

StoreAccessException - On store access problem.

isNullRemoves

public boolean isNullRemoves()

Asks if a null value removes that value.

Specified by:

isNullRemoves in interface Store

Returns:

True if null removes.

iterate

public Iterable<PointValue> iterate(StoreValuesQuery query)

Iterates on the point values returned for a store query.

The iteration can extend beyond the store query limit.

Note: the returned iterable and its iterator are not thread safe.

Specified by:

iterate in interface Store

Parameters:

query - The store query.

Returns:

An iterable on store values.

pull

public StoreValues pull(StoreValuesQuery query,
                        long timeout)
                 throws InterruptedException,
                        StoreAccessException

Pulls points values.

This differs from a 'select' call by insisting for a 'pull' query and allowing a wait for a non empty response. Also, if there are subscribed points, the returned values will be restricted to those points.

A 'pull' query gets point values based on the time of their last update ('version') instead of the time associated with the value ('stamp').

Note: the filtering for subscribed point values may represent a significant overhead; when appropriate, 'deliver' could provide better performance.

Specified by:

pull in interface Store

Parameters:

query - The store query (must be a 'pull' query).

timeout - A time limit in millis to wait for the first value (negative for infinite).

Returns:

The points values.

Throws:

InterruptedException - When the service is stopped.

StoreAccessException - On store access problem.

See Also:

Store.select(StoreValuesQuery), Store.deliver(int, long), Store.supportsPull()

purge

public int purge(UUID[] pointUUIDs,
                 TimeInterval timeInterval)
          throws StoreAccessException

Purges point values.

Specified by:

purge in interface Store

Parameters:

pointUUIDs - The UUID of the points to purge.

timeInterval - A time interval.

Returns:

The number of point values purged.

Throws:

StoreAccessException - On store access problem.

See Also:

Store.supportsPurge()

sendUpdates

public final boolean sendUpdates()
                          throws StoreAccessException

Sends the pending updates.

Specified by:

sendUpdates in interface Store

Returns:

False when a warning has been logged.

Throws:

StoreAccessException - On store access problem.

setUp

public boolean setUp(Metadata metadata,
                     ProxyEntity proxyEntity)

Sets up the instance for action.

Specified by:

setUp in interface Proxied

Overrides:

setUp in class Proxied.Abstract

Parameters:

metadata - The metadata available to the current process.

proxyEntity - The proxy entity refering to the proxied.

Returns:

True on success.

subscribe

public boolean subscribe(Collection<UUID> points)
                  throws StoreAccessException

Subscribes to point values store update events.

This calls collects the last value for each point at the time of the subscription. These values will be available with a call to 'getSubscribedValues'.

Specified by:

subscribe in interface Store

Parameters:

points - The points.

Returns:

False when a warning has been logged.

Throws:

StoreAccessException - On store access problem.

See Also:

Store.deliver(int, long), Store.pull(StoreValuesQuery, long), Store.getSubscribedValues(), Store.supportsSubscribe()

subscribe

public boolean subscribe(UUID[] points)
                  throws StoreAccessException

Subscribes to point values store update events.

This calls collects the last value for each point at the time of the subscription. These values will be available with a call to 'getSubscribedValues'.

Specified by:

subscribe in interface Store

Parameters:

points - The points.

Returns:

False when a warning has been logged.

Throws:

StoreAccessException - On store access problem.

See Also:

Store.deliver(int, long), Store.pull(StoreValuesQuery, long), Store.getSubscribedValues(), Store.supportsSubscribe()

supportedValueTypes

public EnumSet<Externalizer.ValueType> supportedValueTypes()
                                                    throws StoreAccessException

Gets the value types supported by this store.

Specified by:

supportedValueTypes in interface Store

Returns:

The supported value types.

Throws:

StoreAccessException - On store access problem.

supportsCount

public boolean supportsCount()
                      throws StoreAccessException

Asks if this store supports count.

Specified by:

supportsCount in interface Store

Returns:

True if count is supported.

Throws:

StoreAccessException - On store access problem.

supportsDelete

public boolean supportsDelete()
                       throws StoreAccessException

Asks if this store supports delete.

Specified by:

supportsDelete in interface Store

Returns:

True if delete is supported.

Throws:

StoreAccessException - On store access problem.

supportsDeliver

public boolean supportsDeliver()
                        throws StoreAccessException

Asks if this store supports deliver.

Specified by:

supportsDeliver in interface Store

Returns:

True if deliver is supported.

Throws:

StoreAccessException - On store access problem.

supportsPull

public boolean supportsPull()
                     throws StoreAccessException

Asks if this store supports pull queries.

Specified by:

supportsPull in interface Store

Returns:

True if pull is supported.

Throws:

StoreAccessException - On store access problem.

supportsPurge

public boolean supportsPurge()
                      throws StoreAccessException

Asks if this store supports purge.

Specified by:

supportsPurge in interface Store

Returns:

True if purge is supported.

Throws:

StoreAccessException - On store access problem.

supportsSubscribe

public boolean supportsSubscribe()
                          throws StoreAccessException

Asks if this store supports subscribe.

Specified by:

supportsSubscribe in interface Store

Returns:

True if subscribe is supported.

Throws:

StoreAccessException - On store access problem.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface Proxied

Overrides:

tearDown in class Proxied.Abstract

unsubscribe

public boolean unsubscribe(UUID[] points)
                    throws StoreAccessException

Unsubscribes from points values events.

Specified by:

unsubscribe in interface Store

Parameters:

points - The points.

Returns:

False when a warning has been logged.

Throws:

StoreAccessException - On store access problem.

accessException

protected final StoreAccessException accessException(@Nonnull
                                                     SessionException cause)

Returns an access exception.

Parameters:

cause - The cause for this.

Returns:

An access exception.

bindPoints

protected final void bindPoints()
                         throws InterruptedException,
                                StoreAccessException

Binds points to their UUID.

Throws:

InterruptedException - When the service is stopped.

StoreAccessException - On store access problem.

bindPoints

protected void bindPoints(@Nonnull
                          Set<Point> points)
                   throws InterruptedException,
                          StoreAccessException

Binds points to their UUID.

Parameters:

points - The points.

Throws:

InterruptedException - When the service is stopped.

StoreAccessException - On store access problem.

doAddQuery

protected abstract void doAddQuery(@Nonnull
                                   StoreValuesQuery query)

Does add a store query for point values.

This provides the subclass specific implementation.

Parameters:

query - The store query.

getConfirmRetries

@CheckReturnValue
protected final int getConfirmRetries()

Gets the confirm retries.

Returns:

The confirm retries.

getConfirmRetryDelay

@CheckReturnValue
protected final long getConfirmRetryDelay()

Gets the confirm retry delay.

Returns:

The confirm retry delay.

getThisLogger

protected Logger getThisLogger()

Gets the logger.

Overrides:

getThisLogger in class Proxied.Abstract

Returns:

The logger.

reset

protected void reset()

Resets.

setConfirmRetries

protected final void setConfirmRetries()

Sets the confirm retries.

setQueriesBatchLimit

protected final void setQueriesBatchLimit(@Nonnull
                                          Config config)

Sets the queries batch limit.

Parameters:

config - The configuration.

setResponseLimit

protected final void setResponseLimit(@Nonnull
                                      Config config)

Sets the response limit.

Parameters:

config - The configuration.

supportedValueTypeCodes

@Nonnull
 @CheckReturnValue
protected abstract String supportedValueTypeCodes()
                                                                         throws StoreAccessException

Returns a string of supported value type codes.

Returns:

The string of supported value type codes.

Throws:

StoreAccessException - On store access problem.