BackgroundPushAPI (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.papi.helper.PushAPI
- - com.exalead.papi.helper.pipe.PipedPushAPI
  - - com.exalead.papi.helper.pipe.background.BackgroundPushAPI

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
```
public class BackgroundPushAPI
extends PipedPushAPI
implements java.io.Flushable, java.io.Closeable
```
Background Push API. This class allows to extend an existing PushAPI to handle background add, delete and update operations. This extension can only work if startPushSession() and stopPushSession() are used as begining and ending of a session. It can not be used otherwise. Thread safety of this class is guaranteed. Ordering of operations is guaranted for each thread (ie. add or delete operations are pushed in order). Ordering of operations is NOT globally guaranteed ; which means that if two threads are adding an add and a delete operation on the same URI, the final ordering is undefined unless the flush() function was used to force the flushing of all buffers. Important note: the default behaviour is not to flush anything unless it is necessary. The calling client MUST ensure that flush() (or flush()) is called, either directly by calling the flush() function, or indirectly, by calling a flushing operation at the end of processing (see below) Note that the following operations imply a flush() before they can be executed: ("flushing operations") startPushSession() stopPushSession() sync() triggerIndexingJob() setCheckpoint() clearAllCheckpoints()

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`BackgroundPushAPI.BackgroundWorker` Background runner.
`protected class`	`BackgroundPushAPI.BackgroundWorkerAddDocument` addDocument
`protected class`	`BackgroundPushAPI.BackgroundWorkerAddDocumentList` addDocumentList
`protected class`	`BackgroundPushAPI.BackgroundWorkerDeleteDocument` deleteDocument
`protected class`	`BackgroundPushAPI.BackgroundWorkerDeleteDocumentList` deleteDocuments
`protected class`	`BackgroundPushAPI.BackgroundWorkerDeleteDocumentListDid` deleteDocumentList
`protected class`	`BackgroundPushAPI.BackgroundWorkerDeleteDocumentRootPath` deleteDocumentRootPath
`protected class`	`BackgroundPushAPI.BackgroundWorkerDeleteDocumentsWithPrefix` deleteDocumentsWithPrefix
`protected class`	`BackgroundPushAPI.BackgroundWorkerItem` Command in background.
`protected class`	`BackgroundPushAPI.BackgroundWorkerUpdateDocument` updateDocument
`protected class`	`BackgroundPushAPI.BackgroundWorkerUpdateDocumentList` updateDocumentList
`protected class`	`BackgroundPushAPI.BackgroundWorkerUpdateDocumentMetas` updateDocumentMetas
`protected class`	`BackgroundPushAPI.BackgroundWorkerUpdateDocumentMetasList` updateDocumentMetasList

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`defaultMaxBytes` Default maximum total size of background documents (estimated)
`static int`	`defaultMaxDocuments` Default maximum number of background documents per operation.
`protected long`	`maxBytes` Maximum document total size to buffer
`protected int`	`maxDocuments` Number of background documents
`protected BackgroundPushAPI.BackgroundWorker`	`worker` Worker thread.

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
`BackgroundPushAPI(PushAPI parent)` Create a new BackgroundPushAPI
`BackgroundPushAPI(PushAPI parent, int maxDocuments)` Create a new BackgroundPushAPI
`BackgroundPushAPI(PushAPI parent, int maxDocuments, long maxBytes)` Create a new BackgroundPushAPI

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDocument(Document document)` Adds a document.
`void`	`addDocumentList(Document[] documents)` Adds a set of documents.
`void`	`clearAllCheckpoints()` Resets all the checkpoints values.
`void`	`close()` Closes the BackgroundPushAPI object.
`static PushAPI`	`createPushAPIPlugin(PushAPI papi, java.lang.String[] keys, java.lang.String[] values)` Create a new BackgroundPushAPI (PushAPI plugin pipe constructor)
`void`	`deleteDocument(java.lang.String uri)` Deletes a document specified by its URI.
`void`	`deleteDocumentList(int[] did, int[] slices)` Deletes a list of documents specified by their dids and slices.
`void`	`deleteDocumentList(java.lang.String[] uris)` Deletes a list of documents specified by their URIs.
`void`	`deleteDocumentRootPath(java.lang.String rootPath, boolean recursive, boolean clearCache)` Deletes a set of documents corresponding to a URI prefix.
`void`	`deleteDocumentsWithPrefix(java.lang.String prefix, boolean clearCache)` Deletes a set of documents corresponding to a URI prefix.
`protected void`	`finalize()` Finalizer.
`void`	`flush()` Flush (ie.
`void`	`flushAll()` Flush (ie.
`void`	`flushCurrent()` Flush current (ie.
`protected void`	`push(BackgroundPushAPI.BackgroundWorkerItem item)` Push an operation.
`java.math.BigInteger`	`setCheckpoint(java.lang.String value, java.lang.String name, boolean sync)` Sets a checkpoint in the push server.
`void`	`startPushSession()` Starts a new session on the push server.
`void`	`startWorker()` Ensure worker thread is started.
`void`	`stopPushSession(boolean releaseConnections)` Stops the current session on the push server.
`void`	`stopWorker()` Ensure worker thread is ended.
`void`	`sync()` Deprecated. since V6R2015x, replaced by `synchronize()`
`java.math.BigInteger`	`synchronize()` Forces the synchronization of all pending operations before returning.
`void`	`triggerIndexingJob()` Forces the processing of all pending operations synchronized to disk.
`void`	`triggerIndexingJobWhenIdle()` Wait for indexing to be idle, and forces the processing of all pending operations synchronized to disk.
`void`	`updateDocument(Document doc, java.lang.String[] fields)` Partially updates a document.
`void`	`updateDocumentList(Document[] documents, java.lang.String[][] fieldsList)` Updates a set of documents.
`void`	`updateDocumentMetas(java.lang.String uri, java.lang.String stamp, MetaContainer metaContainer)` Updates the stamp and the meta data of a document, using a strict meta to field mapping.
`void`	`updateDocumentMetasList(java.lang.String[] uriList, java.lang.String[] stampList, MetaContainer[] metaContainerList)` Updates a set of the stamp and meta data for given documents.

Methods inherited from class com.exalead.papi.helper.pipe.PipedPushAPI
areDocumentsSearchable, areDocumentsSearchable, clearCheckpoints, countSyncedEntries, debug, enumerateCheckpointInfo, enumerateCheckpointInfo, enumerateSyncedEntries, error, getBestEffortOnStopSession, getCheckpoint, getCheckpoint, getConnectorName, getDocumentStatus, getDocumentStatusList, getLogger, getParent, info, isTraceEnabled, log, ping, setBestEffortOnStopSession, setLogger, suggestSyncedEntries, trace, 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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - defaultMaxDocuments
```
public static final int defaultMaxDocuments
```
    Default maximum number of background documents per operation.
    
    See Also:
    
    Constant Field Values
  - defaultMaxBytes
```
public static final long defaultMaxBytes
```
    Default maximum total size of background documents (estimated)
    
    See Also:
    
    Constant Field Values
  - maxDocuments
```
protected final int maxDocuments
```
    Number of background documents
  - maxBytes
```
protected final long maxBytes
```
    Maximum document total size to buffer
  - worker
```
protected final BackgroundPushAPI.BackgroundWorker worker
```
    Worker thread.
- Constructor Detail
  - BackgroundPushAPI
```
public BackgroundPushAPI(PushAPI parent)
```
    Create a new BackgroundPushAPI
    
    Parameters:
    
    parent - the original PAPI
    
    maxDocuments - buffer size in document
  - BackgroundPushAPI
```
public BackgroundPushAPI(PushAPI parent,
                         int maxDocuments)
```
    Create a new BackgroundPushAPI
    
    Parameters:
    
    parent - the original PAPI
    
    maxDocuments - buffer size in document, or @c -1 if unlimited
  - BackgroundPushAPI
```
public BackgroundPushAPI(PushAPI parent,
                         int maxDocuments,
                         long maxBytes)
```
    Create a new BackgroundPushAPI
    
    Parameters:
    
    parent - the original PAPI
    
    maxDocuments - background size in document
    
    maxBytes - maximum background total document size in bytes
- Method Detail
  - createPushAPIPlugin
```
public static PushAPI createPushAPIPlugin(PushAPI papi,
                                          java.lang.String[] keys,
                                          java.lang.String[] values)
                                   throws java.lang.Exception
```
    Create a new BackgroundPushAPI (PushAPI plugin pipe constructor)
    Parameters:
    
    papi - upstream PushAPI
    
    keys - configuration keys (see below)
    keys - configuration values Configuration keys are:
    
    "MaxDocuments" background size in document
    
    "MaxBytes" maximum background total document size in bytes
    Throws:
    
    java.lang.Exception
  - close
```
public void close()
           throws java.io.IOException
```
    Closes the BackgroundPushAPI object.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - push
```
protected void push(BackgroundPushAPI.BackgroundWorkerItem item)
             throws PushAPIException
```
    Push an operation.
    
    Throws:
    
    PushAPIException
  - flush
```
public void flush()
           throws java.io.IOException
```
    Flush (ie. wait for pending operations to be finished)
    
    Specified by:
    
    flush in interface java.io.Flushable
    
    Throws:
    
    java.io.IOException
  - flushAll
```
public void flushAll()
              throws PushAPIException
```
    Flush (ie. wait for pending operations to be finished)
    
    Throws:
    
    PushAPIException
  - startWorker
```
public void startWorker()
```
    Ensure worker thread is started.
  - stopWorker
```
public void stopWorker()
```
    Ensure worker thread is ended.
  - flushCurrent
```
public void flushCurrent()
                  throws PushAPIException
```
    Flush current (ie. wait for pending operations added before this call to be finished, but do not wait for operations that might be added in the meantime) This function is thread-safe.
    
    Throws:
    
    PushAPIException
  - finalize
```
protected void finalize()
                 throws java.io.IOException
```
    Finalizer.
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.io.IOException
  - addDocument
```
public void addDocument(Document document)
                 throws PushAPIException
```
    Description copied from class: PushAPI
    
    Adds a document. If a document with the same URI has already been added, the document will be updated.
    
    Overrides:
    
    addDocument in class PipedPushAPI
    
    Parameters:
    
    document - Document to be added.
    
    Throws:
    
    PushAPIException - upon error
  - addDocumentList
```
public void addDocumentList(Document[] documents)
                     throws PushAPIException
```
    Description copied from class: PushAPI
    
    Adds a set of documents. If a document with the same URI has already been added, the document will be updated.
    
    Overrides:
    
    addDocumentList in class PipedPushAPI
    
    Parameters:
    
    documents - Documents to be added.
    
    Throws:
    
    PushAPIException - upon error.
  - clearAllCheckpoints
```
public void clearAllCheckpoints()
                         throws PushAPIException
```
    Description copied from class: PushAPI
    
    Resets all the checkpoints values.
    
    Overrides:
    
    clearAllCheckpoints in class PipedPushAPI
    
    Throws:
    
    PushAPIException - upon error
  - deleteDocument
```
public void deleteDocument(java.lang.String uri)
                    throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a document specified by its URI. If the document does not exist yet, the instruction is silently ignored.
    
    Overrides:
    
    deleteDocument in class PipedPushAPI
    
    Parameters:
    
    uri - the URI of the document to delete
    
    Throws:
    
    PushAPIException - upon error
  - deleteDocumentList
```
public void deleteDocumentList(java.lang.String[] uris)
                        throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a list of documents specified by their URIs. For each document which do not exist yet, the instruction is silently ignored.
    
    Overrides:
    
    deleteDocumentList in class PipedPushAPI
    
    Parameters:
    
    uris - the list of URIs of the documents to delete
    
    Throws:
    
    PushAPIException - upon error
  - deleteDocumentList
```
public void deleteDocumentList(int[] did,
                               int[] slices)
                        throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a list of documents specified by their dids and slices. For each document which does not exist yet, the instruction is silently ignored.
    
    Overrides:
    
    deleteDocumentList in class PipedPushAPI
    
    slices - the list of slices to delete.
    
    Throws:
    
    PushAPIException
  - deleteDocumentRootPath
```
public void deleteDocumentRootPath(java.lang.String rootPath,
                                   boolean recursive,
                                   boolean clearCache)
                            throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a set of documents corresponding to a URI prefix. All the documents matching the rootPath prefix will be deleted.
    Overrides:
    
    deleteDocumentRootPath in class PipedPushAPI
    
    Parameters:
    rootPath - a URI prefix used to select the documents to be deleted.
    
    Examples:
    
    the empty string selects all the URIs in the connector's corpus
    
    the string "A" would select all URIs in the form "A/xyz"
    
    the string "A/B" would select all URIs in the form "A/B/xyz"
    recursive - The recursive flag indicates if the URI pattern specified in rootPath should match multiple depth levels in the URI tree. For example the rootPath "A/B" will always match "A/B/C", but will match "A/B/C/D" only if recursive is true. In CloudView 5.1 recursive is always true.
    
    clearCache - The clearCache flag indicates if we want to delete documents from the document cache when they are deleted from the index.
    
    Throws:
    
    PushAPIException
  - deleteDocumentsWithPrefix
```
public void deleteDocumentsWithPrefix(java.lang.String prefix,
                                      boolean clearCache)
                               throws PushAPIException
```
    Description copied from class: PushAPI
    
    Deletes a set of documents corresponding to a URI prefix. All the documents matching the prefix will be deleted.
    
    Overrides:
    
    deleteDocumentsWithPrefix in class PipedPushAPI
    
    Parameters:
    
    prefix - a URI prefix used to select the documents to be deleted.
    
    clearCache - The clearCache flag indicates if we want to delete documents from the document cache when they are deleted from the index.
    
    Throws:
    
    PushAPIException
  - setCheckpoint
```
public java.math.BigInteger setCheckpoint(java.lang.String value,
                                          java.lang.String name,
                                          boolean sync)
                                   throws PushAPIException
```
    Description copied from class: PushAPI
    Sets a checkpoint in the push server. Checkpoints are used when:
    - The connector must process a journalized or logged data source, which can be abstractly represented as a flow of "add" and "delete" events in the corpus and where an id can be used to refer to events on a timeline. The Connector will then call from time to time the setCheckpoint command with the id referring to the last add or delete events which have been sent to the push server.
    - Crash-proof synchronization is required. Upon crash, or system restart, the Connector will call the getCheckpoint method to retrieve the last checkpoint saved by the push server. It is guaranteed that any add or delete commands called before that checkpoint were saved and will never be lost.
    - In order to keep track of the synchronization.
    If the checkpoint already exists, it's value is replaced with the new value.
    Note that on the server side, checkpoints are not automatically synchronized on disk, unless you set the value of the sync attribute to true. This means that a getCheckpoint operation called immediately after a setCheckpoint operation might not return the last value set. Refer to the EXALEAD CloudView documentation for more information on the handling of indexing tasks by the push server.
    The setCheckpoint operation returns the serial of the last pending operation before the checkpoint which can be used to check when the documents sent prior this checkpoint can be searched. See PushAPI.areDocumentsSearchable(BigInteger) for more information.
    Overrides:
    
    setCheckpoint in class PipedPushAPI
    
    Parameters:
    
    value - the value of the checkpoint.
    
    name - the name of the checkpoint.
    
    sync - if all the pending operations in the task log should be synchronized to disk before returning.
    
    Returns:
    
    the serial of the last pending operation before the checkpoint.
    
    Throws:
    
    PushAPIException - upon error
    
    See Also:
    
    PushAPI.synchronize(), PushAPI.areDocumentsSearchable(BigInteger)
  - 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}
  - sync
```
public void sync()
          throws PushAPIException
```
    Deprecated. since V6R2015x, replaced by synchronize()
    
    Description copied from class: PushAPI
    
    Forces the synchronization of all pending operations before returning.
    Every operation sent to the push server is kept in a tasks log. These tasks are not automatically synchronized to disk as the synchronization operation requires the use of IO operations which can consume some time. Thus, the synchronization is done asynchronously. This method can be used to force the tasks log synchronization. Refer to the EXALEAD CloudView documentation for more information on the tasks log and related components.
    Since V6R2015x, PushAPI.synchronize() has been introduced and returns a serial.
    
    Overrides:
    
    sync in class PipedPushAPI
    
    Throws:
    
    PushAPIException - upon error
  - synchronize
```
public java.math.BigInteger synchronize()
                                 throws PushAPIException
```
    Description copied from class: PushAPI
    
    Forces the synchronization of all pending operations before returning.
    Every operation sent to the push server is kept in a tasks log. These tasks are not automatically synchronized to disk as the synchronization operation requires the use of IO operations which can consume some time. Thus, the synchronization is done asynchronously. This method can be used to force the tasks log synchronization. Refer to the EXALEAD CloudView documentation for more information on the tasks log and related components. Returns the serial of the last pending operation before the synchronize.
    
    Overrides:
    
    synchronize in class PipedPushAPI
    
    Returns:
    
    the serial of the last pending operation before the synchronize
    
    Throws:
    
    PushAPIException - upon error
  - triggerIndexingJob
```
public void triggerIndexingJob()
                        throws PushAPIException
```
    Description copied from class: PushAPI
    
    Forces the processing of all pending operations synchronized to disk. Indexing operations are processed asynchronously, using a batch of operations found in the task logs. An internal scheduler periodically triggers indexing operations but you can also use this API call to force the indexing. Refer to EXALEAD CloudView documentation for more information on the scheduling of indexing jobs.
    Note that this call only impacts operation which are already synchronized to disk. Synchronization to disk happens periodically, and it can also be forced by using the setCheckpoint call with the sync parameter or by using the sync call.
    
    Overrides:
    
    triggerIndexingJob in class PipedPushAPI
    
    Throws:
    
    PushAPIException - upon error
  - triggerIndexingJobWhenIdle
```
public void triggerIndexingJobWhenIdle()
                                throws PushAPIException
```
    Description copied from class: PushAPI
    
    Wait for indexing to be idle, and forces the processing of all pending operations synchronized to disk. Indexing operations are processed asynchronously, using a batch of operations found in the task logs. An internal scheduler periodically triggers indexing operations but you can also use this API call to force the indexing. Refer to Exalead CloudView documentation for more information on the scheduling of indexing jobs.
    Note that this call only impacts operation which are already synchronized to disk. Synchronization to disk happens periodically, and it can also be forced by using the setCheckpoint call with the sync parameter or by using the sync call.
    
    Overrides:
    
    triggerIndexingJobWhenIdle in class PipedPushAPI
    
    Throws:
    
    PushAPIException - upon error
  - updateDocument
```
public void updateDocument(Document doc,
                           java.lang.String[] fields)
                    throws PushAPIException
```
    Description copied from class: PushAPI
    
    Partially updates a document. This method updates a document which must have the same URI as the one to be updated. Note that the fields parameter is useless for the moment, it is not handled yet. This methods also updates the indexed document stamp.
    
    Overrides:
    
    updateDocument in class PipedPushAPI
    
    Parameters:
    
    doc - a Document object specifying the URI of the document to be updated. Parts and metas that are not updated with the document are fetched from the document cache, so the document cache *must* be enabled, and only documents added after the document cache has been enabled can be updated. Old values of multivalued metas will be dropped, if you want to update a multivalued meta you have to put new values and also the old values you want to keep in the document.
    
    fields - Not used for the moment.
    
    Throws:
    
    PushAPIException
  - updateDocumentList
```
public void updateDocumentList(Document[] documents,
                               java.lang.String[][] fieldsList)
                        throws PushAPIException
```
    Description copied from class: PushAPI
    
    Updates a set of documents. If one of the documents does not exist, an error is returned by the push server. As the update document commands are processed sequentially, all the updates prior to the one which failed are taken into account. However, consider it is required to send again the whole set of documents once the document in error has been removed from the list.
    
    Overrides:
    
    updateDocumentList in class PipedPushAPI
    
    Parameters:
    
    documents - the list of documents to update
    
    fieldsList - for each document, the fields to be updated
    
    Throws:
    
    PushAPIException - upon error
    
    See Also:
    
    PushAPI.updateDocument(Document, String[])
  - updateDocumentMetas
```
public void updateDocumentMetas(java.lang.String uri,
                                java.lang.String stamp,
                                MetaContainer metaContainer)
                         throws PushAPIException
```
    Description copied from class: PushAPI
    
    Updates the stamp and the meta data of a document, using a strict meta to field mapping. Usage of this method is not recommended. This method should be used with caution. It's actually a simple wrapper on top of the method PushAPI.updateDocument(Document, String[]) which automatically creates the list of index fields from the meta names found in the meta data container.
    This method will often not do what you want, because of internal remapping between metas and fields. If you use this method to update the meta "meta1", but it's actually sent to an index field document_meta1 (as it's often the case with the data model), the update will not work as expected. If we reuse the sample described in the comments of the method PushAPI.updateDocument(Document, String[]), this gives:
    MetaContainer cont = new MetaContainer(); cont.addMeta("organization", "myneworg"); papi.updateDocument("mydocument", null, cont);
    If the document does not exist yet, an error is returned by the push server.
    
    Overrides:
    
    updateDocumentMetas in class PipedPushAPI
    
    Parameters:
    
    uri - the URI of the document to update
    
    stamp - the new document stamp
    
    metaContainer - the container of meta to be updated
    
    Throws:
    
    PushAPIException - upon error
  - updateDocumentMetasList
```
public void updateDocumentMetasList(java.lang.String[] uriList,
                                    java.lang.String[] stampList,
                                    MetaContainer[] metaContainerList)
                             throws PushAPIException
```
    Description copied from class: PushAPI
    
    Updates a set of the stamp and meta data for given documents. Usage of this method is not recommended. This method should be used with caution. It's actually a simple wrapper on top of the method PushAPI.updateDocument(Document, String[]) which automatically creates the list of index fields from the meta names found in the meta data container.
    This method will often not do what you want, because of internal remapping between metas and fields. If you use this method to update the meta "meta1", but it's actually sent to an index field document_meta1 (as it's often the case with the data model), the update will not work as expected. If one of the documents does not exist, an error is returned by the push server. As the update document commands are processed sequentially, all the updates priori to the one which failed are taken into account. However, consider it is require to send again the whole set of documents once the document in error has been removed from the list.
    
    Overrides:
    
    updateDocumentMetasList in class PipedPushAPI
    
    Parameters:
    
    uriList - the URIs of the documents to update
    
    stampList - the list of new stamps
    
    metaContainerList - the list of meta data containers
    
    Throws:
    
    PushAPIException - upon error
    
    See Also:
    
    PushAPI.updateDocumentMetas(java.lang.String, java.lang.String, com.exalead.papi.helper.MetaContainer)

Class BackgroundPushAPI

Nested Class Summary

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

defaultMaxDocuments

defaultMaxBytes

maxDocuments

maxBytes

worker

Constructor Detail

BackgroundPushAPI

BackgroundPushAPI

BackgroundPushAPI

Method Detail

createPushAPIPlugin

close

push

flush

flushAll

startWorker

stopWorker

flushCurrent

finalize

addDocument

addDocumentList

clearAllCheckpoints

deleteDocument

deleteDocumentList

deleteDocumentList

deleteDocumentRootPath

deleteDocumentsWithPrefix

setCheckpoint

startPushSession

stopPushSession

sync

synchronize

triggerIndexingJob

triggerIndexingJobWhenIdle

updateDocument

updateDocumentList

updateDocumentMetas

updateDocumentMetasList