Package com.twicedb.client.impl

Class ClientImpl

java.lang.Object

com.twicedb.client.impl.ClientImpl

All Implemented Interfaces:

Client

public class ClientImpl
extends Object
implements Client

An implementation of the TwiceDB client API. Such an implementation is necessary in order to query TwiceDB. After instantiating the class, one must also call the start() method to start background processes.

Constructor Summary

Constructors

Constructor	Description
ClientImpl(ClientConfig config)

Method Summary

Modifier and Type	Method	Description
AggregationResponse	buildAggregationResponse(ReadResponse.ReadCommandResponse r, boolean requireInteger)
Lsqt	catchUpLsqt(Tt catchUpTo, Duration maxWaitDuration)
boolean	checkReader()
boolean	checkWriter()
WrittenTransaction	commitTxn(Txn txn)
Future<WriteAsyncResponse>	commitTxnAsync(Txn txn)
<I extends Indexable<I>> AggregationResponse	countByIndexedQuery(IndexedQuery<I> iq, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	countByIndexedQueryAsync(IndexedQuery<I> iq, TemporalCoordinates tc)
WrittenObject	delete(ObjectId objectId, Tt lastRead, Vt vtFrom)
Future<WriteAsyncResponse>	deleteAsync(ObjectId objectId, Tt lastRead, Vt vtFrom)
<I extends Indexable<I>> WrittenObject	deleteObject(I object, Vt vtFrom)
<I extends Indexable<I>> Future<WriteAsyncResponse>	deleteObjectAsync(I object, Vt vtFrom)
Tt	entitle(EmailAddress emailAddress, Fqn fqn, ReadEntitlement read, WriteEntitlement write, EntitleEntitlement entitle, Vt vt, BackfillTt backfillTt)	Sets new entitlements.
Lsqt	getLsqt()
ClientMetrics	getMetrics()
long	getReadQueueCap()
ServerStatus	getServerStatus(ServerType serverType)	Returns a ServerStatus object that contains basic information about the reader or the writer to which the client is connected.
long	getWriteQueueCap()
List<Fqn>	listLockedFqns()
Tt	lockFqn(Fqn fqn)
<I extends Indexable<I>> AggregationResponse	maxByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	maxByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> AggregationResponse	meanByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	meanByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> AggregationResponse	medianByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	medianByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> AggregationResponse	minByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	minByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> AggregationResponse	percentileByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, Percentile p, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	percentileByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, Percentile p, TemporalCoordinates tc)
WrittenObject	put(ObjectId objectId, Tt lastRead, Vt vtFrom, Blob blob)
Future<WriteAsyncResponse>	putAsync(ObjectId objectId, Tt lastRead, Vt vtFrom, Blob blob)
<I extends Indexable<I>> WrittenObject	putObject(I object, Vt vtFrom)
<I extends Indexable<I>> Future<WriteAsyncResponse>	putObjectAsync(I object, Vt vtFrom)
<E extends Event<E>> E	readEvent(EventId eventId, Fqn fqn, Tt tt)
<E extends Event<E>> Future<E>	readEventAsync(EventId eventId, Fqn fqn, Tt tt)
<I extends Indexable<I>, E extends Event<E>> E	readEventForObject(Indexable<I> ixbl)
<I extends Indexable<I>, E extends Event<E>> Future<E>	readEventForObjectAsync(Indexable<I> ixbl)
Lsqt	readLsqt()
<I extends Indexable<I>> ReadObject	readObject(I ixbl, TemporalCoordinates tc)
<I extends Indexable<I>> Future<ReadObject>	readObjectAsync(I ixbl, TemporalCoordinates tc)
<I extends Indexable<I>> List<I>	readObjects(I object, TemporalCoordinates tc)
<I extends Indexable<I>> Future<ReadAsyncResponse>	readObjectsAsync(I object, TemporalCoordinates tc)
<I extends Indexable<I>> List<I>	readObjectsAtTt(I ixbl, Tt tt)
<I extends Indexable<I>> Future<ReadAsyncResponse>	readObjectsAtTtAsync(I ixbl, Tt tt)
<I extends Indexable<I>> List<I>	readObjectsAtVt(I ixbl, TemporalCoordinates tc)
<I extends Indexable<I>> Future<ReadAsyncResponse>	readObjectsAtVtAsync(I ixbl, TemporalCoordinates tc)
<I extends Indexable<I>, E extends Event<E>> List<I>	readObjectsByEvent(E e)
<I extends Indexable<I>, E extends Event<E>> Future<List<I>>	readObjectsByEventAsync(E e)
<I extends Indexable<I>> List<I>	readObjectsByFqn(Fqn fqn, Tt maxSeenTtFrom, TimesliceId maxSeenTimesliceId, Tt maxTtFrom, BatchSize batchSize)
<I extends Indexable<I>> List<I>	readObjectsByIndexedQuery(IndexedQuery<I> iq, TemporalCoordinates tc)
<I extends Indexable<I>> Future<ReadAsyncResponse>	readObjectsByIndexedQueryAsync(IndexedQuery<I> iq, TemporalCoordinates tc)
<I extends Indexable<I>> List<I>	readObjectsToIndexables(List<ReadObject> ros)
ReadObject	readPoint(ObjectId objectId, TemporalCoordinates tc)
Future<ReadAsyncResponse>	readPointAsync(ObjectId objectId, TemporalCoordinates tc)
<I extends Indexable<I>> WrittenObject	reindexObject(I ixbl)
<I extends Indexable<I>> Future<WriteAsyncResponse>	reindexObjectAsync(I ixbl)
WrittenObject	reinstate(ObjectId objectId, Tt lastRead, Vt vtFrom)
Future<WriteAsyncResponse>	reinstateAsync(ObjectId objectId, Tt lastRead, Vt vtFrom)
<I extends Indexable<I>> WrittenObject	reinstateObject(I object, Vt vtFrom)
<I extends Indexable<I>> Future<WriteAsyncResponse>	reinstateObjectAsync(I object, Vt vtFrom)
void	start()
<I extends Indexable<I>> AggregationResponse	stdevByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	stdevByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
void	stop()
<I extends Indexable<I>> void	subscribeToIndexedQuery(IndexedQuery<I> iq, Function<SubscribeResponse,Boolean> cback)
void	subscribeToObjectId(ObjectId oid, Function<SubscribeResponse,Boolean> cback)
<I extends Indexable<I>> AggregationResponse	sumByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	sumByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
Tt	unlockFqn(Fqn fqn)
<I extends Indexable<I>> AggregationResponse	varByIndexedQuery(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)
<I extends Indexable<I>> Future<AggregationResponse>	varByIndexedQueryAsync(IndexedQuery<I> iq, ProjectedFieldKey fieldKey, TemporalCoordinates tc)

