TracePushAPI (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.papi.helper.PushAPI
- - com.exalead.papi.helper.pipe.PipedPushAPI
  - - com.exalead.papi.helper.pipe.trace.TracePushAPI

```
public class TracePushAPI
extends PipedPushAPI
```
Trace Push API. This class allows to trace PushAPI commands: - total time spent outside the PushAPI (ie. in the connector) - total time spent in PushAPI commands - number of document commands per second, aggregated (ie. list commands count for several hits) - volume of data processed by addDocument and addDocumentList Note: the starting and ending time statistics are base on the time collected by startPushSession and stopPushSession. This class can also perform basic tests on sent documents.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`TracePushAPI.SortedTick`
`protected static class`	`TracePushAPI.SortedTickComparator`
`class`	`TracePushAPI.StatSlice` Piece of stat.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_LOG_OPERATIONS_FREQUENCY`
`protected long`	`end`
`protected TracePushAPI.StatSlice[]`	`fcount`
`protected static boolean`	`isCurrentThreadCpuTimeSupported`
`protected static int`	`OPERATION_ADDDOCUMENT`
`protected static int`	`OPERATION_ADDDOCUMENTLIST`
`protected static int`	`OPERATION_AREDOCUMENTSSEARCHABLE`
`protected static int`	`OPERATION_CLEARALLCHECKPOINTS`
`protected static int`	`OPERATION_COUNTSYNCEDENTRIES`
`protected static int`	`OPERATION_DELETEDOCUMENSWITHPREFIX`
`protected static int`	`OPERATION_DELETEDOCUMENT`
`protected static int`	`OPERATION_DELETEDOCUMENTLIST`
`protected static int`	`OPERATION_DELETEDOCUMENTLIST_DID`
`protected static int`	`OPERATION_DELETEDOCUMENTROOTPATH`
`protected static int`	`OPERATION_ENUMERATECHECKPOINTINFO`
`protected static int`	`OPERATION_ENUMERATESTATEDCHECKPOINTINFO`
`protected static int`	`OPERATION_ENUMERATESYNCEDENTRIES`
`protected static int`	`OPERATION_FAMILY_ADDDOCUMENT`
`protected static int`	`OPERATION_FAMILY_DELETEDOCUMENT`
`protected static int`	`OPERATION_FAMILY_MAX`
`protected static int`	`OPERATION_FAMILY_MIN`
`protected static int`	`OPERATION_FAMILY_UPDATEDOCUMENT`
`protected static int`	`OPERATION_FAMILY_UPDATEDOCUMENTMETAS`
`protected static int`	`OPERATION_GETCHECKPOINT`
`protected static int`	`OPERATION_GETCHECKPOINTINFO`
`protected static int`	`OPERATION_GETCONNECTORNAME`
`protected static int`	`OPERATION_GETDOCUMENTSTATUS`
`protected static int`	`OPERATION_GETDOCUMENTSTATUSLIST`
`protected static int`	`OPERATION_IN_CONNECTOR`
`protected static int`	`OPERATION_MAX`
`protected static int`	`OPERATION_MIN`
`protected static int`	`OPERATION_PING`
`protected static int`	`OPERATION_SETCHECKPOINT`
`protected static int`	`OPERATION_STARTPUSHSESSION`
`protected static int`	`OPERATION_STOPPUSHSESSION`
`protected static int`	`OPERATION_SYNC`
`protected static int`	`OPERATION_TRIGGERINDEXINGJOB`
`protected static int`	`OPERATION_TRIGGERINDEXINGJOBWHENIDLE`
`protected static int`	`OPERATION_UPDATEDOCUMENT`
`protected static int`	`OPERATION_UPDATEDOCUMENTLIST`
`protected static int`	`OPERATION_UPDATEDOCUMENTMETAS`
`protected static int`	`OPERATION_UPDATEDOCUMENTMETASLIST`
`protected long`	`start`
`protected boolean`	`testAPICompliance`
`protected boolean`	`testMandatoryStamp`
`protected boolean`	`testNullMetas`
`protected boolean`	`testNullURI`
`protected static java.lang.management.ThreadMXBean`	`threadBean`
`protected java.lang.ThreadLocal<java.lang.Long>`	`threadTime`
`protected TracePushAPI.StatSlice[]`	`tick`
`protected java.lang.Long`	`volumeBytes`
`protected java.util.concurrent.locks.ReentrantLock`	`volumeBytesLock`

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
`TracePushAPI(PushAPI source)` Create a new TracePushAPI
`TracePushAPI(PushAPI source, long logOperationsFrequency)` Create a new TracePushAPI

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.
`boolean`	`areDocumentsSearchable(java.math.BigInteger serial)` Checks whether documents sent prior a given setCheckpoint operation are searchable.
`protected static java.lang.String`	`bytesToString(long bytes)`
`protected PushAPIException`	`catchOperation(int operation, java.lang.Exception e)`
`protected void`	`clear()`
`void`	`clearAllCheckpoints()` Resets all the checkpoints values.
`long`	`countSyncedEntries(java.lang.String rootPath, EnumerationMode mode)` Counts the number of synchronized entries.
`static PushAPI`	`createPushAPIPlugin(PushAPI papi, java.lang.String[] keys, java.lang.String[] values)` Create a new TracePushAPI (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 static long`	`documentSize(Document document)` Get a Document estimated size.
`protected void`	`endOperation(int operation, long start)`
`protected void`	`endOperations()`
`java.lang.Iterable<CheckpointInfo>`	`enumerateCheckpointInfo()` Enumerates all the checkpoints known by the system (synchronized).
`java.lang.Iterable<CheckpointInfo>`	`enumerateCheckpointInfo(boolean showSynchronizedOnly)` Enumerates all the checkpoints.
`java.lang.Iterable<SyncedEntry>`	`enumerateSyncedEntries(java.lang.String rootPath, EnumerationMode mode)` Enumerates synchronized entries.
`protected void`	`finalize()` Finalizer.
`protected static java.lang.String`	`formatK(long i)`
`java.lang.String`	`getCheckpoint(java.lang.String name)` Gets the value of a named checkpoint in the indexing process.
`CheckpointInfo`	`getCheckpoint(java.lang.String name, boolean showSynchronizedOnly)` Gets the checkpoint detailed information.
`java.lang.String`	`getConnectorName()` Gets the name of the connector associated to this push client.
`protected static long`	`getCurrentThreadCpuTime()`
`DocumentStatus`	`getDocumentStatus(java.lang.String uri)` Gets document status.
`DocumentStatus[]`	`getDocumentStatusList(java.lang.String[] uris)` Gets the status of a given list of documents in the push server.
`protected java.lang.String`	`getFamilyOperationName(int op)`
`protected java.lang.String`	`getOperationName(int op)`
`protected void`	`incBytes(long size)`
`protected void`	`incOperationFamily(int fop)`
`protected void`	`incOperationFamily(int fop, int count)`
`protected static java.lang.String`	`nsToString(long ns)`
`void`	`ping()` Tests the connection with the server.
`java.math.BigInteger`	`setCheckpoint(java.lang.String value, java.lang.String name, boolean sync)` Sets a checkpoint in the push server.
`protected void`	`startOperations()`
`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.
`protected void`	`testDocument(Document doc)` Run all asked tests on a given document
`protected void`	`testDocument(java.lang.String uri, java.lang.String stamp, MetaContainer metas)` Run all asked tests on a given document
`protected void`	`testDocuments(Document... docs)` Run all asked tests on all given documents
`protected void`	`testDocuments(java.lang.String[] uriList, java.lang.String[] stampList, MetaContainer[] metaContainerList)` Run all asked tests on all given documents
`protected void`	`testMandatoryStamp(Document doc)` Test if the given document contain a non null stamp
`protected void`	`testNullMetas(MetaContainer metaContainer)` Test if all document's metas have a non null name and non null values
`protected void`	`testNullURI(Document doc)` Test if the given document has a non null URI
`protected void`	`testUniqueStreams(Document doc)` Test if all document's parts give a new stream each time getStream is called
`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, clearCheckpoints, debug, error, getBestEffortOnStopSession, getLogger, getParent, info, isTraceEnabled, log, 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
  - start
```
protected long start
```
  - end
```
protected long end
```
  - testMandatoryStamp
```
protected boolean testMandatoryStamp
```
  - testNullURI
```
protected boolean testNullURI
```
  - testAPICompliance
```
protected boolean testAPICompliance
```
  - testNullMetas
```
protected boolean testNullMetas
```
  - tick
```
protected TracePushAPI.StatSlice[] tick
```
  - fcount
```
protected TracePushAPI.StatSlice[] fcount
```
  - volumeBytes
```
protected java.lang.Long volumeBytes
```
  - volumeBytesLock
```
protected final java.util.concurrent.locks.ReentrantLock volumeBytesLock
```
  - DEFAULT_LOG_OPERATIONS_FREQUENCY
```
public static final long DEFAULT_LOG_OPERATIONS_FREQUENCY
```
    See Also:
    
    Constant Field Values
  - threadTime
```
protected final java.lang.ThreadLocal<java.lang.Long> threadTime
```
  - threadBean
```
protected static java.lang.management.ThreadMXBean threadBean
```
  - isCurrentThreadCpuTimeSupported
```
protected static boolean isCurrentThreadCpuTimeSupported
```
  - OPERATION_MIN
```
protected static final int OPERATION_MIN
```
    See Also:
    
    Constant Field Values
  - OPERATION_ADDDOCUMENT
```
protected static final int OPERATION_ADDDOCUMENT
```
    See Also:
    
    Constant Field Values
  - OPERATION_ADDDOCUMENTLIST
```
protected static final int OPERATION_ADDDOCUMENTLIST
```
    See Also:
    
    Constant Field Values
  - OPERATION_AREDOCUMENTSSEARCHABLE
```
protected static final int OPERATION_AREDOCUMENTSSEARCHABLE
```
    See Also:
    
    Constant Field Values
  - OPERATION_CLEARALLCHECKPOINTS
```
protected static final int OPERATION_CLEARALLCHECKPOINTS
```
    See Also:
    
    Constant Field Values
  - OPERATION_COUNTSYNCEDENTRIES
```
protected static final int OPERATION_COUNTSYNCEDENTRIES
```
    See Also:
    
    Constant Field Values
  - OPERATION_DELETEDOCUMENT
```
protected static final int OPERATION_DELETEDOCUMENT
```
    See Also:
    
    Constant Field Values
  - OPERATION_DELETEDOCUMENTLIST
```
protected static final int OPERATION_DELETEDOCUMENTLIST
```
    See Also:
    
    Constant Field Values
  - OPERATION_DELETEDOCUMENTLIST_DID
```
protected static final int OPERATION_DELETEDOCUMENTLIST_DID
```
    See Also:
    
    Constant Field Values
  - OPERATION_DELETEDOCUMENTROOTPATH
```
protected static final int OPERATION_DELETEDOCUMENTROOTPATH
```
    See Also:
    
    Constant Field Values
  - OPERATION_ENUMERATECHECKPOINTINFO
```
protected static final int OPERATION_ENUMERATECHECKPOINTINFO
```
    See Also:
    
    Constant Field Values
  - OPERATION_ENUMERATESYNCEDENTRIES
```
protected static final int OPERATION_ENUMERATESYNCEDENTRIES
```
    See Also:
    
    Constant Field Values
  - OPERATION_GETCHECKPOINT
```
protected static final int OPERATION_GETCHECKPOINT
```
    See Also:
    
    Constant Field Values
  - OPERATION_GETCONNECTORNAME
```
protected static final int OPERATION_GETCONNECTORNAME
```
    See Also:
    
    Constant Field Values
  - OPERATION_GETDOCUMENTSTATUS
```
protected static final int OPERATION_GETDOCUMENTSTATUS
```
    See Also:
    
    Constant Field Values
  - OPERATION_GETDOCUMENTSTATUSLIST
```
protected static final int OPERATION_GETDOCUMENTSTATUSLIST
```
    See Also:
    
    Constant Field Values
  - OPERATION_PING
```
protected static final int OPERATION_PING
```
    See Also:
    
    Constant Field Values
  - OPERATION_SETCHECKPOINT
```
protected static final int OPERATION_SETCHECKPOINT
```
    See Also:
    
    Constant Field Values
  - OPERATION_STARTPUSHSESSION
```
protected static final int OPERATION_STARTPUSHSESSION
```
    See Also:
    
    Constant Field Values
  - OPERATION_STOPPUSHSESSION
```
protected static final int OPERATION_STOPPUSHSESSION
```
    See Also:
    
    Constant Field Values
  - OPERATION_SYNC
```
protected static final int OPERATION_SYNC
```
    See Also:
    
    Constant Field Values
  - OPERATION_TRIGGERINDEXINGJOB
```
protected static final int OPERATION_TRIGGERINDEXINGJOB
```
    See Also:
    
    Constant Field Values
  - OPERATION_UPDATEDOCUMENT
```
protected static final int OPERATION_UPDATEDOCUMENT
```
    See Also:
    
    Constant Field Values
  - OPERATION_UPDATEDOCUMENTLIST
```
protected static final int OPERATION_UPDATEDOCUMENTLIST
```
    See Also:
    
    Constant Field Values
  - OPERATION_UPDATEDOCUMENTMETAS
```
protected static final int OPERATION_UPDATEDOCUMENTMETAS
```
    See Also:
    
    Constant Field Values
  - OPERATION_UPDATEDOCUMENTMETASLIST
```
protected static final int OPERATION_UPDATEDOCUMENTMETASLIST
```
    See Also:
    
    Constant Field Values
  - OPERATION_IN_CONNECTOR
```
protected static final int OPERATION_IN_CONNECTOR
```
    See Also:
    
    Constant Field Values
  - OPERATION_TRIGGERINDEXINGJOBWHENIDLE
```
protected static final int OPERATION_TRIGGERINDEXINGJOBWHENIDLE
```
    See Also:
    
    Constant Field Values
  - OPERATION_GETCHECKPOINTINFO
```
protected static final int OPERATION_GETCHECKPOINTINFO
```
    See Also:
    
    Constant Field Values
  - OPERATION_ENUMERATESTATEDCHECKPOINTINFO
```
protected static final int OPERATION_ENUMERATESTATEDCHECKPOINTINFO
```
    See Also:
    
    Constant Field Values
  - OPERATION_DELETEDOCUMENSWITHPREFIX
```
protected static final int OPERATION_DELETEDOCUMENSWITHPREFIX
```
    See Also:
    
    Constant Field Values
  - OPERATION_MAX
```
protected static final int OPERATION_MAX
```
    See Also:
    
    Constant Field Values
  - OPERATION_FAMILY_MIN
```
protected static final int OPERATION_FAMILY_MIN
```
    See Also:
    
    Constant Field Values
  - OPERATION_FAMILY_ADDDOCUMENT
```
protected static final int OPERATION_FAMILY_ADDDOCUMENT
```
    See Also:
    
    Constant Field Values
  - OPERATION_FAMILY_DELETEDOCUMENT
```
protected static final int OPERATION_FAMILY_DELETEDOCUMENT
```
    See Also:
    
    Constant Field Values
  - OPERATION_FAMILY_UPDATEDOCUMENT
```
protected static final int OPERATION_FAMILY_UPDATEDOCUMENT
```
    See Also:
    
    Constant Field Values
  - OPERATION_FAMILY_UPDATEDOCUMENTMETAS
```
protected static final int OPERATION_FAMILY_UPDATEDOCUMENTMETAS
```
    See Also:
    
    Constant Field Values
  - OPERATION_FAMILY_MAX
```
protected static final int OPERATION_FAMILY_MAX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TracePushAPI
```
public TracePushAPI(PushAPI source,
                    long logOperationsFrequency)
```
    Create a new TracePushAPI
    
    Parameters:
    
    source - The parent PushAPI
    
    logOperationsFrequency - Number of operations before adding a log entry
  - TracePushAPI
```
public TracePushAPI(PushAPI source)
```
    Create a new TracePushAPI
    
    Parameters:
    
    source - The parent PushAPI
- Method Detail
  - clear
```
protected void clear()
```
  - createPushAPIPlugin
```
public static PushAPI createPushAPIPlugin(PushAPI papi,
                                          java.lang.String[] keys,
                                          java.lang.String[] values)
                                   throws java.lang.Exception
```
    Create a new TracePushAPI (PushAPI plugin pipe constructor)
    
    Parameters:
    
    papi - upstream PushAPI
    
    keys - configuration keys (see below)
    
    keys - configuration values
    
    Throws:
    
    java.lang.Exception
  - getOperationName
```
protected java.lang.String getOperationName(int op)
```
  - getFamilyOperationName
```
protected java.lang.String getFamilyOperationName(int op)
```
  - getCurrentThreadCpuTime
```
protected static long getCurrentThreadCpuTime()
```
  - startOperations
```
protected void startOperations()
```
  - endOperations
```
protected void endOperations()
```
  - nsToString
```
protected static java.lang.String nsToString(long ns)
```
  - formatK
```
protected static java.lang.String formatK(long i)
```
  - bytesToString
```
protected static java.lang.String bytesToString(long bytes)
```
  - endOperation
```
protected void endOperation(int operation,
                            long start)
```
  - catchOperation
```
protected PushAPIException catchOperation(int operation,
                                          java.lang.Exception e)
```
  - incOperationFamily
```
protected void incOperationFamily(int fop,
                                  int count)
```
  - incBytes
```
protected void incBytes(long size)
```
  - incOperationFamily
```
protected void incOperationFamily(int fop)
```
  - finalize
```
protected void finalize()
                 throws java.io.IOException
```
    Finalizer.
    
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.io.IOException
  - documentSize
```
protected static long documentSize(Document document)
```
    Get a Document estimated size.
  - 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.
  - areDocumentsSearchable
```
public boolean areDocumentsSearchable(java.math.BigInteger serial)
                               throws PushAPIException
```
    Description copied from class: PushAPI
    
    Checks whether documents sent prior a given setCheckpoint operation are searchable.
    
    Overrides:
    
    areDocumentsSearchable in class PipedPushAPI
    
    Parameters:
    
    serial - the serial returned by a setCheckpoint operation
    
    Returns:
    
    true if the documents sent prior a given setCheckpoint are searchable
    
    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
  - countSyncedEntries
```
public long countSyncedEntries(java.lang.String rootPath,
                               EnumerationMode mode)
                        throws PushAPIException
```
    Description copied from class: PushAPI
    
    Counts the number of synchronized entries.
    
    Overrides:
    
    countSyncedEntries in class PipedPushAPI
    
    Parameters:
    
    rootPath - URI prefix used to select a subset of the corpus. Empty string can be used to delete the whole collection. The character '/' is used to build a hierarchical view of your corpus.
    
    mode - the enumeration mode.
    
    Returns:
    
    the number of synchronized entries found.
    
    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
  - enumerateCheckpointInfo
```
public java.lang.Iterable<CheckpointInfo> enumerateCheckpointInfo()
                                                           throws PushAPIException
```
    Description copied from class: PushAPI
    
    Enumerates all the checkpoints known by the system (synchronized).
    
    Overrides:
    
    enumerateCheckpointInfo in class PipedPushAPI
    
    Returns:
    
    an iterator over the checkpoints
    
    Throws:
    
    PushAPIException - upon error
    
    See Also:
    
    PushAPI.setCheckpoint(String, String, boolean), PushAPI.synchronize()
  - enumerateCheckpointInfo
```
public java.lang.Iterable<CheckpointInfo> enumerateCheckpointInfo(boolean showSynchronizedOnly)
                                                           throws PushAPIException
```
    Description copied from class: PushAPI
    
    Enumerates all the checkpoints.
    
    Overrides:
    
    enumerateCheckpointInfo in class PipedPushAPI
    
    Parameters:
    
    showSynchronizedOnly - if true, then returns synchronized (i.e safe) checkpoints, otherwise returns the unsynchronized checkpoints (in memory only) when more recent than the synchronized ones.
    
    Returns:
    
    an iterator over the checkpoints.
    
    Throws:
    
    PushAPIException - upon error
    
    See Also:
    
    PushAPI.setCheckpoint(String, String, boolean), PushAPI.synchronize()
  - enumerateSyncedEntries
```
public java.lang.Iterable<SyncedEntry> enumerateSyncedEntries(java.lang.String rootPath,
                                                              EnumerationMode mode)
                                                       throws PushAPIException
```
    Description copied from class: PushAPI
    
    Enumerates synchronized entries. Synchronized entries are entries that have been effectively synchronized to disk. This method allows you to enumerate both documents but also folders. Folders are virtual objects built from the document hierarchical view.
    
    Overrides:
    
    enumerateSyncedEntries in class PipedPushAPI
    
    Parameters:
    
    rootPath - URI prefix used to select a subset of the corpus. Empty string can be used to enumerate the whole collection. The character '/' is used to build a hierarchical view of your corpus.
    
    mode - the enumeration mode.
    
    Returns:
    
    an iterator over synchronized entries.
    
    Throws:
    
    PushAPIException - upon error
    
    See Also:
    
    #sync()}
  - getCheckpoint
```
public java.lang.String getCheckpoint(java.lang.String name)
                               throws PushAPIException
```
    Description copied from class: PushAPI
    
    Gets the value of a named checkpoint in the indexing process.
    
    Overrides:
    
    getCheckpoint in class PipedPushAPI
    
    Parameters:
    
    name - the name of the checkpoint
    
    Returns:
    
    the last synchronized value set for this checkpoint.
    
    Throws:
    
    PushAPIException - upon error
    
    See Also:
    
    PushAPI.setCheckpoint(String, String, boolean)
  - getCheckpoint
```
public CheckpointInfo getCheckpoint(java.lang.String name,
                                    boolean showSynchronizedOnly)
                             throws PushAPIException
```
    Description copied from class: PushAPI
    
    Gets the checkpoint detailed information.
    
    Overrides:
    
    getCheckpoint in class PipedPushAPI
    
    Parameters:
    
    name - the name of the checkpoint to retrieve.
    
    showSynchronizedOnly - if true, then returns the last synchronized (i.e safe) checkpoint, otherwise returns the unsynchronized checkpoint (in memory only) when more recent than the last synchronized one.
    
    Returns:
    
    the checkpoint detailed information. If CheckpointInfo.value is empty, then it means the checkpoint is not defined.
    
    Throws:
    
    PushAPIException
    
    See Also:
    
    PushAPI.setCheckpoint(String, String, boolean)
  - getConnectorName
```
public java.lang.String getConnectorName()
```
    Description copied from class: PushAPI
    
    Gets the name of the connector associated to this push client.
    
    Overrides:
    
    getConnectorName in class PipedPushAPI
    
    Returns:
    
    the name of the connector.
  - getDocumentStatus
```
public DocumentStatus getDocumentStatus(java.lang.String uri)
                                 throws PushAPIException
```
    Description copied from class: PushAPI
    
    Gets document status. Look up an URI in the CloudView push server and return the corresponding document's status if it exists. The status of a document indicates if the document currently exists in the push server and the corresponding stamp value if any. Note that the information retrieved by this method indicates only the document's status in the CloudView indexing queue, and does not indicate whether the document is actually visible to search queries. To check if a document is visible to search queries, please refer to the areDocumentsSearchable method.
    
    Overrides:
    
    getDocumentStatus in class PipedPushAPI
    
    Parameters:
    
    uri - the URI to be looked up.
    
    Returns:
    
    the document's status. Note that the getDocumentStatus method always returns a non-null DocumentStatus object. To check if the document actually exists in the index, please use the DocumentStatus.isExist() method.
    
    Throws:
    
    PushAPIException
    
    See Also:
    
    DocumentStatus
  - getDocumentStatusList
```
public DocumentStatus[] getDocumentStatusList(java.lang.String[] uris)
                                       throws PushAPIException
```
    Description copied from class: PushAPI
    
    Gets the status of a given list of documents in the push server.
    
    Overrides:
    
    getDocumentStatusList in class PipedPushAPI
    
    Parameters:
    
    uris - the URIs of the documents for which the status should be retrieved.
    
    Returns:
    
    for each document the corresponding status.
    
    Throws:
    
    PushAPIException - upon error
  - ping
```
public void ping()
          throws PushAPIException
```
    Description copied from class: PushAPI
    Tests the connection with the server. This test should be called after the construction of the Push API. The purpose of this method is to:
    - test the server availability
    - check for the existence of the connectorName and its security
    - compare the PAPI protocol versions
    Overrides:
    
    ping in class PipedPushAPI
    
    Throws:
    
    PushAPIException - upon error (invalid connector name or IO error)
  - 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)
  - testDocuments
```
protected void testDocuments(Document... docs)
                      throws TraceException
```
    Run all asked tests on all given documents
    
    Parameters:
    
    docs - documents to test
    
    Throws:
    
    TraceException - if a test failed
  - testDocuments
```
protected void testDocuments(java.lang.String[] uriList,
                             java.lang.String[] stampList,
                             MetaContainer[] metaContainerList)
                      throws TraceException
```
    Run all asked tests on all given documents
    
    Parameters:
    
    uriList - list of uris
    
    stampList - list of stamps
    
    metaContainerList - list of metas
    
    Throws:
    
    TraceException - if a test failed
  - testDocument
```
protected void testDocument(Document doc)
                     throws TraceException
```
    Run all asked tests on a given document
    
    Parameters:
    
    doc - document to test
    
    Throws:
    
    TraceException - if a test failed
  - testDocument
```
protected void testDocument(java.lang.String uri,
                            java.lang.String stamp,
                            MetaContainer metas)
                     throws TraceException
```
    Run all asked tests on a given document
    
    Parameters:
    
    doc - document to test
    
    Throws:
    
    TraceException - if a test failed
  - testMandatoryStamp
```
protected void testMandatoryStamp(Document doc)
                           throws TraceException
```
    Test if the given document contain a non null stamp
    
    Parameters:
    
    doc - document to test
    
    Throws:
    
    TraceException - if the test fails
  - testNullURI
```
protected void testNullURI(Document doc)
                    throws TraceException
```
    Test if the given document has a non null URI
    
    Parameters:
    
    doc - document to test
    
    Throws:
    
    TraceException - if the test fails
  - testUniqueStreams
```
protected void testUniqueStreams(Document doc)
                          throws TraceException
```
    Test if all document's parts give a new stream each time getStream is called
    
    Parameters:
    
    doc - document to test
    
    Throws:
    
    TraceException - if the test fails
  - testNullMetas
```
protected void testNullMetas(MetaContainer metaContainer)
                      throws TraceException
```
    Test if all document's metas have a non null name and non null values
    
    Parameters:
    
    doc - document to test
    
    Throws:
    
    TraceException - if the test fails

Class TracePushAPI

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

start

end

testMandatoryStamp

testNullURI

testAPICompliance

testNullMetas

tick

fcount

volumeBytes

volumeBytesLock

DEFAULT_LOG_OPERATIONS_FREQUENCY

threadTime

threadBean

isCurrentThreadCpuTimeSupported

OPERATION_MIN

OPERATION_ADDDOCUMENT

OPERATION_ADDDOCUMENTLIST

OPERATION_AREDOCUMENTSSEARCHABLE

OPERATION_CLEARALLCHECKPOINTS

OPERATION_COUNTSYNCEDENTRIES

OPERATION_DELETEDOCUMENT

OPERATION_DELETEDOCUMENTLIST

OPERATION_DELETEDOCUMENTLIST_DID

OPERATION_DELETEDOCUMENTROOTPATH

OPERATION_ENUMERATECHECKPOINTINFO

OPERATION_ENUMERATESYNCEDENTRIES

OPERATION_GETCHECKPOINT

OPERATION_GETCONNECTORNAME

OPERATION_GETDOCUMENTSTATUS

OPERATION_GETDOCUMENTSTATUSLIST

OPERATION_PING

OPERATION_SETCHECKPOINT

OPERATION_STARTPUSHSESSION

OPERATION_STOPPUSHSESSION

OPERATION_SYNC

OPERATION_TRIGGERINDEXINGJOB

OPERATION_UPDATEDOCUMENT

OPERATION_UPDATEDOCUMENTLIST

OPERATION_UPDATEDOCUMENTMETAS

OPERATION_UPDATEDOCUMENTMETASLIST

OPERATION_IN_CONNECTOR

OPERATION_TRIGGERINDEXINGJOBWHENIDLE

OPERATION_GETCHECKPOINTINFO

OPERATION_ENUMERATESTATEDCHECKPOINTINFO

OPERATION_DELETEDOCUMENSWITHPREFIX

OPERATION_MAX

OPERATION_FAMILY_MIN

OPERATION_FAMILY_ADDDOCUMENT

OPERATION_FAMILY_DELETEDOCUMENT

OPERATION_FAMILY_UPDATEDOCUMENT

OPERATION_FAMILY_UPDATEDOCUMENTMETAS

OPERATION_FAMILY_MAX

Constructor Detail

TracePushAPI

TracePushAPI

Method Detail

clear

createPushAPIPlugin

getOperationName

getFamilyOperationName

getCurrentThreadCpuTime

startOperations

endOperations

nsToString

formatK

bytesToString

endOperation

catchOperation

incOperationFamily