org.rvpf.store.server

Class StoreServer.Abstract

Object

StoreServer.Abstract

All Implemented Interfaces:

StoreServer

Enclosing interface:

StoreServer

public abstract static class StoreServer.Abstract
extends Object
implements StoreServer

Abstract store server.

Nested Class Summary

Nested classes/interfaces inherited from interface StoreServer

StoreServer.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static ElapsedTime	DEFAULT_PULL_SLEEP Default pull sleep.
static String	DELETED_TRACES Traces subdirectory for deleted values.
static String	NAME_PROPERTY Name property.
static String	PULL_SLEEP_PROPERTY Pull sleep property.
static String	STATE_PROPERTY State definition property.
static String	STATES_PROPERTY States reference property.
static String	UPDATED_TRACES Traces subdirectory for updated values.

Constructor Summary

Constructors

Constructor and Description
Abstract()

Method Summary

Modifier and Type	Method and Description
protected void	activateServiceClassLoader() Activates the service class loader.
void	addBinding(PointBinding binding) Adds a binding.
void	addNotice(PointValue notice) Adds a notice.
void	addNoticeListener(NoticeListener noticeListener) Adds a notice listener.
PointBinding[]	bind(PointBinding.Request[] bindRequests) Binds point names to their UUID.
protected boolean	checkPurge(UUID[] pointUUIDs, Optional<Identity> identity) Checks if a purge on point values is allowed for the identity.
protected Optional<Exception>	checkUpdate(PointValue pointValue, Optional<Identity> identity) Checks if an update on a point's values is allowed for the identity.
void	disableSuspend() Disables suspend.
void	enableSuspend() Enables suspend.
protected void	enterUpdates() Enters updates.
protected Optional<Archiver>	getArchiver() Gets the archiver.
int	getBackEndLimit() Gets the back-end limit.
Optional<PointBinding>	getBinding(String name) Gets a point binding by name.
protected Traces	getDeletedTraces() Gets the 'deleted' traces.
Metadata	getMetadata() Gets the metadata.
protected Polator	getPolator(Point point) Gets the polator for a point.
Replicator	getReplicator() Gets the replicator.
int	getResponseLimit() Gets the response limit.
Collection<State.Group>	getStateGroups() Gets the state groups.
StoreStats	getStats() Gets the store stats.
protected Logger	getThisLogger() Gets the logger.
protected Traces	getUpdatedTraces() Gets the 'updated' traces.
boolean	isMemory() Asks if this is a memory store.
protected boolean	isStarted() Asks if started.
protected boolean	isStopped() Asks if stopped.
protected void	leaveUpdates() Leaves updates.
protected void	lock() Locks.
boolean	probe() Probes the state of the server.
Optional<StoreValues>	pull(StoreValuesQuery query, long timeout, StoreSessionImpl storeSession, Optional<Identity> identity) Pulls points values.
int	purge(UUID[] pointUUIDs, TimeInterval timeInterval, Optional<Identity> identity) Purges points values.
boolean	removeBinding(PointBinding binding) Removes a binding.
void	removeNoticeListener(NoticeListener noticeListener) Removes a notice listener.
protected void	reportUpdates(long updated, long deleted, long ignored, long time) Reports updates.
protected Optional<State>	resolveForPoint(State state, Optional<Point> point) Resolves a state for a point.
Optional<State>	resolveForPointUUID(State state, Optional<UUID> pointUUID) Resolves a state for a point UUID.
protected Exception[]	restoreUpdates(PointValue[] updates) Restore point references and values for updates.
void	resumeUpdates() Resume updates.
void	sendNotices() Sends the notices.
boolean	setUp(StoreServiceAppImpl storeAppImpl) Sets up for processing.
protected boolean	setUpPullSleep() Sets up pull sleep.
void	start() Starts this server
void	stop() Stops this server
boolean	supportsCount() Asks if the server supports count.
boolean	supportsDelete() Asks if the server supports delete.
protected boolean	supportsDeleteTracer() Asks if the server supports the delete tracer.
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.
protected boolean	supportsUpdateTracer() Asks if the server supports the update tracer.
void	suspendUpdates() Suspends updates.
void	tearDown() Tears down what has been set up.
void	unbind(PointBinding[] bindings) Unbinds.
protected StoreValues	unknownQueryPoint(StoreValuesQuery query) Returns an appropriate response for an unknown query point.
protected void	unlock() Unlocks.
protected StoreValues	unsupportedPullQuery() Returns an appropriate response for unsupported pull query.
protected VersionedValue	versionedValue(PointValue update) Returns a versioned value for an update.

