BufferedPushAPI (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.papi.helper.PushAPI
- - com.exalead.papi.helper.pipe.PipedPushAPI
  - - com.exalead.papi.helper.pipe.buffered.BufferedPushAPI

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
```
public class BufferedPushAPI
extends PipedPushAPI
implements java.io.Flushable, java.io.Closeable
```
Buffered Push API. This class allows to extend an existing PushAPI to handle buffered add, delete and update operations. 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 flushAll() function was used to force the flushing of all buffers. The deleteDocumentList(int[] did, int[] slices) variant is not currently cacheable. Important note: the default behaviour is not to flush anything unless it is necessary. The calling client MUST ensure that flushAll() (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 flushAll() before they can be executed: ("flushing operations") startPushSession() stopPushSession() sync() triggerIndexingJob() setCheckpoint() clearAllCheckpoints() The following operations imply a flushCurrent() before they can be executed: deleteDocumentList(int[] did, int[] slices) deleteDocumentRootPath()

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`BufferedPushAPI.BufferedPushAPINotify` Thread termination notifier.
`static interface`	`BufferedPushAPI.Notifiable` Interface used when an object wants to notify an event.
`protected static class`	`BufferedPushAPI.TBuffer` Class aimed to buffer a generic operation (add, delete..) Upper-level synchronization is necessary.
`protected static class`	`BufferedPushAPI.ThreadVarFinalizer` Class used to handle thread finalization in thread-mapped hashtable.
`protected static class`	`BufferedPushAPI.ThreadVarFinalizerItem` Class used to handle thread finalization in thread-mapped hashtable.
`protected class`	`BufferedPushAPI.TOperationBuffer` Class aimed to buffer all operations (add,update..) in a given thread.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.concurrent.ConcurrentLinkedQueue<java.lang.Long>`	`cleaners` Cleaners, list of ids of threads which died before cleaning up their buffers.
`static long`	`defaultMaxBytes` Default maximum total size of buffered documents (estimated)
`static int`	`defaultMaxDocuments` Default maximum number of buffered documents per operation.
`protected static int`	`DOCUMENT_OVERHEAD_PENALTY` Penalty applied to estimate documents size for each document.
`protected static int`	`ELEMENT_OVERHEAD_PENALTY` Penalty applied to estimate documents size for each sub-element.
`protected long`	`maxBytes` Maximum document total size to buffer
`protected int`	`maxDocuments` Number of buffered documents
`protected BufferedPushAPI.BufferedPushAPINotify`	`notifier` Thread termination notifier.
`protected java.util.concurrent.locks.ReentrantReadWriteLock`	`producers` Lock for the ConcurrentHashMap ; readers will only use (read/write) their current buffer ; writer is allowed to enumerate all thread buffers.
`protected java.util.concurrent.ConcurrentHashMap<java.lang.Long,BufferedPushAPI.TOperationBuffer>`	`threadBuffer` Thread buffers.

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

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 BufferedPushAPI object.
`static PushAPI`	`createPushAPIPlugin(PushAPI papi, java.lang.String[] keys, java.lang.String[] values)` Create a new BufferedPushAPI (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 all pending buffers.
`void`	`flushAll()` Flush all buffers for all threads.
`void`	`flushCurrent()` Flush current thread's buffer.
`protected void`	`flushDeadBuffers()` Process dead thread buffers in the PAPI (flushes commands).
`void`	`free()` Flush and clear all buffers for all threads.
`protected BufferedPushAPI.TOperationBuffer`	`getThreadBuffer(java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock lock)`
`protected BufferedPushAPI.TOperationBuffer`	`getThreadBuffer(java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock lock, boolean create)`
`protected long`	`getThreadBufferKey()`
`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`	`stopPushSession(boolean releaseConnections)` Stops the current session on the push server.
`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[] docList, 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 buffered documents per operation.
    
    See Also:
    
    Constant Field Values
  - defaultMaxBytes
```
public static final long defaultMaxBytes
```
    Default maximum total size of buffered documents (estimated)
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_OVERHEAD_PENALTY
```
protected static final int DOCUMENT_OVERHEAD_PENALTY
```
    Penalty applied to estimate documents size for each document.
    
    See Also:
    
    Constant Field Values
  - ELEMENT_OVERHEAD_PENALTY
```
protected static final int ELEMENT_OVERHEAD_PENALTY
```
    Penalty applied to estimate documents size for each sub-element.
    
    See Also:
    
    Constant Field Values
  - maxDocuments
```
protected final int maxDocuments
```
    Number of buffered documents
  - maxBytes
```
protected final long maxBytes
```
    Maximum document total size to buffer
  - threadBuffer
```
protected java.util.concurrent.ConcurrentHashMap<java.lang.Long,BufferedPushAPI.TOperationBuffer> threadBuffer
```
    Thread buffers. The key is the thread id, and the value the TOperationBuffer object which caches add/delete/.. operations. This hashtable is thread-safe ; underlying objects are locked on the low level operations.
  - producers
```
protected java.util.concurrent.locks.ReentrantReadWriteLock producers
```
    Lock for the ConcurrentHashMap ; readers will only use (read/write) their current buffer ; writer is allowed to enumerate all thread buffers. Note: dead thread id's, once acquired atomically from notifier, are useable by readers, as they are temporarily the new (live) holder
  - notifier
```
protected BufferedPushAPI.BufferedPushAPINotify notifier
```
    Thread termination notifier.
  - cleaners
```
protected java.util.concurrent.ConcurrentLinkedQueue<java.lang.Long> cleaners
```
    Cleaners, list of ids of threads which died before cleaning up their buffers. Other threads will pick up work in this list and do the job.
- Constructor Detail
  - BufferedPushAPI
```
public BufferedPushAPI(PushAPI parent)
```
    Create a new BufferedPushAPI
    
    Parameters:
    
    parent - the original PAPI
    
    maxDocuments - buffer size in document
  - BufferedPushAPI
```
public BufferedPushAPI(PushAPI parent,
                       int maxDocuments)
```
    Create a new BufferedPushAPI
    
    Parameters:
    
    parent - the original PAPI
    
    maxDocuments - buffer size in document, or @c -1 if unlimited
  - BufferedPushAPI
```
public BufferedPushAPI(PushAPI parent,
                       int maxDocuments,
                       long maxBytes)
```
    Create a new BufferedPushAPI
    
    Parameters:
    
    parent - the original PAPI
    
    maxDocuments - buffered size in document
    
    maxBytes - maximum buffered 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 BufferedPushAPI (PushAPI plugin pipe constructor)
    Parameters:
    
    papi - upstream PushAPI
    
    keys - configuration keys (see below)
    keys - configuration values Configuration keys are:
    
    "MaxDocuments" buffered size in document
    
    "MaxBytes" maximum buffered total document size in bytes
    Throws:
    
    java.lang.Exception
  - getThreadBufferKey
```
protected long getThreadBufferKey()
```
  - getThreadBuffer
```
protected BufferedPushAPI.TOperationBuffer getThreadBuffer(java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock lock,
                                                           boolean create)
```
  - getThreadBuffer
```
protected BufferedPushAPI.TOperationBuffer getThreadBuffer(java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock lock)
```
  - flushDeadBuffers
```
protected void flushDeadBuffers()
                         throws PushAPIException
```
    Process dead thread buffers in the PAPI (flushes commands).
    
    Throws:
    
    PushAPIException
  - flushCurrent
```
public void flushCurrent()
                  throws PushAPIException
```
    Flush current thread's buffer.
    
    Throws:
    
    PushAPIException
  - flushAll
```
public void flushAll()
              throws PushAPIException
```
    Flush all buffers for all threads. Frequent use of this function is discouraged, as it blocks all other threads until all buffers are flushed synchronously in the current thread. This function MUST be called at the end of processing (directly, or indirectly, by calling a flushing operation such as setCheckPoint()) to ensure that the underlying PushAPI receives buffered operations.
    
    Throws:
    
    PushAPIException
  - flush
```
public void flush()
           throws java.io.IOException
```
    Flush all pending buffers. Equivalent to a call to flushAll()
    
    Specified by:
    
    flush in interface java.io.Flushable
    
    Throws:
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    Closes the BufferedPushAPI object. Equivalent to a call to free()
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - finalize
```
protected void finalize()
                 throws java.io.IOException
```
    Finalizer.
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.io.IOException
  - free
```
public void free()
          throws PushAPIException
```
    Flush and clear all buffers for all threads.
    
    Throws:
    
    PushAPIException
  - 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[] docList,
                               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:
    
    docList - 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 BufferedPushAPI

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

DOCUMENT_OVERHEAD_PENALTY

ELEMENT_OVERHEAD_PENALTY

maxDocuments

maxBytes

threadBuffer

producers

notifier

cleaners

Constructor Detail

BufferedPushAPI

BufferedPushAPI

BufferedPushAPI

Method Detail

createPushAPIPlugin

getThreadBufferKey

getThreadBuffer

getThreadBuffer

flushDeadBuffers

flushCurrent

flushAll

flush

close

finalize

free

addDocument

addDocumentList

clearAllCheckpoints

deleteDocument

deleteDocumentList

deleteDocumentList

deleteDocumentRootPath

deleteDocumentsWithPrefix

setCheckpoint

startPushSession

stopPushSession

sync

synchronize

triggerIndexingJob

triggerIndexingJobWhenIdle

updateDocument

updateDocumentList

updateDocumentMetas

updateDocumentMetasList