org.rvpf.base.store

Class StoreSessionProxy

Object

SessionProxy

StoreSessionProxy

All Implemented Interfaces:

Remote, Session, StoreSession

@ThreadSafe
public final class StoreSessionProxy
extends SessionProxy
implements StoreSession

Store server session proxy.

Simplifies the access to a store session.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StoreSessionProxy.Builder Builder.
class	StoreSessionProxy.ValuesIterator Values iterator.

Nested classes/interfaces inherited from class SessionProxy

SessionProxy.Listener, SessionProxy.SessionConnectVetoException

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Method Summary

Modifier and Type	Method and Description
protected Session	createSession() Creates a session.
StoreValues	deliver(int limit, long timeout) Delivers point value events.
Optional<Exception>	getException() Get the exception.
Optional<Exception[]>	getExceptions() Gets the exceptions.
Optional<List<PointBinding>>	getPointBindings(Collection<PointBinding.Request> bindingRequests) Gets point binding informations on selected points.
Optional<PointBinding[]>	getPointBindings(PointBinding.Request bindingRequest) Gets point binding informations on selected points.
PointBinding[]	getPointBindings(PointBinding.Request[] bindingRequests) Gets point binding informations on selected points.
Optional<StoreValues>	getResponse() Gets the response.
Optional<StoreValues[]>	getResponses() Gets the responses.
Optional<State.Group>	getStateGroup(Optional<String> name) Gets a state group by its name.
State.Group[]	getStateGroups() Gets the state groups.
void	impersonate(String user) Impersonates an other user.
void	interrupt() Interrupts the current delivery.
Iterable<PointValue>	iterate(StoreValuesQuery storeQuery, Optional<Points> points) Iterates on the point values returned for a store query.
static StoreSessionProxy.Builder	newBuilder() Returns a new builder.
boolean	probe() Probes the state of a session.
StoreValues	pull(StoreValuesQuery query, long timeout) Pulls points values.
int	purge(UUID[] pointUUIDs, TimeInterval timeInterval) Purges point values.
int	purge(UUID pointUUID, TimeInterval timeInterval) Purges point values.
State	resolve(State state) Resolves a global state.
State	resolve(State state, Point point) Resolves a state for a point.
State	resolve(State state, UUID pointUUID) Resolves a state for a point.
List<StoreValues>	select(Collection<StoreValuesQuery> queries) Selects point values.
Optional<StoreValues>	select(StoreValuesQuery storeQuery) Selects point values.
StoreValues[]	select(StoreValuesQuery[] queries) Selects point values.
List<StoreValues>	subscribe(Collection<UUID> pointUUIDs) Subscribes to point values events.
Optional<StoreValues>	subscribe(UUID pointUUID) Subscribes to a point values events.
StoreValues[]	subscribe(UUID[] pointUUIDs) Subscribes to point values events.
boolean	subscribeAndCheck(Collection<UUID> pointUUIDs, Logger logger) Subscribes to point values events and check the responses.
boolean	subscribeAndCheck(UUID[] pointUUIDs, Logger logger) Subscribes to point values events and check the responses.
boolean	subscribeAndCheck(UUID pointUUID, Logger logger) Subscribes to point value events and check the response.
String	supportedValueTypeCodes() Returns a string of supported value type codes.
EnumSet<Externalizer.ValueType>	supportedValueTypes() Returns the set of supported value types.
boolean	supportsCount() Asks if the server supports count.
boolean	supportsDelete() Asks if the server supports delete.
boolean	supportsDeliver() Asks if the server supports deliver.
boolean	supportsPull() Asks if the server supports pull.
boolean	supportsPurge() Asks if the server supports purge.
boolean	supportsSubscribe() Asks if the server supports subscribe.
List<Exception>	unsubscribe(Collection<UUID> pointUUIDs) Unsubscribes from point values events.
Exception	unsubscribe(UUID pointUUID) Usubscribes from a point values events.
Exception[]	unsubscribe(UUID[] pointUUIDs) Unsubscribes from point values events.
boolean	unsubscribeAndCheck(Collection<UUID> pointUUIDs, Logger logger) Subscribes to point values events and check the responses.
boolean	unsubscribeAndCheck(UUID[] pointUUIDs, Logger logger) Subscribes to point values events and check the responses.
boolean	unsubscribeAndCheck(UUID pointUUID, Logger logger) Subscribes to point value events and check the response.
List<Exception>	update(Collection<PointValue> pointValues) Updates point values.
Optional<Exception>	update(PointValue pointValue) Updates a point value.
Exception[]	update(PointValue[] pointValues) Updates point values.
boolean	updateAndCheck(Collection<PointValue> pointValues, Logger logger) Updates point values and check the responses.
boolean	updateAndCheck(PointValue[] pointValues, Logger logger) Updates point values and check the responses.
boolean	updateAndCheck(PointValue pointValue, Logger logger) Updates a point value and check the response.