Methods inherited from class Object

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

Methods inherited from interface StoreServer

newArchiver, select, supportedValueTypeCodes, update

Field Detail

DEFAULT_PULL_SLEEP

public static final ElapsedTime DEFAULT_PULL_SLEEP

Default pull sleep.

DELETED_TRACES

public static final String DELETED_TRACES

Traces subdirectory for deleted values.

See Also:

Constant Field Values

NAME_PROPERTY

public static final String NAME_PROPERTY

Name property.

See Also:

Constant Field Values

PULL_SLEEP_PROPERTY

public static final String PULL_SLEEP_PROPERTY

Pull sleep property.

See Also:

Constant Field Values

STATES_PROPERTY

public static final String STATES_PROPERTY

States reference property.

See Also:

Constant Field Values

STATE_PROPERTY

public static final String STATE_PROPERTY

State definition property.

See Also:

Constant Field Values

UPDATED_TRACES

public static final String UPDATED_TRACES

Traces subdirectory for updated values.

See Also:

Constant Field Values

Constructor Detail

Abstract

public Abstract()

Method Detail

addBinding

public final void addBinding(@Nonnull
                             PointBinding binding)

Adds a binding.

Parameters:

binding - The binding.

addNotice

public final void addNotice(@Nonnull
                            PointValue notice)
                     throws InterruptedException

Adds a notice.

Parameters:

notice - A point value.

Throws:

InterruptedException - When the service is stopped.

addNoticeListener

public final void addNoticeListener(NoticeListener noticeListener)

Adds a notice listener.

Specified by:

addNoticeListener in interface StoreServer

Parameters:

noticeListener - The notice listener.

bind

public PointBinding[] bind(PointBinding.Request[] bindRequests)

Binds point names to their UUID.

Specified by:

bind in interface StoreServer

Parameters:

bindRequests - The bind requests.

Returns:

The successful bindings (null on failure).

disableSuspend

public final void disableSuspend()
                          throws InterruptedException

Disables suspend.

Specified by:

disableSuspend in interface StoreServer

Throws:

InterruptedException - When interrupted.

enableSuspend

public final void enableSuspend()

Enables suspend.

Specified by:

enableSuspend in interface StoreServer

getBackEndLimit

@CheckReturnValue
public final int getBackEndLimit()

Gets the back-end limit.

Returns:

The back-end limit.

getBinding

@Nonnull
 @CheckReturnValue
public final Optional<PointBinding> getBinding(String name)

Gets a point binding by name.

Parameters:

name - The name.

Returns:

The optional point binding.

getMetadata

public final Metadata getMetadata()

Gets the metadata.

Specified by:

getMetadata in interface StoreServer

Returns:

The metadata.

getReplicator

@Nonnull
 @CheckReturnValue
public final Replicator getReplicator()

Gets the replicator.

Returns:

The replicator.

getResponseLimit

public final int getResponseLimit()

Gets the response limit.

Specified by:

getResponseLimit in interface StoreServer

Returns:

The response limit.

getStateGroups

public final Collection<State.Group> getStateGroups()

Gets the state groups.

Specified by:

getStateGroups in interface StoreServer

Returns:

The state groups.

getStats

public final StoreStats getStats()

Gets the store stats.

Specified by:

getStats in interface StoreServer

Returns:

The store stats.

isMemory

public boolean isMemory()

Asks if this is a memory store.

Specified by:

