org.rvpf.store.client

Class RMIStore

Object

Proxied.Abstract

AbstractStore

RMIStore

All Implemented Interfaces:

Comparable<Store>, SessionProxy.Listener, Store, Proxied

public final class RMIStore
extends AbstractStore
implements SessionProxy.Listener

RMI store client.

This class provides a client side access to an RMI Store.

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields inherited from class AbstractStore

QUERIES_BATCH_LIMIT_PROPERTY, RESPONSE_LIMIT_PROPERTY

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
RMIStore()

Method Summary

Modifier and Type	Method and Description
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.
boolean	confirm(PointValue pointValue, boolean confirmValue) Confirms a point value.
void	connect() Connects.
StoreValues	deliver(int limit, long timeout) Delivers subscribed point values from store update events.
protected void	doAddQuery(StoreValuesQuery query) Does add a store query for point values.
Optional<Exception[]>	getExceptions() Gets the exceptions.
Optional<StoreValues[]>	getSubscribedValues() Gets the values from the subscribed call.
void	impersonate(Optional<String> user) Impersonates an other user.
Iterable<PointValue>	iterate(StoreValuesQuery query) Iterates on the point values returned for a store query.
Optional<StoreValues>	nextValues() Returns the next store values to our store queries.
boolean	onSessionConnected(SessionProxy sessionProxy) Called when the session is connected.
void	onSessionDisconnected(SessionProxy sessionProxy) Called when the session is disconnected.
boolean	probe() Probes the state of the store session.
StoreValues	pull(StoreValuesQuery query, long timeout) Pulls points values.
int	purge(UUID[] pointUUIDs, TimeInterval timeInterval) Purges point values.
protected void	reset() Resets.
StoreValues	select(StoreValuesQuery query) Selects the store values for a store query.
boolean	sendUpdates(Collection<PointValue> updates) Sends updates.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.
boolean	subscribe(UUID[] points) Subscribes to point values store update events.
protected String	supportedValueTypeCodes() Returns a string of supported value type codes.
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	supportsSubscribe() Asks if this store supports subscribe.
boolean	unsubscribe(UUID[] points) Unsubscribes from points values events.

Methods inherited from class AbstractStore

accessException, addQuery, addUpdate, bind, bindPoints, compareTo, getConfirmRetries, getConfirmRetryDelay, getQueriesBatchLimit, getResponseLimit, getThisLogger, getUpdateCount, getUpdates, getUUID, isNullRemoves, sendUpdates, setConfirmRetries, setQueriesBatchLimit, setResponseLimit, subscribe, supportedValueTypes, supportsPurge, tearDown

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

getName, getParams

Constructor Detail

RMIStore

public RMIStore()

Method Detail

canConfirm

public boolean canConfirm()

Asks if this store can confirm point values.

Specified by:

canConfirm in interface Store

Overrides:

canConfirm in class AbstractStore

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

Overrides:

close in class AbstractStore

confirm

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

Confirms a point value.

Specified by:

confirm in interface Store

Overrides:

confirm in class AbstractStore

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.

connect

public void connect()
             throws StoreAccessException

Connects.

Specified by:

connect in interface Store

Throws:

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

Overrides:

deliver in class AbstractStore

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()

getExceptions

public Optional<Exception[]> getExceptions()

Gets the exceptions.

Specified by:

getExceptions in interface Store

Returns:

The optional exceptions (each null on success).

getSubscribedValues

public Optional<StoreValues[]> getSubscribedValues()

Gets the values from the subscribed call.

Specified by:

getSubscribedValues in interface Store

Overrides:

getSubscribedValues in class AbstractStore

Returns:

The optional values.

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

Overrides:

impersonate in class AbstractStore

Parameters:

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

Throws:

StoreAccessException - On store access problem.

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

Overrides:

iterate in class AbstractStore

Parameters:

query - The store query.

Returns:

An iterable on store values.

nextValues

public Optional<StoreValues> nextValues()
                                 throws InterruptedException,
                                        StoreAccessException

Returns the next store values to our store queries.

Any pending query is first sent.

Specified by:

nextValues in interface Store

Returns:

The next store values or empty when done.

Throws:

InterruptedException - When the service is stopped.

StoreAccessException - On store access problem.

onSessionConnected

public boolean onSessionConnected(SessionProxy sessionProxy)

Called when the session is connected.

Specified by:

onSessionConnected in interface SessionProxy.Listener

Parameters:

sessionProxy - The session proxy.

Returns:

True to accept the connection.

onSessionDisconnected

public void onSessionDisconnected(SessionProxy sessionProxy)

Called when the session is disconnected.

Specified by:

onSessionDisconnected in interface SessionProxy.Listener

Parameters:

sessionProxy - The session proxy.

probe

public boolean probe()
              throws StoreAccessException

Probes the state of the store session.

Specified by:

probe in interface Store

Returns:

True when everything is fine.

Throws:

StoreAccessException - On store access problem.

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

Overrides:

pull in class AbstractStore

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

Overrides:

purge in class AbstractStore

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()

select

public StoreValues select(StoreValuesQuery query)
                   throws InterruptedException,
                          StoreAccessException

Selects the store values for a store query.

The processing of the query must not interfere with the batch operation mode.

Specified by:

select in interface Store

Parameters:

query - The store query.

Returns:

The store values.

Throws:

InterruptedException - When the service is stopped.

StoreAccessException - On store access problem.

sendUpdates

public boolean sendUpdates(Collection<PointValue> updates)
                    throws StoreAccessException

Sends updates.

Specified by:

sendUpdates in interface Store

Parameters:

updates - The updates to send.

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 AbstractStore

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(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

Overrides:

subscribe in class AbstractStore

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()

supportsCount

public boolean supportsCount()
                      throws StoreAccessException

Asks if this store supports count.

Specified by:

supportsCount in interface Store

Overrides:

supportsCount in class AbstractStore

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

Overrides:

supportsDelete in class AbstractStore

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

Overrides:

supportsDeliver in class AbstractStore

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

Overrides:

supportsPull in class AbstractStore

Returns:

True if pull 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

Overrides:

supportsSubscribe in class AbstractStore

Returns:

True if subscribe is supported.

Throws:

StoreAccessException - On store access problem.

unsubscribe

public boolean unsubscribe(UUID[] points)
                    throws StoreAccessException

Unsubscribes from points values events.

Specified by:

unsubscribe in interface Store

Overrides:

unsubscribe in class AbstractStore

Parameters:

points - The points.

Returns:

False when a warning has been logged.

Throws:

StoreAccessException - On store access problem.

bindPoints

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

Binds points to their UUID.

Overrides:

bindPoints in class AbstractStore

Parameters:

points - The points.

Throws:

InterruptedException - When the service is stopped.

StoreAccessException - On store access problem.

doAddQuery

protected void doAddQuery(StoreValuesQuery query)

Does add a store query for point values.

This provides the subclass specific implementation.

Specified by:

doAddQuery in class AbstractStore

Parameters:

query - The store query.

reset

protected void reset()

Resets.

Overrides:

reset in class AbstractStore

supportedValueTypeCodes

protected String supportedValueTypeCodes()
                                  throws StoreAccessException

Returns a string of supported value type codes.

Specified by:

supportedValueTypeCodes in class AbstractStore

Returns:

The string of supported value type codes.

Throws:

StoreAccessException - On store access problem.