Methods inherited from class SessionProxy

connect, disconnect, getClientName, getConnectionMode, getContext, getContextUUID, getFactory, getServerName, getServerURI, getSession, getThisLogger, hasLoginInfo, isConnected, isPrivate, isRemote, lockConnect, lockConnectInterruptibly, login, logout, sessionException, sessionMode, tearDown, unlockConnect

Methods inherited from class Object

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

Methods inherited from interface Session

getConnectionMode, login, logout

Method Detail

newBuilder

@Nonnull
 @CheckReturnValue
public static StoreSessionProxy.Builder newBuilder()

Returns a new builder.

Returns:

The new builder.

deliver

public StoreValues deliver(int limit,
                           long timeout)
                    throws SessionException

Delivers point value events.

Specified by:

deliver in interface StoreSession

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 point values (empty on timeout, null on service closed).

Throws:

SessionException - From session security check.

See Also:

Store.deliver(int, long)

getException

@Nonnull
 @CheckReturnValue
public Optional<Exception> getException()

Get the exception.

Returns:

The optional exception.

getExceptions

@Nonnull
 @CheckReturnValue
public Optional<Exception[]> getExceptions()

Gets the exceptions.

Returns:

The exceptions (each null on success).

getPointBindings

@Nonnull
 @CheckReturnValue
public Optional<List<PointBinding>> getPointBindings(@Nonnull
                                                                                   Collection<PointBinding.Request> bindingRequests)
                                                                            throws SessionException

Gets point binding informations on selected points.

Parameters:

bindingRequests - Selection specifications.

Returns:

The point bindings informations (empty on service closed).

Throws:

SessionException - From session security check.

getPointBindings

@Nonnull
 @CheckReturnValue
public Optional<PointBinding[]> getPointBindings(@Nonnull
                                                                               PointBinding.Request bindingRequest)
                                                                        throws SessionException

Gets point binding informations on selected points.

Parameters:

bindingRequest - Selection specifications.

Returns:

The point bindings informations (empty on service closed).

Throws:

SessionException - From session security check.

getPointBindings

public PointBinding[] getPointBindings(PointBinding.Request[] bindingRequests)
                                throws SessionException

Gets point binding informations on selected points.

Specified by:

getPointBindings in interface StoreSession

Parameters:

bindingRequests - Selection specifications.

Returns:

The point bindings informations (null on service closed).

Throws:

SessionException - From session security check.

getResponse

@Nonnull
 @CheckReturnValue
public Optional<StoreValues> getResponse()

Gets the response.

Returns:

The response (may be empty).

getResponses

@Nonnull
 @CheckReturnValue
public Optional<StoreValues[]> getResponses()

Gets the responses.

Returns:

The responses (may be empty).

getStateGroup

@Nonnull
 @CheckReturnValue
public Optional<State.Group> getStateGroup(@Nonnull
                                                                         Optional<String> name)
                                                                  throws SessionException

Gets a state group by its name.

Parameters:

name - The group name (empty for anonymous).

Returns:

The state group (empty if absent).

Throws:

SessionException - From session security check.

getStateGroups

public State.Group[] getStateGroups()
                             throws SessionException

Gets the state groups.

Specified by:

getStateGroups in interface StoreSession

Returns:

The state groups (null on service closed).

Throws:

SessionException - From session security check.

impersonate

public void impersonate(String user)
                 throws SessionException

Impersonates an other user.

