com.exalead.papi.framework.connectors

Annotation Type ConnectorCapabilities

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface ConnectorCapabilities

Capabilities of a connector. The server queries the connector for its capabilities

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	canFetch Does the connector support fetching and returning the documents ?
boolean	isReentrant Enable a Connector to be scanned simultaneously with different scan modes
ScanModeDefinition[]	scanModes List of supported rescan modes.
ConnectorCapabilities.Workflow	workflow What is the main workflow of the connector ? - Successive "scans" of the data source ? - Continuously working (listening for events)

Element Detail

workflow

public abstract ConnectorCapabilities.Workflow workflow

What is the main workflow of the connector ? - Successive "scans" of the data source ? - Continuously working (listening for events)

Default:

com.exalead.papi.framework.connectors.ConnectorCapabilities.Workflow.SCAN_BASED

scanModes

public abstract ScanModeDefinition[] scanModes

List of supported rescan modes. A "scan based" mode is required to support at least the "full" rescan mode. Class defining a mode supported by a SCAN_BASED connector to scan. Scan modes can have parameters, represented by a ConfigBean class. They are presented in admin-ui. All connectors generally support at least a "full" scan mode. "reindex a subset" can fit this model. So can "don't process deletions", or "only process this and this table", ... On a permanent connector, the admin-ui only shows "start" and "stop" buttons On a scan connector, the admin-ui shows buttons for the various scan modes and their configuration + the "abort current scan" button.

Default:

@com.exalead.papi.framework.connectors.ScanModeDefinition(name="full")

canFetch

public abstract boolean canFetch

Does the connector support fetching and returning the documents ?

Default:

true

isReentrant

public abstract boolean isReentrant

Enable a Connector to be scanned simultaneously with different scan modes

Default:

false