Package com.norconex.committer.core.batch.queue

Interface CommitterQueue

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

FsQueue

public interface CommitterQueue
extends AutoCloseable

A committer queue, accumulating requests before they are committed in one or multiple batches.

Method Summary

Modifier and Type	Method	Description
void	clean()	Cleans any persisted information specific to this queue.
void	close()
void	init(CommitterContext committerContext, BatchConsumer batchConsumer)	Initializes the committer queue.
void	queue(CommitterRequest request)	Queues a committer request to be later processed in batch.

Method Details

init

void init(CommitterContext committerContext,
 BatchConsumer batchConsumer)
   throws CommitterQueueException

Initializes the committer queue.

Parameters:

committerContext - committer context

batchConsumer - batch consumer

Throws:

CommitterQueueException - could not initialize committer queue

queue

void queue(CommitterRequest request)
    throws CommitterQueueException

Queues a committer request to be later processed in batch.

Parameters:

request - committer request

Throws:

CommitterQueueException - could not queue committer request

clean

void clean()
    throws CommitterQueueException

Cleans any persisted information specific to this queue.

Throws:

CommitterQueueException - could not clean queue

close

void close()
    throws CommitterQueueException

Specified by:

close in interface AutoCloseable

Throws:

CommitterQueueException