Specified by:

impersonate in interface StoreSession

Parameters:

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

Throws:

SessionException - From session security check.

interrupt

public void interrupt()
               throws SessionException

Interrupts the current delivery.

Specified by:

interrupt in interface StoreSession

Throws:

SessionException - From session security check.

iterate

@Nonnull
 @CheckReturnValue
public Iterable<PointValue> iterate(@Nonnull
                                                                  StoreValuesQuery storeQuery,
                                                                  @Nonnull
                                                                  Optional<Points> points)

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.

Parameters:

storeQuery - The store query.

points - Points metadata.

Returns:

An iterable on store values.

probe

public boolean probe()
              throws SessionException

Probes the state of a session.

Specified by:

probe in interface StoreSession

Returns:

True when everything is fine.

Throws:

SessionException - On session problems.

pull

public StoreValues pull(StoreValuesQuery query,
                        long timeout)
                 throws SessionException

Pulls points values.

Specified by:

pull in interface StoreSession

Parameters:

query - The store query.

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

Returns:

The point values (empty on timeout, null on service closed).

Throws:

SessionException

See Also:

Store.pull(StoreValuesQuery, long)

purge

@CheckReturnValue
public int purge(@Nonnull
                                    UUID pointUUID,
                                    @Nonnull
                                    TimeInterval timeInterval)
                             throws SessionException

Purges point values.

Parameters:

pointUUID - The point to purge.

timeInterval - A time interval.

Returns:

The number of point values purged.

Throws:

SessionException - On session exception.

See Also:

Store.purge(UUID[], TimeInterval)

purge

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

Purges point values.

Specified by:

purge in interface StoreSession

Parameters:

pointUUIDs - The UUID of the points to purge.

timeInterval - A time interval.

Returns:

The number of point values purged.

Throws:

SessionException - From session security check.

See Also:

Store.purge(UUID[], TimeInterval)

resolve

@Nullable
 @CheckReturnValue
public State resolve(@Nonnull
                                                    State state)
                                             throws SessionException

Resolves a global state.

Parameters:

state - The state.

Returns:

The resolved state.

Throws:

SessionException - From session security check.

resolve

@Nullable
 @CheckReturnValue
public State resolve(@Nonnull
                                                    State state,
                                                    @Nullable
                                                    Point point)
                                             throws SessionException

Resolves a state for a point.

Parameters:

state - The state.

point - The optional point.

Returns:

The resolved state.

Throws:

SessionException - From session security check.

resolve

public State resolve(State state,
                     UUID pointUUID)
              throws SessionException

Resolves a state for a point.

Specified by:

resolve in interface StoreSession

Parameters:

state - The state.

pointUUID - The optional point UUID.

Returns:

The resolved state.

Throws:

SessionException - From session security check.

select

@Nullable
 @CheckReturnValue
public List<StoreValues> select(@Nonnull
                                                               Collection<StoreValuesQuery> queries)
                                                        throws SessionException

Selects point values.

Parameters:

queries - The store queries.

Returns:

A list of store values (null on service closed).

Throws:

SessionException - On session exception.

select

@Nonnull
 @CheckReturnValue
public Optional<StoreValues> select(@Nonnull
                                                                  StoreValuesQuery storeQuery)
                                                           throws SessionException

Selects point values.

Parameters:

storeQuery - A store query.

Returns:

Store values (empty on service closed).

Throws:

SessionException - From session security check.

select

public StoreValues[] select(StoreValuesQuery[] queries)
                     throws SessionException

Selects point values.

Specified by:

select in interface StoreSession

Parameters:

queries - An array of store queries.

Returns:

An array of store values (null on service closed).

Throws:

SessionException - On session exception.

subscribe

@Nullable
 @CheckReturnValue
public List<StoreValues> subscribe(@Nonnull
                                                                  Collection<UUID> pointUUIDs)
                                                           throws SessionException

Subscribes to point values events.

Parameters:

pointUUIDs - The point UUIDs.

Returns:

The last store value for each point (null on service closed).

Throws:

SessionException - From session security check.

subscribe

@Nonnull
 @CheckReturnValue
