com.exalead.papi.helper.pipe.indextrigger

Class IndexTriggerPushAPI

java.lang.Object

com.exalead.papi.helper.PushAPI

com.exalead.papi.helper.pipe.PipedPushAPI

com.exalead.papi.helper.pipe.indextrigger.IndexTriggerPushAPI

public class IndexTriggerPushAPI
extends PipedPushAPI

Tee Push API. This class allows to duplicate command traffic and send it through a secondary slave PushAPI.

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	BACKOFF_WAIT_INITIAL_MS Initial poll wait time for trigger indexing job
protected static long	BACKOFF_WAIT_MAX_MS Max poll wait time for trigger indexing job
protected java.lang.String	connectorName Connector name.
protected boolean	waitSearchable Wait for documents to be searchable ?
protected int	waitSearchableTimeout Wait for documents timeout

Fields inherited from class com.exalead.papi.helper.pipe.PipedPushAPI

defaultLogger, isBestEffortOnStopSession, jlogger, logger, parent

Fields inherited from class com.exalead.papi.helper.PushAPI

DEFAULT_CHECKPOINT_NAME, STREAMING_BLOCK_SIZE

Constructor Summary

Constructors

Constructor and Description
IndexTriggerPushAPI(PushAPI source, boolean waitSearchable, int waitSearchableTimeout) Create a new TeePushAPI

Method Summary

Modifier and Type	Method and Description
static PushAPI	createPushAPIPlugin(PushAPI papi, java.lang.String[] keys, java.lang.String[] values) Create a new IndexTriggerAPI (PushAPI triggering an indexing job)
void	startPushSession() Starts a new session on the push server.
void	stopPushSession(boolean releaseConnections) Stops the current session on the push server.

Methods inherited from class com.exalead.papi.helper.pipe.PipedPushAPI

addDocument, addDocumentList, areDocumentsSearchable, areDocumentsSearchable, clearAllCheckpoints, clearCheckpoints, countSyncedEntries, debug, deleteDocument, deleteDocumentList, deleteDocumentList, deleteDocumentRootPath, deleteDocumentsWithPrefix, enumerateCheckpointInfo, enumerateCheckpointInfo, enumerateSyncedEntries, error, getBestEffortOnStopSession, getCheckpoint, getCheckpoint, getConnectorName, getDocumentStatus, getDocumentStatusList, getLogger, getParent, info, isTraceEnabled, log, ping, setBestEffortOnStopSession, setCheckpoint, setLogger, suggestSyncedEntries, sync, synchronize, trace, triggerIndexingJob, triggerIndexingJobWhenIdle, updateDocument, updateDocumentList, updateDocumentMetas, updateDocumentMetasList, warning

Methods inherited from class com.exalead.papi.helper.PushAPI

countSyncedEntries, deleteDocumentRootPath, deleteDocumentRootPath, deleteDocumentsWithPrefix, enumerateSyncedEntries, getCheckpoint, getDocumentDidsAndSlices, setCheckpoint, setCheckpoint, setCheckpoint

Methods inherited from class java.lang.Object

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

Field Detail

connectorName

protected java.lang.String connectorName

Connector name.

waitSearchable

protected final boolean waitSearchable

Wait for documents to be searchable ?

waitSearchableTimeout

protected final int waitSearchableTimeout

Wait for documents timeout

BACKOFF_WAIT_INITIAL_MS

protected static final long BACKOFF_WAIT_INITIAL_MS

Initial poll wait time for trigger indexing job

See Also:

Constant Field Values

BACKOFF_WAIT_MAX_MS

protected static final long BACKOFF_WAIT_MAX_MS

Max poll wait time for trigger indexing job

See Also:

Constant Field Values

Constructor Detail

IndexTriggerPushAPI

public IndexTriggerPushAPI(PushAPI source,
                           boolean waitSearchable,
                           int waitSearchableTimeout)
                    throws PushAPIException

Create a new TeePushAPI

Throws:

PushAPIException

Method Detail

createPushAPIPlugin

public static PushAPI createPushAPIPlugin(PushAPI papi,
                                          java.lang.String[] keys,
                                          java.lang.String[] values)
                                   throws java.lang.Exception

Create a new IndexTriggerAPI (PushAPI triggering an indexing job)

Parameters:

papi - upstream PushAPI

keys - configuration keys (see below)

keys - configuration values Configuration keys are:

• "WaitSearchable" wait for documents to be searchable ?
• "WaitSearchableTimeoutMs" maximum time to wait for documents to be searchable in milliseconds

Throws:

java.lang.Exception

startPushSession

public void startPushSession()
                      throws PushAPIException

Description copied from class: PushAPI

Starts a new session on the push server. Between the beginning and the end of a session (stopPushSession), if the push server restarts for any reason, an exception will be thrown. The connector should then engage a recovery procedure.

Overrides:

startPushSession in class PipedPushAPI

Throws:

PushAPISessionExistsException - if the session is already started.

PushAPIException - if any another error occurred.

stopPushSession

public void stopPushSession(boolean releaseConnections)
                     throws PushAPIException

Description copied from class: PushAPI

Stops the current session on the push server.

Overrides:

stopPushSession in class PipedPushAPI

Throws:

PushAPISessionNotFoundException - if session is not started.

PushAPIException - if another error occurred.

See Also:

startPushSession}