Package com.exalead.papi.helper

This is the main package of the PushAPI client.

See: Description

Interface Summary

Interface	Description
CheckpointInfoIterator	Base class representing an iterator on checkpoints.
FactoryImpl	Interface to implement to override the PushAPIFactory behaviour.
IDocument
SyncedEntriesIterator	Base class representing an iterator on synchronized entries.

Class Summary

Class	Description
CheckpointInfo	Base class representing checkpoints as known by the indexing chain.
DefaultFactory	Default implementation of the factory for creating push clients.
Document	Class representing a document to be indexed.
Document.DidAndSlice	Internal identifier of a document in the CloudView system.
DocumentsPushAPIException.Entry	Simple implementation of a Map.Entry used for DocumentsPushAPIException.
DocumentStatus	The status of a document within the indexed corpus.
KeyValuesContainer<Type1,Type2>	Multi-purpose key / value container.
Meta	Meta that can be associated with a document.
MetaContainer	Container for meta data.
MultiConnectorPushAPI	Multi Connector Push client interface.
Part	Binary part of a document.
PartContainer	Container for parts.
PushAPI	Push client interface.
PushAPIFactory	Factory for creating push clients.
PushAPISession	Push API session helper.
SecurityMeta	Security Token class.
SyncedEntry	Description of a synchronized entry as known by the indexing chain.

Enum Summary

Enum	Description
EnumerationMode	Enumeration mode used by the enumerateSyncedEntries and countSyncedEntries operations.
Protocol
PushAPIVersion	PushAPI version.

Exception Summary

Exception	Description
DocumentsPushAPIException	Base class for exceptions that can be thrown by push calls.
InvalidCommandErrorException	Exception thrown when the push server cannot interpret the command.
InvalidConnectorNameException	Exception thrown when the connector name is not known by the push server.
PushAPIException	Base class for exceptions that can be thrown by push calls.
PushAPISessionExistsException	An existing PushAPI session is already opened.
PushAPISessionMismatchException	The current push session does not match with the server session anymore.
PushAPISessionNotFoundException	A previous PushAPI session could not be found.
UnknownErrorException	Exception thrown when an unknown error has occurred.

Package com.exalead.papi.helper Description

This is the main package of the PushAPI client. To get an instance of PushAPI use PushAPIFactory