isMemory in interface StoreServer

Returns:

True if this is a memory store.

probe

public boolean probe()

Probes the state of the server.

Specified by:

probe in interface StoreServer

Returns:

True if the state of the server is fine.

pull

public Optional<StoreValues> pull(StoreValuesQuery query,
                                  long timeout,
                                  StoreSessionImpl storeSession,
                                  Optional<Identity> identity)
                           throws SessionException

Pulls points values.

Specified by:

pull in interface StoreServer

Parameters:

query - The store query.

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

storeSession - The store session implementation.

identity - The optional requesting identity.

Returns:

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

Throws:

SessionException - On session exception.

See Also:

Store.pull(StoreValuesQuery, long)

purge

public int purge(UUID[] pointUUIDs,
                 TimeInterval timeInterval,
                 Optional<Identity> identity)
          throws ServiceNotAvailableException

Purges points values.

Specified by:

purge in interface StoreServer

Parameters:

pointUUIDs - The UUID of the points to purge.

timeInterval - A time interval.

identity - The optional requesting identity.

Returns:

The number of values purged.

Throws:

ServiceNotAvailableException - On service not available.

removeBinding

public final boolean removeBinding(@Nonnull
                                   PointBinding binding)

Removes a binding.

Parameters:

binding - The binding.

Returns:

True if it was alone for the point.

removeNoticeListener

public final void removeNoticeListener(NoticeListener noticeListener)

Removes a notice listener.

Specified by:

removeNoticeListener in interface StoreServer

Parameters:

noticeListener - The notice listener.

resolveForPointUUID

public Optional<State> resolveForPointUUID(State state,
                                           Optional<UUID> pointUUID)

Resolves a state for a point UUID.

Specified by:

resolveForPointUUID in interface StoreServer

Parameters:

state - The state.

pointUUID - The optional point UUID.

Returns:

The optional resolved state.

resumeUpdates

public final void resumeUpdates()

Resume updates.

Specified by:

resumeUpdates in interface StoreServer

sendNotices

public void sendNotices()
                 throws InterruptedException

Sends the notices.

Throws:

InterruptedException - When the service is stopped.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        StoreServiceAppImpl storeAppImpl)

Sets up for processing.

Parameters:

storeAppImpl - The store application.

Returns:

True on success.

start

public void start()

Starts this server

Specified by:

start in interface StoreServer

stop

public void stop()

Stops this server

Specified by:

stop in interface StoreServer

supportsCount

public boolean supportsCount()

Asks if the server supports count.

Specified by:

supportsCount in interface StoreServer

Returns:

True if count is supported.

supportsDelete

public boolean supportsDelete()

Asks if the server supports delete.

Specified by:

supportsDelete in interface StoreServer

Returns:

True if delete is supported.

supportsDeliver

public boolean supportsDeliver()

Asks if the server supports deliver.

Specified by:

supportsDeliver in interface StoreServer

Returns:

True if deliver is supported.

supportsPull

public boolean supportsPull()

Asks if the server supports pull.

Specified by:

supportsPull in interface StoreServer

Returns:

True if pull is supported.

supportsPurge

public boolean supportsPurge()

Asks if the server supports purge.

Specified by:

supportsPurge in interface StoreServer

Returns:

True if purge is supported.

supportsSubscribe

public boolean supportsSubscribe()

Asks if the server supports subscribe.

Specified by:

supportsSubscribe in interface StoreServer

Returns:

True if subscribe is supported.

suspendUpdates

public final void suspendUpdates()

Suspends updates.

Specified by:

suspendUpdates in interface StoreServer

tearDown

public void tearDown()

Tears down what has been set up.

unbind

public void unbind(PointBinding[] bindings)

Unbinds.

Specified by:

unbind in interface StoreServer

Parameters:

bindings - The point bindings.

activateServiceClassLoader

protected void activateServiceClassLoader()

Activates the service class loader.

checkPurge