Methods inherited from class java.lang.Object

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

Constructor Details

ClientImpl

public ClientImpl(ClientConfig config)

Method Details

getReadQueueCap

public long getReadQueueCap()

Specified by:

getReadQueueCap in interface Client

getWriteQueueCap

public long getWriteQueueCap()

Specified by:

getWriteQueueCap in interface Client

getLsqt

public Lsqt getLsqt()

Specified by:

getLsqt in interface Client

getMetrics

public ClientMetrics getMetrics()

Specified by:

getMetrics in interface Client

readLsqt

public Lsqt readLsqt()

Specified by:

readLsqt in interface Client

start

public void start()

Specified by:

start in interface Client

stop

public void stop()

Specified by:

stop in interface Client

readObject

public <I extends Indexable<I>> ReadObject readObject(I ixbl,
 TemporalCoordinates tc)

Specified by:

readObject in interface Client

readObjectAsync

public <I extends Indexable<I>> Future<ReadObject> readObjectAsync(I ixbl,
 TemporalCoordinates tc)

Specified by:

readObjectAsync in interface Client

readPoint

public ReadObject readPoint(ObjectId objectId,
 TemporalCoordinates tc)

Specified by:

readPoint in interface Client

readPointAsync

public Future<ReadAsyncResponse> readPointAsync(ObjectId objectId,
 TemporalCoordinates tc)

Specified by:

readPointAsync in interface Client

readObjects

public <I extends Indexable<I>> List<I> readObjects(I object,
 TemporalCoordinates tc)

Specified by:

readObjects in interface Client

readObjectsAsync

public <I extends Indexable<I>>
Future<ReadAsyncResponse> readObjectsAsync(I object,
 TemporalCoordinates tc)

Specified by:

readObjectsAsync in interface Client

readObjectsByIndexedQuery

public <I extends Indexable<I>> List<I> readObjectsByIndexedQuery(IndexedQuery<I> iq,
 TemporalCoordinates tc)

Specified by:

readObjectsByIndexedQuery in interface Client

readObjectsByIndexedQueryAsync

public <I extends Indexable<I>>
Future<ReadAsyncResponse> readObjectsByIndexedQueryAsync(IndexedQuery<I> iq,
 TemporalCoordinates tc)

Specified by:

readObjectsByIndexedQueryAsync in interface Client

delete

public WrittenObject delete(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom)

Specified by:

delete in interface Client

deleteAsync

public Future<WriteAsyncResponse> deleteAsync(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom)

Specified by:

deleteAsync in interface Client

deleteObject

public <I extends Indexable<I>> WrittenObject deleteObject(I object,
 Vt vtFrom)

Specified by:

deleteObject in interface Client

deleteObjectAsync

public <I extends Indexable<I>>
Future<WriteAsyncResponse> deleteObjectAsync(I object,
 Vt vtFrom)

