Connector Programmer

What's New

About the Push API

Push API HTTP Level

Push API at the HTTP level

Push API Client Implementation Recommendations

Push API Client Methods

void ping()

void startPushSession()

void stopPushSession()

void addDocument(Document document) and void addDocumentList(Document[ ] documentList)

void updateDocument(Document document, string[] fields) and void updateDocumentList(Document[ ] documentList, string[][] fieldsList)

void deleteDocument(String uri) and void deleteDocumentList(String[] uris)

void deleteDocumentsRootPath(String rootPath [, Boolean recursive=true] )

DocumentStatus getDocumentStatus(String uri) and DocumentStatus[] getDocumentStatusList(String[] uriList)

ulong setCheckpoint(String checkpoint [, String name] [, sync=false])

String getCheckpoint([String name])

String getCheckpoint([String name, Boolean showSynchronizedOnly])

void clearAllCheckpoints()

CheckpointsInfoIterator enumerateCheckpointsInfo()

CheckpointsInfoIterator enumerateCheckpointsInfo (boolean showSynchronizedOnly)

CheckpointsInfoIterator:: next()

SyncedEntriesIterator::

SyncedEntriesIterator enumerateSyncedEntries(String rootPath, EnumerationMode enumerationMode)

ulong countSyncedEntries(String rootPath, EnumerationMode enumerationMode)

void sync()

void triggerIndexingJob()

boolean areDocumentsSearchable(long serial)

Metadata Examples

Using the Push API Client

Installing the Push API Client

Instantiating the Push API Client

Operations and states

Indexing your first PAPI document

Indexing a Document Collection

Listing Synced Documents

Updating Documents

Monitoring the Index

Push API Connector Framework

Connector Framework Prerequisites

Using the Eclipse plugin

Implementing the Connector

Packaging the connector as a plugin

Plugin structure

Create a basic plugin

About the CVPlugin public class

Top level component class(es)

Top level configuration class(es)

Setter/Getter methods

Implementing Format Plugins

Extending the Files Connector through Plugins

Developing a Security Source

About Security Source Development

Implementing a Security Source Plugin

Deploying the Connector

Deploying the Connector Plugin

Maintaining a Connector Configuration across Versions

Creating and Configuring the Connector

Advanced Operations and Best Practices

What to map from the Data Source?

How to Keep the Index Synchronized with the Datasource

Implementing Synchronization

Push API filters

Deploying Connectors on a Remote Server

Calculating a diff between Two Data Sources

Customizing Connectors to use the Interconnector Service

Best Practices