com.exalead.papi.framework.connectors

Annotation Type ScanModeDefinition

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

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", ... Now each scan mode has a workflow to indicate if it's a "scan-based" scan or a "permanent-work" scan. "permanent-scan" modes should never return.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<?>	configClass
java.lang.String	description
ConnectorCapabilities.Workflow	workflow

Element Detail

name

public abstract java.lang.String name

description

public abstract java.lang.String description

Default:

""

configClass

public abstract java.lang.Class<?> configClass

Default:

com.exalead.papi.framework.connectors.ScanModeConfigNone.class

workflow

public abstract ConnectorCapabilities.Workflow workflow

Default:

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