Specified by:

deleteObjectAsync in interface Client

put

public WrittenObject put(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom,
 Blob blob)

Specified by:

put in interface Client

putAsync

public Future<WriteAsyncResponse> putAsync(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom,
 Blob blob)

Specified by:

putAsync in interface Client

reinstate

public WrittenObject reinstate(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom)

Specified by:

reinstate in interface Client

reinstateAsync

public Future<WriteAsyncResponse> reinstateAsync(ObjectId objectId,
 Tt lastRead,
 Vt vtFrom)

Specified by:

reinstateAsync in interface Client

reinstateObject

public <I extends Indexable<I>> WrittenObject reinstateObject(I object,
 Vt vtFrom)

Specified by:

reinstateObject in interface Client

reinstateObjectAsync

public <I extends Indexable<I>>
Future<WriteAsyncResponse> reinstateObjectAsync(I object,
 Vt vtFrom)

Specified by:

reinstateObjectAsync in interface Client

putObject

public <I extends Indexable<I>> WrittenObject putObject(I object,
 Vt vtFrom)

Specified by:

putObject in interface Client

putObjectAsync

public <I extends Indexable<I>>
Future<WriteAsyncResponse> putObjectAsync(I object,
 Vt vtFrom)

Specified by:

putObjectAsync in interface Client

catchUpLsqt

public Lsqt catchUpLsqt(Tt catchUpTo,
 Duration maxWaitDuration)

Specified by:

catchUpLsqt in interface Client

checkReader

public boolean checkReader()

Specified by:

checkReader in interface Client

checkWriter

public boolean checkWriter()

Specified by:

checkWriter in interface Client

commitTxn

public WrittenTransaction commitTxn(Txn txn)

Specified by:

commitTxn in interface Client

commitTxnAsync

public Future<WriteAsyncResponse> commitTxnAsync(Txn txn)

Specified by:

commitTxnAsync in interface Client

readEvent

public <E extends Event<E>> E readEvent(EventId eventId,
 Fqn fqn,
 Tt tt)

Specified by:

readEvent in interface Client

readEventAsync

public <E extends Event<E>> Future<E> readEventAsync(EventId eventId,
 Fqn fqn,
 Tt tt)

Specified by:

readEventAsync in interface Client

readEventForObject

public <I extends Indexable<I>,
E extends Event<E>>
E readEventForObject(Indexable<I> ixbl)

Specified by:

readEventForObject in interface Client

readEventForObjectAsync

public <I extends Indexable<I>,
E extends Event<E>>
Future<E> readEventForObjectAsync(Indexable<I> ixbl)

Specified by:

readEventForObjectAsync in interface Client

readObjectsByEvent

public <I extends Indexable<I>,
E extends Event<E>>
List<I> readObjectsByEvent(E e)

Specified by:

readObjectsByEvent in interface Client

readObjectsByEventAsync

public <I extends Indexable<I>,
E extends Event<E>>
Future<List<I>> readObjectsByEventAsync(E e)

Specified by:

readObjectsByEventAsync in interface Client

readObjectsByFqn

public <I extends Indexable<I>> List<I> readObjectsByFqn(Fqn fqn,
 Tt maxSeenTtFrom,
 TimesliceId maxSeenTimesliceId,
 Tt maxTtFrom,
 BatchSize batchSize)

Specified by:

readObjectsByFqn in interface Client

readObjectsToIndexables

public <I extends Indexable<I>> List<I> readObjectsToIndexables(List<ReadObject> ros)

Specified by:

readObjectsToIndexables in interface Client

buildAggregationResponse

public AggregationResponse buildAggregationResponse(ReadResponse.ReadCommandResponse r,
 boolean requireInteger)

countByIndexedQuery

public <I extends Indexable<I>> AggregationResponse countByIndexedQuery(IndexedQuery<I> iq,
 TemporalCoordinates tc)

Specified by:

countByIndexedQuery in interface Client

countByIndexedQueryAsync

public <I extends Indexable<I>>
Future<AggregationResponse> countByIndexedQueryAsync(IndexedQuery<I> iq,
 TemporalCoordinates tc)

Specified by:

countByIndexedQueryAsync in interface Client

maxByIndexedQuery

public <I extends Indexable<I>> AggregationResponse maxByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

maxByIndexedQuery in interface Client

maxByIndexedQueryAsync

public <I extends Indexable<I>>
Future<AggregationResponse> maxByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

maxByIndexedQueryAsync in interface Client

meanByIndexedQuery

public <I extends Indexable<I>> AggregationResponse meanByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

meanByIndexedQuery in interface Client

meanByIndexedQueryAsync

public <I extends Indexable<I>>
Future<AggregationResponse> meanByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

meanByIndexedQueryAsync in interface Client

medianByIndexedQuery

