com.exalead.papi.helper.http.V2

Class HttpPushAPI

java.lang.Object

com.exalead.papi.helper.PushAPI

com.exalead.papi.helper.http.V2.HttpPushAPI

public class HttpPushAPI
extends PushAPI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HttpPushAPI.HttpIterableCheckpointInfo
class	HttpPushAPI.HttpIterableSyncedEntries
static class	HttpPushAPI.TaskStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	connectorName_
static java.lang.String	HTTPPAPI_VERSION
static java.lang.String	HTTPPAPI_VERSION_KEY
protected static int	METHOD_GET
protected static int	METHOD_POST

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

DEFAULT_CHECKPOINT_NAME, STREAMING_BLOCK_SIZE

Constructor Summary

Constructors

Constructor and Description
HttpPushAPI(java.lang.String host, java.lang.String port, java.lang.String connectorName, java.lang.String connectorType, java.lang.String login, java.lang.String password)
HttpPushAPI(java.lang.String host, java.lang.String port, java.lang.String urlPrefix, java.lang.String connectorName, java.lang.String connectorType, java.lang.String login, java.lang.String password)

Method Summary

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.
boolean	areDocumentsSearchable(java.math.BigInteger serial, boolean onAllReplicas, boolean ignoreDetachedReplicas) Checks whether documents sent prior a given setCheckpoint operation are searchable.
protected void	checkHTTPPAPIVersion(java.lang.String serverVersion)
void	clearAllCheckpoints() Resets all the checkpoints values.
void	commit()
long	countSyncedEntries(java.lang.String rootPath, EnumerationMode mode) This method is not supported (a call will throw an UnsupportedOperationException)
protected int	createPartialFlushTask()
void	deleteDocument(java.lang.String uri) Deletes a document specified by its URI.
void	deleteDocumentList(int[] dids, 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.
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.
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.
DocumentStatus	getDocumentStatus(java.lang.String uri) Gets document status.
DocumentStatus[]	getDocumentStatusList(java.lang.String[] uri) Gets the status of a given list of documents in the push server.
protected HttpPushAPI.TaskStatus	getTaskStatus(int taskId)
void	ping() Tests the connection with the server.
protected com.exalead.papi.helper.http.V2.HTTPCommandResult	process(int method, java.lang.String command, com.exalead.papi.helper.http.V2.HTTPCommandParameterContainer container)
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.
java.lang.String[]	suggestSyncedEntries(java.lang.String rootPath, int limit) Suggest synchronized entries.
void	sync() Deprecated. since V6R2015x, replaced by synchronize()
java.math.BigInteger	synchronize() Forces the synchronization of all pending operations before returning.
protected Document	transformDocumentUpdate(Document document, java.lang.String[] fields)
void	triggerIndexingJob() 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[] documentUpdates)
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.PushAPI

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

Methods inherited from class java.lang.Object

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

Field Detail

METHOD_GET

protected static final int METHOD_GET

See Also:

Constant Field Values

METHOD_POST

protected static final int METHOD_POST

See Also:

Constant Field Values

HTTPPAPI_VERSION_KEY

public static final java.lang.String HTTPPAPI_VERSION_KEY

See Also:

Constant Field Values

HTTPPAPI_VERSION

public static final java.lang.String HTTPPAPI_VERSION

See Also:

Constant Field Values

connectorName_

protected java.lang.String connectorName_

Constructor Detail

HttpPushAPI

public HttpPushAPI(java.lang.String host,
                   java.lang.String port,
                   java.lang.String urlPrefix,
                   java.lang.String connectorName,
                   java.lang.String connectorType,
                   java.lang.String login,
                   java.lang.String password)

HttpPushAPI

public HttpPushAPI(java.lang.String host,
                   java.lang.String port,
                   java.lang.String connectorName,
                   java.lang.String connectorType,
                   java.lang.String login,
                   java.lang.String password)

Method Detail

checkHTTPPAPIVersion

protected void checkHTTPPAPIVersion(java.lang.String serverVersion)

process

protected com.exalead.papi.helper.http.V2.HTTPCommandResult process(int method,
                                                                    java.lang.String command,
                                                                    com.exalead.papi.helper.http.V2.HTTPCommandParameterContainer container)
                                                             throws PushAPIException

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.

Specified by:

addDocument in class PushAPI

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.

Specified by:

addDocumentList in class PushAPI

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.

Specified by:

clearAllCheckpoints in class PushAPI

