org.rvpf.store.client

Class SOMSink

Object

Proxied.Abstract

AbstractStore

AbstractSink

SOMSink

All Implemented Interfaces:

Comparable<Store>, Store, Proxied

public final class SOMSink
extends AbstractSink

SOM sink.

This class provides a client side access to a sink's SOM queue.

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

Method Summary

Modifier and Type	Method and Description
void	close() Closes the store.
void	connect() Connects.
protected void	doAddQuery(StoreValuesQuery query) Does add a store query for point values.
Optional<Exception[]>	getExceptions() Gets the exceptions.
boolean	probe() Probes the state of the store session.
boolean	sendUpdates(Collection<PointValue> updates) Sends updates.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.
protected String	supportedValueTypeCodes() Returns a string of supported value type codes.

Methods inherited from class AbstractSink

nextValues, select, supportsCount

Methods inherited from class AbstractStore

accessException, addQuery, addUpdate, bind, bindPoints, bindPoints, canConfirm, compareTo, confirm, deliver, getConfirmRetries, getConfirmRetryDelay, getQueriesBatchLimit, getResponseLimit, getSubscribedValues, getThisLogger, getUpdateCount, getUpdates, getUUID, impersonate, isNullRemoves, iterate, pull, purge, reset, sendUpdates, setConfirmRetries, setQueriesBatchLimit, setResponseLimit, subscribe, subscribe, supportedValueTypes, supportsDelete, supportsDeliver, supportsPull, supportsPurge, supportsSubscribe, tearDown, unsubscribe

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

SOMSink

public SOMSink()

Method Detail

close

public void close()

Closes the store.

May be called redundantly.

Specified by:

close in interface Store

Overrides:

close in class AbstractStore

connect

public void connect()
             throws StoreAccessException

Connects.

Throws:

StoreAccessException - On store access problem.

getExceptions

public Optional<Exception[]> getExceptions()

Gets the exceptions.

Returns:

The optional exceptions (each null on success).

probe

public boolean probe()
              throws StoreAccessException

Probes the state of the store session.

Returns:

True when everything is fine.

Throws:

StoreAccessException - On store access problem.

sendUpdates

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

Sends updates.

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.

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.

supportedValueTypeCodes

protected String supportedValueTypeCodes()

Returns a string of supported value type codes.

Specified by:

supportedValueTypeCodes in class AbstractStore

Returns:

The string of supported value type codes.