com.exalead.papi.helper

Class MultiConnectorPushAPI

java.lang.Object

com.exalead.papi.helper.MultiConnectorPushAPI

Direct Known Subclasses:

MultiConnectorHttpPushAPI

public abstract class MultiConnectorPushAPI
extends java.lang.Object

Multi Connector Push client interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CHECKPOINT_NAME Name of the default checkpoint, used when setting a checkpoint with no name (#setCheckpoint(String, String) or {@link #setCheckpoint(String, String, boolean)}.
static int	STREAMING_BLOCK_SIZE

Constructor Summary

Constructors

Constructor and Description
MultiConnectorPushAPI()

Method Summary

Modifier and Type	Method and Description
abstract void	addDocument(java.lang.String connectorName, Document document) Adds a document.
abstract void	addDocumentList(java.lang.String connectorName, Document[] documents) Adds a set of documents.
abstract boolean	areDocumentsSearchable(java.lang.String connectorName, java.math.BigInteger serial) Checks whether documents sent prior a given setCheckpoint operation are searchable.
abstract void	clearAllCheckpoints(java.lang.String connectorName) Resets all the checkpoints values.
abstract void	clearCheckpoints(java.lang.String connectorName, java.lang.String checkpointNamePrefix) Resets all the checkpoints values whose name starts with a specific prefix
long	countSyncedEntries(java.lang.String connectorName) Counts the number of synchronized entries recursively from root.
abstract long	countSyncedEntries(java.lang.String connectorName, java.lang.String rootPath, EnumerationMode mode) Counts the number of synchronized entries.
abstract void	deleteDocument(java.lang.String connectorName, java.lang.String uri) Deletes a document specified by its URI.
abstract void	deleteDocumentList(java.lang.String connectorName, int[] did, int[] slices) Deletes a list of documents specified by their dids and slices.
abstract void	deleteDocumentList(java.lang.String connectorName, java.lang.String[] uris) Deletes a list of documents specified by their URIs.
void	deleteDocumentRootPath(java.lang.String connectorName, java.lang.String rootPath) Deletes a set of document corresponding to a URI prefix.
void	deleteDocumentRootPath(java.lang.String connectorName, java.lang.String rootPath, boolean recursive) Deletes a set of documents corresponding to a URI prefix.
abstract void	deleteDocumentRootPath(java.lang.String connectorName, java.lang.String rootPath, boolean recursive, boolean clearCache) Deletes a set of documents corresponding to a URI prefix.
abstract java.lang.Iterable<CheckpointInfo>	enumerateCheckpointInfo(java.lang.String connectorName) Enumerates all the checkpoints known by the system (synchronized).
abstract java.lang.Iterable<CheckpointInfo>	enumerateCheckpointInfo(java.lang.String connectorName, boolean showSynchronizedOnly) Enumerates all the checkpoints.
java.lang.Iterable<SyncedEntry>	enumerateSyncedEntries(java.lang.String connectorName) Enumerates synchronized entries recursively from root.
abstract java.lang.Iterable<SyncedEntry>	enumerateSyncedEntries(java.lang.String connectorName, java.lang.String rootPath, EnumerationMode mode) Enumerates synchronized entries.
java.lang.String	getCheckpoint(java.lang.String connectorName) Gets the value of the default checkpoint in the indexing process.
abstract java.lang.String	getCheckpoint(java.lang.String connectorName, java.lang.String name) Gets the value of a named checkpoint in the indexing process.
abstract CheckpointInfo	getCheckpoint(java.lang.String connectorName, java.lang.String name, boolean showSynchronizedOnly) Gets the checkpoint detailed information.
Document.DidAndSlice[]	getDocumentDidsAndSlices(java.lang.String connectorName, java.lang.String[] uris) Get the CloudView internal identifiers of a set of documents.
abstract DocumentStatus	getDocumentStatus(java.lang.String connectorName, java.lang.String uri) Gets document status.
abstract DocumentStatus[]	getDocumentStatusList(java.lang.String connectorName, java.lang.String[] uri) Gets the status of a given list of documents in the push server.
abstract void	ping(java.lang.String connectorName) Tests the connection with the server.
java.math.BigInteger	setCheckpoint(java.lang.String connectorName, java.lang.String value) Sets the value for the default checkpoint in the push server but do not automatically synchronize the task log.
java.math.BigInteger	setCheckpoint(java.lang.String connectorName, java.lang.String value, boolean sync) Sets the value for the default checkpoint in the push server.
java.math.BigInteger	setCheckpoint(java.lang.String connectorName, java.lang.String value, java.lang.String name) Sets a checkpoint in the push server but do not automatically synchronize the tasks log.
abstract java.math.BigInteger	setCheckpoint(java.lang.String connectorName, java.lang.String value, java.lang.String name, boolean sync) Sets a checkpoint in the push server.
abstract void	startPushSession(java.lang.String connectorName) Starts a new session on the push server.
abstract void	stopPushSession(java.lang.String connectorName, boolean releaseConnections) Stops the current session on the push server.
java.lang.String[]	suggestSyncedEntries(java.lang.String connectorName, java.lang.String rootPath, int limit) Suggest synchronized entries.
abstract void	sync(java.lang.String connectorName) Forces the synchronization of all pending operations before returning.
abstract void	triggerIndexingJob(java.lang.String connectorName) Forces the processing of all pending operations synchronized to disk.
void	triggerIndexingJobWhenIdle(java.lang.String connectorName) Wait for indexing to be idle, and forces the processing of all pending operations synchronized to disk.
abstract void	updateDocument(java.lang.String connectorName, Document doc, java.lang.String[] fields) Partially updates a document.
abstract void	updateDocumentList(java.lang.String connectorName, Document[] docList, java.lang.String[][] fieldsList) Updates a set of documents.
abstract void	updateDocumentMetas(java.lang.String connectorName, java.lang.String uri, java.lang.String stamp, MetaContainer metaContainer) Deprecated.
abstract void	updateDocumentMetasList(java.lang.String connectorName, java.lang.String[] uriList, java.lang.String[] stampList, MetaContainer[] metaContainerList) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

STREAMING_BLOCK_SIZE

public static final int STREAMING_BLOCK_SIZE

See Also:

Constant Field Values

DEFAULT_CHECKPOINT_NAME

public static final java.lang.String DEFAULT_CHECKPOINT_NAME

Name of the default checkpoint, used when setting a checkpoint with no name (#setCheckpoint(String, String) or {@link #setCheckpoint(String, String, boolean)}.

See Also:

Constant Field Values

Constructor Detail

MultiConnectorPushAPI

public MultiConnectorPushAPI()

Method Detail

ping

public abstract void ping(java.lang.String connectorName)
                   throws PushAPIException

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

Parameters:

connectorName - the connector name, as known as the original source of the command

Throws:

PushAPIException - upon error (invalid connector name or IO error)

addDocument

public abstract void addDocument(java.lang.String connectorName,
                                 Document document)
                          throws PushAPIException

Adds a document. If a document with the same URI has already been added, the document will be updated.

Parameters:

connectorName - the connector name, as known as the original source of the command

document - Document to be added.

Throws:

PushAPIException - upon error

addDocumentList

public abstract void addDocumentList(java.lang.String connectorName,
                                     Document[] documents)
                              throws PushAPIException

Adds a set of documents. If a document with the same URI has already been added, the document will be updated.

Parameters:

connectorName - the connector name, as known as the original source of the command

documents - Documents to be added.

Throws:

PushAPIException - upon error.

updateDocument

public abstract void updateDocument(java.lang.String connectorName,
                                    Document doc,
                                    java.lang.String[] fields)
                             throws PushAPIException

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.

Parameters:

connectorName - the connector name, as known as the original source of the command

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

updateDocumentMetas

@Deprecated
public abstract void updateDocumentMetas(java.lang.String connectorName,
                                                     java.lang.String uri,
                                                     java.lang.String stamp,
                                                     MetaContainer metaContainer)
                                              throws PushAPIException

Deprecated.

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 #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 #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.

Parameters:

connectorName - the connector name, as known as the original source of the command

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

updateDocumentList

public abstract void updateDocumentList(java.lang.String connectorName,
                                        Document[] docList,
                                        java.lang.String[][] fieldsList)
                                 throws PushAPIException

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.

Parameters:

connectorName - the connector name, as known as the original source of the command

docList - the list of documents to update

fieldsList - for each document, the fields to be updated

Throws:

PushAPIException - upon error

See Also:

#updateDocument(Document, String[])

updateDocumentMetasList

@Deprecated
public abstract void updateDocumentMetasList(java.lang.String connectorName,
                                                         java.lang.String[] uriList,
                                                         java.lang.String[] stampList,
                                                         MetaContainer[] metaContainerList)
                                                  throws PushAPIException

Deprecated.

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 #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.

Parameters:

connectorName - the connector name, as known as the original source of the command

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:

updateDocumentMetas(java.lang.String, java.lang.String, java.lang.String, com.exalead.papi.helper.MetaContainer)

deleteDocument

public abstract void deleteDocument(java.lang.String connectorName,
                                    java.lang.String uri)
                             throws PushAPIException

Deletes a document specified by its URI. If the document does not exist yet, the instruction is silently ignored.

Parameters:

connectorName - the connector name, as known as the original source of the command

uri - the URI of the document to delete

Throws:

PushAPIException - upon error

deleteDocumentList

public abstract void deleteDocumentList(java.lang.String connectorName,
                                        java.lang.String[] uris)
                                 throws PushAPIException

Deletes a list of documents specified by their URIs. For each document which do not exist yet, the instruction is silently ignored.

Parameters:

connectorName - the connector name, as known as the original source of the command

uris - the list of URIs of the documents to delete

Throws:

PushAPIException - upon error

deleteDocumentList

public abstract void deleteDocumentList(java.lang.String connectorName,
                                        int[] did,
                                        int[] slices)
                                 throws PushAPIException

Deletes a list of documents specified by their dids and slices. For each document which does not exist yet, the instruction is silently ignored.

Parameters:

connectorName - the connector name, as known as the original source of the command

dids - the list of dids to delete.

slices - the list of slices to delete.

Throws:

PushAPIException

deleteDocumentRootPath

public void deleteDocumentRootPath(java.lang.String connectorName,
                                   java.lang.String rootPath)
                            throws PushAPIException

Deletes a set of document corresponding to a URI prefix. Same as deleteDocumentRootPath(connectorName, rootPath, true).

Parameters:

connectorName - the connector name, as known as the original source of the command

Throws:

PushAPIException

deleteDocumentRootPath

public void deleteDocumentRootPath(java.lang.String connectorName,
                                   java.lang.String rootPath,
                                   boolean recursive)
                            throws PushAPIException

Deletes a set of documents corresponding to a URI prefix. All the documents matching the rootPath prefix will be deleted.

Parameters:

connectorName - the connector name, as known as the original source of the command

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.

Throws:

PushAPIException

deleteDocumentRootPath

public abstract void deleteDocumentRootPath(java.lang.String connectorName,
                                            java.lang.String rootPath,
                                            boolean recursive,
                                            boolean clearCache)
                                     throws PushAPIException

Deletes a set of documents corresponding to a URI prefix. All the documents matching the rootPath prefix will be deleted.

Parameters:

connectorName - the connector name, as known as the original source of the command

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 - This boolean flag indicates if we want to delete documents from the document cache when they are deleted from the index.

Throws:

PushAPIException

getDocumentStatus

public abstract DocumentStatus getDocumentStatus(java.lang.String connectorName,
                                                 java.lang.String uri)
                                          throws PushAPIException

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.

Parameters:

connectorName - the connector name, as known as the original source of the command

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 abstract DocumentStatus[] getDocumentStatusList(java.lang.String connectorName,
                                                       java.lang.String[] uri)
                                                throws PushAPIException

Gets the status of a given list of documents in the push server.

Parameters:

connectorName - the connector name, as known as the original source of the command

uri - the URIs of the documents for which the status should be retrieved.

Returns:

for each document the corresponding status.

Throws:

PushAPIException - upon error

getDocumentDidsAndSlices

public Document.DidAndSlice[] getDocumentDidsAndSlices(java.lang.String connectorName,
                                                       java.lang.String[] uris)
                                                throws PushAPIException

Get the CloudView internal identifiers of a set of documents. The internal identifier is the couple (did, slice). Please refer to CloudView architecture guides for more information. If the document is already present in the system, this method returns its existing identifier. Else, it assigns a new identifier. If the document is later added, it will use the same identifier.

Parameters:

connectorName - the connector name, as known as the original source of the command

uris - URIs of the document to identify

Returns:

List of identifiers, in the same order as the uris

Throws:

PushAPIException

setCheckpoint

public abstract java.math.BigInteger setCheckpoint(java.lang.String connectorName,
                                                   java.lang.String value,
                                                   java.lang.String name,
                                                   boolean sync)
                                            throws PushAPIException

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 #areDocumentsSearchable(BigInteger) for more information.

Parameters:

connectorName - the connector name, as known as the original source of the command

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:

#sync(), #areDocumentsSearchable(BigInteger)

setCheckpoint

public java.math.BigInteger setCheckpoint(java.lang.String connectorName,
                                          java.lang.String value,
                                          java.lang.String name)
                                   throws PushAPIException

Sets a checkpoint in the push server but do not automatically synchronize the tasks log. As a consequence, when calling a getCheckpoint immediately after a call to this method, you might not get the set value.

Equivalent to setCheckpoint(connectorName, value, name, false).

Parameters:

connectorName - the connector name, as known as the original source of the command

value - the value of the checkpoint

name - the name of the checkpoint

Returns:

the serial of the last pending operation before the checkpoint.

Throws:

PushAPIException - upon error

See Also:

setCheckpoint(String, String, boolean)

setCheckpoint

public java.math.BigInteger setCheckpoint(java.lang.String connectorName,
                                          java.lang.String value,
                                          boolean sync)
                                   throws PushAPIException

Sets the value for the default checkpoint in the push server.

Equivalent to setCheckpoint(connectorName, value, "", sync).

Parameters:

connectorName - the connector name, as known as the original source of the command

value - the value of the default checkpoint.

sync - if all the pending operations should be synchronized to disk before returning.

Returns:

the serial of the last pending operation before the checkpoint.

Throws:

PushAPIException - upon error

See Also:

setCheckpoint(String, String, boolean)

setCheckpoint

public java.math.BigInteger setCheckpoint(java.lang.String connectorName,
                                          java.lang.String value)
                                   throws PushAPIException

Sets the value for the default checkpoint in the push server but do not automatically synchronize the task log.

Equivalent to setCheckpoint(connectorName, value, "", false).

Parameters:

connectorName - the connector name, as known as the original source of the command

value - the value of the default checkpoint

Returns:

the serial of the last pending operation before the checkpoint.

Throws:

PushAPIException - upon error

See Also:

setCheckpoint(String, String, boolean)

getCheckpoint

public abstract java.lang.String getCheckpoint(java.lang.String connectorName,
                                               java.lang.String name)
                                        throws PushAPIException

Gets the value of a named checkpoint in the indexing process.

Parameters:

connectorName - the connector name, as known as the original source of the command

name - the name of the checkpoint

Returns:

the last synchronized value set for this checkpoint.

Throws:

PushAPIException - upon error

See Also:

setCheckpoint(String, String, boolean)

getCheckpoint

public abstract CheckpointInfo getCheckpoint(java.lang.String connectorName,
                                             java.lang.String name,
                                             boolean showSynchronizedOnly)
                                      throws PushAPIException

Gets the checkpoint detailed information.

Parameters:

connectorName - the connector name, as known as the original source of the command

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

Throws:

PushAPIException

See Also:

setCheckpoint(String, String, boolean)

getCheckpoint

public java.lang.String getCheckpoint(java.lang.String connectorName)
                               throws PushAPIException

Gets the value of the default checkpoint in the indexing process.

Equivalent to getCheckpoint("").

Parameters:

connectorName - the connector name, as known as the original source of the command

Returns:

the last synchronized value set for the default checkpoint.

Throws:

PushAPIException - upon error

clearAllCheckpoints

public abstract void clearAllCheckpoints(java.lang.String connectorName)
                                  throws PushAPIException

Resets all the checkpoints values.

Parameters:

connectorName - the connector name, as known as the original source of the command

Throws:

PushAPIException - upon error

clearCheckpoints

public abstract void clearCheckpoints(java.lang.String connectorName,
                                      java.lang.String checkpointNamePrefix)
                               throws PushAPIException

Resets all the checkpoints values whose name starts with a specific prefix

Parameters:

connectorName - the connector name, as known as the original source of the command

checkpointNamePrefix - Prefix of the checkpoint name to remove

Throws:

PushAPIException - upon error

enumerateCheckpointInfo

public abstract java.lang.Iterable<CheckpointInfo> enumerateCheckpointInfo(java.lang.String connectorName)
                                                                    throws PushAPIException

Enumerates all the checkpoints known by the system (synchronized).

Parameters:

connectorName - the connector name, as known as the original source of the command

Returns:

an iterator over the checkpoints

Throws:

PushAPIException - upon error

See Also:

setCheckpoint(String, String, boolean), #sync()

enumerateCheckpointInfo

public abstract java.lang.Iterable<CheckpointInfo> enumerateCheckpointInfo(java.lang.String connectorName,
                                                                           boolean showSynchronizedOnly)
                                                                    throws PushAPIException

Enumerates all the checkpoints.

Parameters:

connectorName - the connector name, as known as the original source of the command

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:

setCheckpoint(String, String, boolean), #synchronize()

sync

public abstract void sync(java.lang.String connectorName)
                   throws PushAPIException

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.

Throws:

PushAPIException - upon error

triggerIndexingJob

public abstract void triggerIndexingJob(java.lang.String connectorName)
                                 throws PushAPIException

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.

Throws:

PushAPIException - upon error

triggerIndexingJobWhenIdle

public void triggerIndexingJobWhenIdle(java.lang.String connectorName)
                                throws PushAPIException

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.

Throws:

PushAPIException - upon error

areDocumentsSearchable

public abstract boolean areDocumentsSearchable(java.lang.String connectorName,
                                               java.math.BigInteger serial)
                                        throws PushAPIException

Checks whether documents sent prior a given setCheckpoint operation are searchable.

Parameters:

serial - the serial returned by a setChecpoint operation

Returns:

true if the documents sent prior a given setCheckpoint are searchable

Throws:

PushAPIException - upon error

enumerateSyncedEntries

public abstract java.lang.Iterable<SyncedEntry> enumerateSyncedEntries(java.lang.String connectorName,
                                                                       java.lang.String rootPath,
                                                                       EnumerationMode mode)
                                                                throws PushAPIException

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.

Parameters:

connectorName - the connector name, as known as the original source of the command

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()}

enumerateSyncedEntries

public java.lang.Iterable<SyncedEntry> enumerateSyncedEntries(java.lang.String connectorName)
                                                       throws PushAPIException

Enumerates synchronized entries recursively from root.

Parameters:

connectorName - the connector name, as known as the original source of the command

Returns:

an iterator over synchronized entries.

Throws:

PushAPIException - upon error

See Also:

#sync()}

countSyncedEntries

public abstract long countSyncedEntries(java.lang.String connectorName,
                                        java.lang.String rootPath,
                                        EnumerationMode mode)
                                 throws PushAPIException

Counts the number of synchronized entries.

Parameters:

connectorName - the connector name, as known as the original source of the command

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.

countSyncedEntries

public long countSyncedEntries(java.lang.String connectorName)
                        throws PushAPIException

Counts the number of synchronized entries recursively from root.

Parameters:

connectorName - the connector name, as known as the original source of the command

Returns:

the number of synchronized entries found.

Throws:

PushAPIException - upon error.

suggestSyncedEntries

public java.lang.String[] suggestSyncedEntries(java.lang.String connectorName,
                                               java.lang.String rootPath,
                                               int limit)
                                        throws PushAPIException

Suggest synchronized entries. Synchronized entries are entries that have been effectively synchronized to disk.

Parameters:

connectorName - the connector name, as known as the original source of the command

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.

limit - maximum number of suggestions.

Returns:

an array of synchronized entries URI.

Throws:

PushAPIException - upon error

See Also:

#sync()}

startPushSession

public abstract void startPushSession(java.lang.String connectorName)
                               throws PushAPIException

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.

Throws:

PushAPISessionExistsException - if the session is already started.

PushAPIException - if any another error occurred.

stopPushSession

public abstract void stopPushSession(java.lang.String connectorName,
                                     boolean releaseConnections)
                              throws PushAPIException

Stops the current session on the push server.

Parameters:

releaseConnection - Try to release persistent connections to save resources.

Throws:

PushAPISessionNotFoundException - if session is not started.

PushAPIException - if another error occurred.

See Also:

startPushSession}