Package com.exalead.papi.framework.connectors

Interface Summary

Interface	Description
Abortable	A Abortable is PushAPIFilter that can be aborted.
ConnectorConfigCheckInterface	This optional interface to com.exalead.papi.framework.ConnectorConfig allows to dynamically check a configuration.
ConnectorStatusExceptionInterface	This optional interface to com.exalead.papi.framework.Connector allows to return the exception associated with a ConnectorStatus.ERROR status.
PushAPIFilter	PushAPI filter.
PushAPIFilter.Fetch	Additional interface signaling a fetch-aware filter.
PushAPIFilterConfig	The PushAPI filter base configuration interface.

Class Summary

Class	Description
Connector	Top level class of connector.
Connector.ConnectorNameThreadFactory	A Thread factory that can have the name of spawned thread prefix customized.
ConnectorConfig	Configuration of a managed connector.
ConnectorConfigCheck	Base interface for Cloudview components Config check.
ConnectorInfoRequest
ConnectorState	State of a connector, with state transition.
ConnectorState.Builder
ConnectorState.ScanStatus
ContainerMainPartConfig	Containers (ZIP, ..) files main document part settings.
ContainerMultiThreadedConnector	MultiThreadedConnector is an implementation of connector This class provides the following features : - Enumeration of Documents is multithreaded (the number of thread can be easily adjusted) - Pushing documents is multithreaded (the number of thread can be easily adjusted) - All the required methods of Connector class have been implemented.
ContainerMultiThreadedConnectorConfig	Base class for multithreaded connectors configuration.
CountingPushAPI
GenericContainerMultiThreadedConnector<SKey extends com.exalead.papi.framework.source.adapter.Key>	GenericContainerMultiThreadedConnector is an implementation of connector This class provides the following features : - Enumeration of Documents is multithreaded (the number of thread can be easily adjusted) - Pushing documents is multithreaded (the number of thread can be easily adjusted) - Handling containers (ZIP files, PST files ..) - All the required methods of Connector class have been implemented.
GenericContainerMultiThreadedConnectorConfig	Configuration of GenericContainerMultiThreadedConnector<>.
GenericMultiThreadedConnector<SKey extends com.exalead.papi.framework.source.adapter.Key>	Generic class of connectors with multithreaded enumeration.
GenericMultiThreadedConnectorConfig	Configuration of MultiThreadedConnector You have to create setters to manage connector configuration as described in ConnectorConfig.
GenericMultiThreadedConnectorConfig.DocumentErrorBehavior
MultiThreadedConnector	MultiThreadedConnector is an implementation of connector This class provides the following features : Enumeration of Documents is multithreaded (the number of thread can be adjusted) Pushing documents is multithreaded (the number of thread can be adjusted) The constructor of your class must have 2 parameters, the first one must be of type PushAPI, the second is your implementation of MultiThreadedConnectorConfig Normally your inherited class should just define a new constructor (you override methods)
MultiThreadedConnectorConfig	Configuration of MultiThreadedConnector You have to create setters to manage connector configuration as described in ConnectorConfig.
PushAPIFilterConfig.DefaultImpl	Default class implementation for PushAPIPlugin.
PushAPIFilters	PushAPIPlugins ; aggregates all detected filters for PushAPI pipe.
RootPathConfig	The root path (top-level paths to crawl) configuration.
ScanModeConfigNone
ThresholdConfig

Enum Summary

Enum	Description
ConnectorCapabilities.Workflow
ConnectorStatus	Status of a connector.
GenericMultiThreadedConnectorConfig.DocumentErrorBehavior.State
SynchronizationMode	Deprecated

Exception Summary

Exception	Description
ConnectorAbortingException	Abort request exception.
PushAPIFilters.InitializationException	Initialization exception.
UserNotAllowedException	This exception is thrown when the requester (user) is not allowed to view document

Annotation Types Summary

Annotation Type	Description
ConnectorCapabilities	Capabilities of a connector.
DisableCountingPapi	Disable the automatic counting of pushed and deleted documents.
ScanModeDefinition	Class defining a mode supported by a SCAN_BASED connector to scan.