public Optional<StoreValues> subscribe(@Nullable
                                                                     UUID pointUUID)
                                                              throws SessionException

Subscribes to a point values events.

Parameters:

pointUUID - The point UUID.

Returns:

The last store value for the point (empty on service closed).

Throws:

SessionException - From session security check.

subscribe

public StoreValues[] subscribe(UUID[] pointUUIDs)
                        throws SessionException

Subscribes to point values events.

Specified by:

subscribe in interface StoreSession

Parameters:

pointUUIDs - The point UUIDs.

Returns:

The last store value for each point (null on service closed).

Throws:

SessionException - From session security check.

subscribeAndCheck

@CheckReturnValue
public boolean subscribeAndCheck(@Nonnull
                                                    Collection<UUID> pointUUIDs,
                                                    @Nonnull
                                                    Logger logger)
                                             throws SessionException

Subscribes to point values events and check the responses.

Parameters:

pointUUIDs - The point UUIDs.

logger - A logger.

Returns:

False when a warning has been logged.

Throws:

SessionException - From session security check.

subscribeAndCheck

@CheckReturnValue
public boolean subscribeAndCheck(@Nonnull
                                                    UUID pointUUID,
                                                    @Nonnull
                                                    Logger logger)
                                             throws SessionException

Subscribes to point value events and check the response.

Parameters:

pointUUID - The point UUID.

logger - A logger.

Returns:

False when a warning has been logged.

Throws:

SessionException - On session exception.

subscribeAndCheck

@CheckReturnValue
public boolean subscribeAndCheck(@Nonnull
                                                    UUID[] pointUUIDs,
                                                    @Nonnull
                                                    Logger logger)
                                             throws SessionException

Subscribes to point values events and check the responses.

Parameters:

pointUUIDs - The point UUIDs.

logger - A logger.

Returns:

False when a warning has been logged.

Throws:

SessionException - From session security check.

supportedValueTypeCodes

public String supportedValueTypeCodes()
                               throws SessionException

Returns a string of supported value type codes.

Specified by:

supportedValueTypeCodes in interface StoreSession

Returns:

The string of supported value type codes.

Throws:

SessionException

supportedValueTypes

@Nonnull
 @CheckReturnValue
public EnumSet<Externalizer.ValueType> supportedValueTypes()
                                                                                  throws SessionException

Returns the set of supported value types.

Returns:

The set of supported value types.

Throws:

SessionException - From session security check.

supportsCount

public boolean supportsCount()
                      throws SessionException

Asks if the server supports count.

Specified by:

supportsCount in interface StoreSession

Returns:

True if count is supported.

Throws:

SessionException - From session security check.

supportsDelete

public boolean supportsDelete()
                       throws SessionException

Asks if the server supports delete.

Specified by:

supportsDelete in interface StoreSession

Returns:

True if delete is supported.

Throws:

SessionException - From session security check.

supportsDeliver

public boolean supportsDeliver()
                        throws SessionException

Asks if the server supports deliver.

Specified by:

supportsDeliver in interface StoreSession

Returns:

True if deliver is supported.

Throws:

SessionException - From session security check.

supportsPull

public boolean supportsPull()
                     throws SessionException

Asks if the server supports pull.

Specified by:

supportsPull in interface StoreSession

Returns:

True if pull is supported.

Throws:

SessionException - From session security check.

supportsPurge

public boolean supportsPurge()
                      throws SessionException

Asks if the server supports purge.

Specified by:

supportsPurge in interface StoreSession

Returns:

True if purge is supported.

Throws:

SessionException - From session security check.

supportsSubscribe

public boolean supportsSubscribe()
                          throws SessionException

Asks if the server supports subscribe.

Specified by:

supportsSubscribe in interface StoreSession

Returns:

True if subscribe is supported.

Throws:

SessionException - From session security check.

unsubscribe

@Nullable
 @CheckReturnValue
public List<Exception> unsubscribe(@Nonnull
                                                                  Collection<UUID> pointUUIDs)
                                                           throws SessionException

Unsubscribes from point values events.

Parameters:

pointUUIDs - The point UUIDs.

Returns:

An exception list (null on service closed, each null on success).

Throws:

SessionException - From session security check.

unsubscribe

