org.rvpf.base.store

Interface StoreSession

All Superinterfaces:

Remote, Session

All Known Implementing Classes:

StoreSessionImpl, StoreSessionProxy

public interface StoreSession
extends Session

Store server session interface.

Specifies the remote interaction with the store server.

Nested Class Summary

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Method Summary

Modifier and Type	Method and Description
StoreValues	deliver(int limit, long timeout) Delivers point value events.
PointBinding[]	getPointBindings(PointBinding.Request[] bindingRequests) Gets point binding informations on selected points.
State.Group[]	getStateGroups() Gets the state groups.
void	impersonate(String user) Impersonates an other user.
void	interrupt() Interrupts the current delivery.
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.
State	resolve(State state, UUID pointUUID) Resolves a state for a point.
StoreValues[]	select(StoreValuesQuery[] queries) Selects point values.
StoreValues[]	subscribe(UUID[] pointUUIDs) Subscribes to point values events.
String	supportedValueTypeCodes() Returns a string of supported value type codes.
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.
Exception[]	unsubscribe(UUID[] pointUUIDs) Unsubscribes from point values events.
Exception[]	update(PointValue[] pointValues) Updates point values.

Methods inherited from interface Session

getConnectionMode, login, logout

Method Detail

deliver

@Nullable
 @CheckReturnValue
StoreValues deliver(int limit,
                                                   long timeout)
                                            throws RemoteException,
                                                   SessionException

Delivers point value events.

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.

RemoteException - From RMI RunTime.

See Also:

Store.deliver(int, long)

getPointBindings

@Nullable
 @CheckReturnValue
PointBinding[] getPointBindings(@Nonnull
                                                               PointBinding.Request[] bindingRequests)
                                                        throws RemoteException,
                                                               SessionException

Gets point binding informations on selected points.

Parameters:

bindingRequests - Selection specifications.

Returns:

The point bindings informations (null on service closed).

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

getStateGroups

@Nullable
 @CheckReturnValue
State.Group[] getStateGroups()
                                                     throws RemoteException,
                                                            SessionException

Gets the state groups.

Returns:

The state groups (null on service closed).

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

impersonate

void impersonate(@Nullable
                 String user)
          throws RemoteException,
                 SessionException

Impersonates an other user.

Parameters:

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

Throws:

RemoteException - From RMI RunTime.

SessionException - From session security check.

interrupt

void interrupt()
        throws RemoteException,
               SessionException

Interrupts the current delivery.

Throws:

RemoteException - From RMI RunTime.

SessionException - From session security check.

probe

@CheckReturnValue
boolean probe()
                          throws RemoteException,
                                 SessionException

Probes the state of a session.

Returns:

True when everything is fine.

Throws:

SessionException - On session problems.

RemoteException - From RMI RunTime.

pull

@Nullable
 @CheckReturnValue
StoreValues pull(@Nonnull
                                                StoreValuesQuery query,
                                                long timeout)
                                         throws RemoteException,
                                                ServiceNotAvailableException

Pulls points values.

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:

ServiceNotAvailableException - When the service is not available.

RemoteException - From RMI RunTime.

See Also:

Store.pull(StoreValuesQuery, long)

purge

@CheckReturnValue
int purge(@Nonnull
                             UUID[] pointUUIDs,
                             @Nonnull
                             TimeInterval timeInterval)
                      throws RemoteException,
                             SessionException

Purges point values.

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.

RemoteException - From RMI RunTime.

See Also:

Store.purge(UUID[], TimeInterval)

resolve

@Nullable
 @CheckReturnValue
State resolve(@Nonnull
                                             State state,
                                             @Nullable
                                             UUID pointUUID)
                                      throws RemoteException,
                                             SessionException

Resolves a state for a point.

Parameters:

state - The state.

pointUUID - The optional point UUID.

Returns:

The resolved state.

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

select

@Nullable
 @CheckReturnValue
StoreValues[] select(@Nonnull
                                                    StoreValuesQuery[] queries)
                                             throws RemoteException,
                                                    SessionException

Selects point values.

Parameters:

queries - An array of store queries.

Returns:

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

Throws:

SessionException - On session exception.

RemoteException - From RMI RunTime.

subscribe

@Nullable
 @CheckReturnValue
StoreValues[] subscribe(@Nonnull
                                                       UUID[] pointUUIDs)
                                                throws RemoteException,
                                                       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.

RemoteException - From RMI RunTime.

supportedValueTypeCodes

@Nonnull
 @CheckReturnValue
String supportedValueTypeCodes()
                                                      throws RemoteException,
                                                             ServiceNotAvailableException

Returns a string of supported value type codes.

Returns:

The string of supported value type codes.

Throws:

ServiceNotAvailableException - When the service is not available.

RemoteException - From RMI RunTime.

supportsCount

@CheckReturnValue
boolean supportsCount()
                                  throws RemoteException,
                                         SessionException

Asks if the server supports count.

Returns:

True if count is supported.

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

supportsDelete

@CheckReturnValue
boolean supportsDelete()
                                   throws RemoteException,
                                          SessionException

Asks if the server supports delete.

Returns:

True if delete is supported.

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

supportsDeliver

@CheckReturnValue
boolean supportsDeliver()
                                    throws RemoteException,
                                           SessionException

Asks if the server supports deliver.

Returns:

True if deliver is supported.

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

supportsPull

@CheckReturnValue
boolean supportsPull()
                                 throws RemoteException,
                                        SessionException

Asks if the server supports pull.

Returns:

True if pull is supported.

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

supportsPurge

@CheckReturnValue
boolean supportsPurge()
                                  throws RemoteException,
                                         SessionException

Asks if the server supports purge.

Returns:

True if purge is supported.

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

supportsSubscribe

@CheckReturnValue
boolean supportsSubscribe()
                                      throws RemoteException,
                                             SessionException

Asks if the server supports subscribe.

Returns:

True if subscribe is supported.

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

unsubscribe

@Nullable
 @CheckReturnValue
Exception[] unsubscribe(@Nonnull
                                                       UUID[] pointUUIDs)
                                                throws RemoteException,
                                                       SessionException

Unsubscribes from point values events.

Parameters:

pointUUIDs - The point UUIDs.

Returns:

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

Throws:

SessionException - From session security check.

RemoteException - From RMI RunTime.

update

@Nullable
 @CheckReturnValue
Exception[] update(@Nonnull
                                                  PointValue[] pointValues)
                                           throws RemoteException,
                                                  ServiceNotAvailableException

Updates point values.

Parameters:

pointValues - The point values.

Returns:

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

Throws:

ServiceNotAvailableException - When the service is not available.

RemoteException - From RMI RunTime.