@CheckReturnValue
protected final boolean checkPurge(@Nonnull
                                                      UUID[] pointUUIDs,
                                                      @Nonnull
                                                      Optional<Identity> identity)

Checks if a purge on point values is allowed for the identity.

Parameters:

pointUUIDs - The points UUIDs.

identity - The optional identity.

Returns:

True if the purge is allowed for the specified UUIDs.

checkUpdate

@Nonnull
 @CheckReturnValue
protected final Optional<Exception> checkUpdate(@Nonnull
                                                                              PointValue pointValue,
                                                                              @Nonnull
                                                                              Optional<Identity> identity)

Checks if an update on a point's values is allowed for the identity.

Parameters:

pointValue - A point value.

identity - The optional identity.

Returns:

An exception if not allowed.

enterUpdates

protected final void enterUpdates()

Enters updates.

getArchiver

@Nonnull
 @CheckReturnValue
protected Optional<Archiver> getArchiver()

Gets the archiver.

Returns:

The optional archiver.

getDeletedTraces

@Nonnull
 @CheckReturnValue
protected final Traces getDeletedTraces()

Gets the 'deleted' traces.

Returns:

The 'deleted' traces.

getPolator

@Nonnull
 @CheckReturnValue
protected Polator getPolator(@Nonnull
                                                           Point point)

Gets the polator for a point.

Parameters:

point - The point.

Returns:

The polator for the point.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

getUpdatedTraces

@Nonnull
 @CheckReturnValue
protected final Traces getUpdatedTraces()

Gets the 'updated' traces.

Returns:

The 'updated' traces.

isStarted

@CheckReturnValue
protected final boolean isStarted()

Asks if started.

Returns:

True if started.

isStopped

@CheckReturnValue
protected final boolean isStopped()

Asks if stopped.

Returns:

True if stopped.

leaveUpdates

protected final void leaveUpdates()

Leaves updates.

lock

protected final void lock()

Locks.

reportUpdates

protected final void reportUpdates(long updated,
                                   long deleted,
                                   long ignored,
                                   long time)

Reports updates.

Parameters:

updated - The number of point values updated.

deleted - The number of point values deleted.

ignored - The number of updates ignored.

time - The update time in nanoseconds.

resolveForPoint

@Nonnull
 @CheckReturnValue
protected Optional<State> resolveForPoint(@Nonnull
                                                                        State state,
                                                                        @Nonnull
                                                                        Optional<Point> point)

Resolves a state for a point.

Parameters:

state - The state.

point - The optional point.

Returns:

The resolved state (may be empty).

restoreUpdates

@Nonnull
 @CheckReturnValue
protected final Exception[] restoreUpdates(@Nonnull
                                                                         PointValue[] updates)

Restore point references and values for updates.

Parameters:

updates - The point values to restore.

Returns:

An initialized exception array.

setUpPullSleep

@CheckReturnValue
protected boolean setUpPullSleep()

Sets up pull sleep.

Returns:

True on success.

supportsDeleteTracer

@CheckReturnValue
protected boolean supportsDeleteTracer()

Asks if the server supports the delete tracer.

Returns:

True if the delete tracer is supported.

supportsUpdateTracer

@CheckReturnValue
protected boolean supportsUpdateTracer()

Asks if the server supports the update tracer.

Returns:

True if the update tracer is supported.

unknownQueryPoint

@Nonnull
 @CheckReturnValue
protected final StoreValues unknownQueryPoint(@Nonnull
                                                                            StoreValuesQuery query)

Returns an appropriate response for an unknown query point.

Parameters:

query - The query.

Returns:

The response.

unlock

protected final void unlock()

Unlocks.

unsupportedPullQuery

@Nonnull
 @CheckReturnValue
protected final StoreValues unsupportedPullQuery()

Returns an appropriate response for unsupported pull query.

Returns:

The response.

versionedValue

@Nonnull
 @CheckReturnValue
protected final VersionedValue versionedValue(@Nonnull
                                                                            PointValue update)

Returns a versioned value for an update.

Parameters:

update - The update.

Returns:

The versioned value.