Throws:

PushAPIException - upon error

countSyncedEntries

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

This method is not supported (a call will throw an UnsupportedOperationException)

Specified by:

countSyncedEntries in class PushAPI

Parameters:

rootPath -

mode -

Returns:

Throws:

PushAPIException

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.

Specified by:

deleteDocument in class PushAPI

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.

Specified by:

deleteDocumentList in class PushAPI

Parameters:

uris - the list of URIs of the documents to delete

Throws:

PushAPIException - upon error

deleteDocumentList

public void deleteDocumentList(int[] dids,
                               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.

Specified by:

deleteDocumentList in class PushAPI

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.

Specified by:

deleteDocumentRootPath in class PushAPI

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

enumerateCheckpointInfo

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

Description copied from class: PushAPI

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

Specified by:

enumerateCheckpointInfo in class PushAPI

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)

Description copied from class: PushAPI

Enumerates all the checkpoints.

Overrides:

enumerateCheckpointInfo in class PushAPI

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.

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.

Specified by:

enumerateSyncedEntries in class PushAPI

Parameters:

rootPath - A part of the URI used to select a subset of the corpus. Empty string can be used to delete the whole collection.

mode - This implementation supports only EnumerationMode.RECURSIVE_DOCUMENTS

Returns:

Throws:

PushAPIException

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.

Specified by:

getCheckpoint in class PushAPI

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 PushAPI

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)

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.

Specified by:

getDocumentStatus in class PushAPI

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[] uri)
                                       throws PushAPIException

Description copied from class: PushAPI

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

Specified by:

getDocumentStatusList in class PushAPI

Parameters:

uri - 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

Specified by:

ping in class PushAPI

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.

Specified by:

setCheckpoint in class PushAPI

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)

suggestSyncedEntries

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

Description copied from class: PushAPI

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

Overrides:

suggestSyncedEntries in class PushAPI

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.

limit - maximum number of suggestions.

Returns:

an array of synchronized entries URI.

Throws:

PushAPIException - upon error

See Also:

#sync()}

updateDocumentList

public void updateDocumentList(Document[] documentUpdates)
                        throws PushAPIException

Throws:

PushAPIException

transformDocumentUpdate

protected Document transformDocumentUpdate(Document document,
                                           java.lang.String[] fields)
                                    throws PushAPIException

Throws:

PushAPIException

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.

Specified by:

updateDocument in class PushAPI

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.

Specified by:

updateDocumentList in class PushAPI

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.

Specified by:

updateDocumentMetas in class PushAPI

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.

Specified by:

updateDocumentMetasList in class PushAPI

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)

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.

Specified by:

areDocumentsSearchable in class PushAPI

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

areDocumentsSearchable

public boolean areDocumentsSearchable(java.math.BigInteger serial,
                                      boolean onAllReplicas,
                                      boolean ignoreDetachedReplicas)
                               throws PushAPIException

Description copied from class: PushAPI

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

Overrides:

areDocumentsSearchable in class PushAPI

Parameters:

serial - the serial returned by a setCheckpoint operation

onAllReplicas - true if the serial must be available on all replicas, false otherwise

ignoreDetachedReplicas - true if detached replicas should not be taken into account, false otherwise

Returns:

true if the documents sent prior a given setCheckpoint are searchable

Throws:

PushAPIException - upon error

createPartialFlushTask

protected int createPartialFlushTask()
                              throws PushAPIException

Throws:

PushAPIException

getTaskStatus

protected HttpPushAPI.TaskStatus getTaskStatus(int taskId)
                                        throws PushAPIException

Throws:

PushAPIException

commit

public void commit()
            throws PushAPIException

Throws:

PushAPIException

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.

Specified by:

triggerIndexingJob in class PushAPI

Throws:

PushAPIException - upon error

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.

Specified by:

sync in class PushAPI

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 PushAPI

Returns:

the serial of the last pending operation before the synchronize

Throws:

PushAPIException - upon error

getConnectorName

public java.lang.String getConnectorName()

Description copied from class: PushAPI

Gets the name of the connector associated to this push client.

Specified by:

getConnectorName in class PushAPI

Returns:

the name of the connector.

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.

Specified by:

startPushSession in class PushAPI

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.

Specified by:

stopPushSession in class PushAPI

Throws:

PushAPISessionNotFoundException - if session is not started.

PushAPIException - if another error occurred.

See Also:

startPushSession}