com.graphaware.writer.thirdparty

Class BaseThirdPartyWriter

java.lang.Object

com.google.common.util.concurrent.AbstractScheduledService

com.graphaware.writer.service.QueueBackedScheduledService<Collection<WriteOperation<?>>>

com.graphaware.writer.thirdparty.BaseThirdPartyWriter

All Implemented Interfaces:

com.google.common.util.concurrent.Service, ThirdPartyWriter, Writer

public abstract class BaseThirdPartyWriter
extends QueueBackedScheduledService<Collection<WriteOperation<?>>>
implements ThirdPartyWriter

Abstract base-class for ThirdPartyWriter implementations, backed by a QueueBackedScheduledService.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.util.concurrent.AbstractScheduledService

com.google.common.util.concurrent.AbstractScheduledService.CustomScheduler, com.google.common.util.concurrent.AbstractScheduledService.Scheduler

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields inherited from class com.graphaware.writer.service.QueueBackedScheduledService

DEFAULT_QUEUE_CAPACITY, queue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseThirdPartyWriter() Construct a new writer with a default queue capacity of QueueBackedScheduledService.DEFAULT_QUEUE_CAPACITY.
protected	BaseThirdPartyWriter(int queueCapacity) Construct a new writer.

Method Summary

Modifier and Type	Method and Description
protected void	offer(Collection<WriteOperation<?>> operations, String id) Offer a collection of WriteOperations, typically all the operations performed within the context of a single transaction, to the queue for processing.
protected abstract void	processOperations(List<Collection<WriteOperation<?>>> operations) Process the given operations that have been pulled from the queue, i.e.
protected void	retry(List<Collection<WriteOperation<?>>> operations) A convenience method for failure scenarios, which will insert the provided operations into the front of the queue.
protected void	runOneIteration()
void	write(Collection<WriteOperation<?>> operations, String id)
void	write(WriteOperation<?> operation, String id)

Methods inherited from class com.graphaware.writer.service.QueueBackedScheduledService

equals, hashCode, logEmptyQueue, loggingFrequencyMs, offer, scheduler, shutDown, start, stop

Methods inherited from class com.google.common.util.concurrent.AbstractScheduledService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, serviceName, startAsync, startUp, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.graphaware.writer.Writer

start, stop

Constructor Detail

BaseThirdPartyWriter

protected BaseThirdPartyWriter()

Construct a new writer with a default queue capacity of QueueBackedScheduledService.DEFAULT_QUEUE_CAPACITY.

BaseThirdPartyWriter

protected BaseThirdPartyWriter(int queueCapacity)

Construct a new writer.

Parameters:

queueCapacity - capacity of the queue.

Method Detail

runOneIteration

protected void runOneIteration()
                        throws Exception

Specified by:

runOneIteration in class com.google.common.util.concurrent.AbstractScheduledService

Throws:

Exception

write

public void write(WriteOperation<?> operation,
                  String id)

Specified by:

write in interface ThirdPartyWriter

write

public void write(Collection<WriteOperation<?>> operations,
                  String id)

Specified by:

write in interface ThirdPartyWriter

offer

protected final void offer(Collection<WriteOperation<?>> operations,
                           String id)

Offer a collection of WriteOperations, typically all the operations performed within the context of a single transaction, to the queue for processing. If the queue is full, the operations will be dropped and a warning logged.

Parameters:

operations - to process.

id - of the operations for logging purposes.

processOperations

protected abstract void processOperations(List<Collection<WriteOperation<?>>> operations)

Process the given operations that have been pulled from the queue, i.e. shoot them at the third-party system. Implementations must handle failures scenarios, but the retry(List) method is intended to help there.

Parameters:

operations - to be processed.

retry

protected final void retry(List<Collection<WriteOperation<?>>> operations)

A convenience method for failure scenarios, which will insert the provided operations into the front of the queue.

Parameters:

operations - to retry.