@Nullable
 @CheckReturnValue
public Exception unsubscribe(@Nonnull
                                                            UUID pointUUID)
                                                     throws SessionException

Usubscribes from a point values events.

Parameters:

pointUUID - The point.

Returns:

An exception (null on success).

Throws:

SessionException - From session security check.

unsubscribe

public Exception[] unsubscribe(UUID[] pointUUIDs)
                        throws SessionException

Unsubscribes from point values events.

Specified by:

unsubscribe in interface StoreSession

Parameters:

pointUUIDs - The point UUIDs.

Returns:

An exception array (null on service closed, each null on success).

Throws:

SessionException - From session security check.

unsubscribeAndCheck

@CheckReturnValue
public boolean unsubscribeAndCheck(@Nonnull
                                                      Collection<UUID> pointUUIDs,
                                                      @Nonnull
                                                      Logger logger)
                                               throws SessionException

Subscribes to point values events and check the responses.

Parameters:

pointUUIDs - The point UUIDs.

logger - A logger.

Returns:

False when a warning has been logged.

Throws:

SessionException - From session security check.

unsubscribeAndCheck

@CheckReturnValue
public boolean unsubscribeAndCheck(@Nonnull
                                                      UUID pointUUID,
                                                      @Nonnull
                                                      Logger logger)
                                               throws SessionException

Subscribes to point value events and check the response.

Parameters:

pointUUID - The point UUID.

logger - A logger.

Returns:

False when a warning has been logged.

Throws:

SessionException - On session exception.

unsubscribeAndCheck

@CheckReturnValue
public boolean unsubscribeAndCheck(@Nonnull
                                                      UUID[] pointUUIDs,
                                                      @Nonnull
                                                      Logger logger)
                                               throws SessionException

Subscribes to point values events and check the responses.

Parameters:

pointUUIDs - The point UUIDs.

logger - A logger.

Returns:

False when a warning has been logged.

Throws:

SessionException - From session security check.

update

@Nullable
 @CheckReturnValue
public List<Exception> update(@Nonnull
                                                             Collection<PointValue> pointValues)
                                                      throws SessionException

Updates point values.

Parameters:

pointValues - The point values.

Returns:

An exception list (null on service closed, each null on success).

Throws:

SessionException - On session exception.

update

@Nonnull
 @CheckReturnValue
public Optional<Exception> update(@Nonnull
                                                                PointValue pointValue)
                                                         throws SessionException

Updates a point value.

Parameters:

pointValue - The point value.

Returns:

An optional exception.

Throws:

SessionException - On session exception.

update

public Exception[] update(PointValue[] pointValues)
                   throws SessionException

Updates point values.

Specified by:

update in interface StoreSession

Parameters:

pointValues - The point values.

Returns:

An exception array (null on service closed, each null on success).

Throws:

SessionException

updateAndCheck

@CheckReturnValue
public boolean updateAndCheck(@Nonnull
                                                 Collection<PointValue> pointValues,
                                                 @Nonnull
                                                 Logger logger)
                                          throws SessionException

Updates point values and check the responses.

Parameters:

pointValues - The point values.

logger - A logger.

Returns:

False when a warning has been logged.

Throws:

SessionException - On session exception.

updateAndCheck

@CheckReturnValue
public boolean updateAndCheck(PointValue pointValue,
                                                 Logger logger)
                                          throws SessionException

Updates a point value and check the response.

Parameters:

pointValue - The point value.

logger - A logger.

Returns:

False when a warning has been logged.

Throws:

SessionException - On session exception.

updateAndCheck

@CheckReturnValue
public boolean updateAndCheck(@Nonnull
                                                 PointValue[] pointValues,
                                                 @Nonnull
                                                 Logger logger)
                                          throws SessionException

Updates point values and check the responses.

Parameters:

pointValues - The point values.

logger - A logger.

Returns:

False when a warning has been logged.

Throws:

SessionException - On session exception.

createSession

protected Session createSession()
                         throws RemoteException,
                                SessionException

Creates a session.

Specified by:

createSession in class SessionProxy

Returns:

The session.

Throws:

RemoteException - From RMI.

SessionException - When session creation fails.