public <I extends Indexable<I>> AggregationResponse medianByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

medianByIndexedQuery in interface Client

medianByIndexedQueryAsync

public <I extends Indexable<I>>
Future<AggregationResponse> medianByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

medianByIndexedQueryAsync in interface Client

minByIndexedQuery

public <I extends Indexable<I>> AggregationResponse minByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

minByIndexedQuery in interface Client

minByIndexedQueryAsync

public <I extends Indexable<I>>
Future<AggregationResponse> minByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

minByIndexedQueryAsync in interface Client

percentileByIndexedQuery

public <I extends Indexable<I>> AggregationResponse percentileByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 Percentile p,
 TemporalCoordinates tc)

Specified by:

percentileByIndexedQuery in interface Client

percentileByIndexedQueryAsync

public <I extends Indexable<I>>
Future<AggregationResponse> percentileByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 Percentile p,
 TemporalCoordinates tc)

Specified by:

percentileByIndexedQueryAsync in interface Client

stdevByIndexedQuery

public <I extends Indexable<I>> AggregationResponse stdevByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

stdevByIndexedQuery in interface Client

stdevByIndexedQueryAsync

public <I extends Indexable<I>>
Future<AggregationResponse> stdevByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

stdevByIndexedQueryAsync in interface Client

sumByIndexedQuery

public <I extends Indexable<I>> AggregationResponse sumByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

sumByIndexedQuery in interface Client

sumByIndexedQueryAsync

public <I extends Indexable<I>>
Future<AggregationResponse> sumByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

sumByIndexedQueryAsync in interface Client

varByIndexedQuery

public <I extends Indexable<I>> AggregationResponse varByIndexedQuery(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

varByIndexedQuery in interface Client

varByIndexedQueryAsync

public <I extends Indexable<I>>
Future<AggregationResponse> varByIndexedQueryAsync(IndexedQuery<I> iq,
 ProjectedFieldKey fieldKey,
 TemporalCoordinates tc)

Specified by:

varByIndexedQueryAsync in interface Client

listLockedFqns

public List<Fqn> listLockedFqns()

Specified by:

listLockedFqns in interface Client

lockFqn

public Tt lockFqn(Fqn fqn)

Specified by:

lockFqn in interface Client

unlockFqn

public Tt unlockFqn(Fqn fqn)

Specified by:

unlockFqn in interface Client

reindexObject

public <I extends Indexable<I>> WrittenObject reindexObject(I ixbl)

Specified by:

reindexObject in interface Client

reindexObjectAsync

public <I extends Indexable<I>>
Future<WriteAsyncResponse> reindexObjectAsync(I ixbl)

Specified by:

reindexObjectAsync in interface Client

subscribeToIndexedQuery

public <I extends Indexable<I>> void subscribeToIndexedQuery(IndexedQuery<I> iq,
 Function<SubscribeResponse,Boolean> cback)

Specified by:

subscribeToIndexedQuery in interface Client

subscribeToObjectId

public void subscribeToObjectId(ObjectId oid,
 Function<SubscribeResponse,Boolean> cback)

Specified by:

subscribeToObjectId in interface Client

readObjectsAtVt

public <I extends Indexable<I>> List<I> readObjectsAtVt(I ixbl,
 TemporalCoordinates tc)

Specified by:

readObjectsAtVt in interface Client

readObjectsAtVtAsync

public <I extends Indexable<I>>
Future<ReadAsyncResponse> readObjectsAtVtAsync(I ixbl,
 TemporalCoordinates tc)

Specified by:

readObjectsAtVtAsync in interface Client

readObjectsAtTt

public <I extends Indexable<I>> List<I> readObjectsAtTt(I ixbl,
 Tt tt)

Specified by:

readObjectsAtTt in interface Client

readObjectsAtTtAsync

public <I extends Indexable<I>>
Future<ReadAsyncResponse> readObjectsAtTtAsync(I ixbl,
 Tt tt)

Specified by:

readObjectsAtTtAsync in interface Client

getServerStatus

public ServerStatus getServerStatus(ServerType serverType)

Returns a ServerStatus object that contains basic information about the reader or the writer to which the client is connected.

Specified by:

getServerStatus in interface Client

Parameters:

serverType - the type of server from which to get information, either READER or WRITER

Returns:

information about the server

entitle

public Tt entitle(EmailAddress emailAddress,
 Fqn fqn,
 ReadEntitlement read,
 WriteEntitlement write,
 EntitleEntitlement entitle,
 Vt vt,
 BackfillTt backfillTt)

Sets new entitlements.

Specified by:

entitle in interface Client

Parameters:

emailAddress - the email address of the user to receive the new entitlements

fqn - the Fqn for which the new entitlements apply

read - sets the read entitlement

write - sets the write entitlement

entitle - sets the entitle entitlement