org.rvpf.store.server.rmi

Class StoreSessionImpl

Object

SessionImpl

ExportedSessionImpl

StoreSessionImpl

All Implemented Interfaces:

Remote, Unreferenced, Session, StoreSession, NoticeListener

public final class StoreSessionImpl
extends ExportedSessionImpl
implements StoreSession, NoticeListener

Store RMI session implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface Session

Session.ConnectionMode

Method Summary

Modifier and Type	Method and Description
void	close() Closes the session.
void	commit() Commits the pending notices.
StoreValues	deliver(int limit, long timeout) Delivers point value events.
protected void	finalize()
PointBinding[]	getPointBindings(PointBinding.Request[] bindingRequests) Gets point binding informations on selected points.
State.Group[]	getStateGroups() Gets the state groups.
protected Optional<String>	getUser() Gets the user.
void	impersonate(String user) Impersonates an other user.
void	interrupt() Interrupts the current delivery.
boolean	interrupted() Asks if this session has been interrupted.
void	notify(PointValue pointValue) Notifies of a new Point value.
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.
protected void	setUser(Optional<String> user) Sets the user.
boolean	sleep(long millis) Sleeps for the specified number of milliseconds.
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[] updates) Updates point values.
void	wakeUp() Wakes up.

Methods inherited from class ExportedSessionImpl

equals, hashCode, open

Methods inherited from class SessionImpl

getClientName, getConnectionMode, getIdentity, getSessionFactory, getThisLogger, isClosed, login, logout, open, securityCheck, setLogID, toString, unreferenced

Methods inherited from class Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Session

getConnectionMode, login, logout

Method Detail

close

public void close()

Closes the session.

Overrides:

close in class ExportedSessionImpl

commit

public void commit()
            throws InterruptedException

Commits the pending notices.

Specified by:

commit in interface NoticeListener

Throws:

InterruptedException - When the Service is stopped.

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)

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.

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

Interrupts the current delivery.

Specified by:

interrupt in interface StoreSession

interrupted

public boolean interrupted()

Asks if this session has been interrupted. Also clears the condition.

Returns:

True if interrupted.

notify

public void notify(PointValue pointValue)
            throws InterruptedException

Notifies of a new Point value.

Specified by:

notify in interface NoticeListener

Parameters:

pointValue - The Point value.

Throws:

InterruptedException - When the Service is stopped.

probe

public boolean probe()
              throws RemoteException,
                     SessionException

Probes the state of a session.

Specified by:

probe in interface StoreSession

Returns:

True when everything is fine.

Throws:

RemoteException - From RMI RunTime.

SessionException - On session problems.

pull

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

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:

ServiceNotAvailableException - When the service is not available.

See Also:

Store.pull(StoreValuesQuery, long)

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

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

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.

sleep

public boolean sleep(long millis)

Sleeps for the specified number of milliseconds.

Parameters:

millis - The number of milliseconds.

Returns:

True unless awaken or interrupted.

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.

supportedValueTypeCodes

public String supportedValueTypeCodes()
                               throws ServiceNotAvailableException

Returns a string of supported value type codes.

Specified by:

supportedValueTypeCodes in interface StoreSession

Returns:

The string of supported value type codes.

Throws:

ServiceNotAvailableException - When the service is not available.

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 RemoteException,
                             SessionException

Asks if the server supports purge.

Specified by:

supportsPurge in interface StoreSession

Returns:

True if purge is supported.

Throws:

RemoteException - From RMI RunTime.

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

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.

update

public Exception[] update(PointValue[] updates)
                   throws ServiceNotAvailableException

Updates point values.

Specified by:

update in interface StoreSession

Parameters:

updates - The point values.

Returns:

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

Throws:

ServiceNotAvailableException - When the service is not available.

wakeUp

public void wakeUp()

Wakes up.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getUser

protected Optional<String> getUser()

Gets the user.

Overrides:

getUser in class SessionImpl

Returns:

The user.

setUser

protected void setUser(Optional<String> user)

Sets the user.

Overrides:

setUser in class SessionImpl

Parameters:

user - The optional user identifier.