ListingConnector

public class ListingConnector extends Object
implements IndexingConnector ItemRetriever IncrementalChangeHandler

Template connector that performs complete repository list traversals.

Use this connector type for large, dynamic, and hierarchical data repositories. This connector pushes document ids to the Cloud Search queue and then processes them individually for indexing.

Sample usage:

public static void main(String[] args) throws IOException, InterruptedException {
   Application application = new Application.Builder(
       new ListingConnector(new MyRepository()), args).build();
   application.start();
 }
 

If the repository supports document change detection, the connector can perform an incremental change traversal, which reads and re-indexes just the newly modified documents.

Constant Summary

String CHECKPOINT_FULL
String CHECKPOINT_INCREMENTAL
String CONFIG_TRAVERSER

Public Constructor Summary

ListingConnector(Repository repository, CheckpointHandler checkpointHandler)

Public Method Summary

void
destroy()
Shuts down and releases connector resources.
String
getDefaultId()
Use the repository class name for the default ID, rather than this template class name.
void
handleAsyncOperation(AsyncApiOperation asyncOp)
Performs the asynchronously pushed operation from the Repository.
void
handleIncrementalChanges()
Performs all actions necessary for incremental traversals.
void
init(IndexingConnectorContext context)
Initializes the connector with the current context.
void
process(Item item)
Processes each polled document from the Cloud Search queue.
void
saveCheckpoint(boolean isShutdown)
Saves checkpoint information such as current traversal position or incremental change tokens.
void
traverse()
Performs a list traversal on the data repository.

Inherited Method Summary

Constants

public static final String CHECKPOINT_FULL

Constant Value: "checkpoint_full"

public static final String CHECKPOINT_INCREMENTAL

Constant Value: "checkpoint_incremental"

public static final String CONFIG_TRAVERSER

Constant Value: "repository.traversers"

Public Constructors

public ListingConnector (Repository repository)

Parameters
repository

public ListingConnector (Repository repository, CheckpointHandler checkpointHandler)

Parameters
repository
checkpointHandler

Public Methods

public void destroy ()

Shuts down and releases connector resources.

public String getDefaultId ()

Use the repository class name for the default ID, rather than this template class name.

public void handleAsyncOperation (AsyncApiOperation asyncOp)

Performs the asynchronously pushed operation from the Repository.

This is only used when the Repository supports asynchronous operations outside of normal traversals. Use this operation for triggered actions (such as created, modified, or deleted documents) that cannot be queried from a full or incremental traversal or when the change should be detected and acted on immediately.

Parameters
asyncOp the operation asynchronously pushed from the Repository

public void handleIncrementalChanges ()

Performs all actions necessary for incremental traversals.

If the Repository does not support incremental traversals, the getChanges(byte[]) method should return null.

Throws
IOException on SDK upload errors
InterruptedException if exception handler is interrupted

public void init (IndexingConnectorContext context)

Initializes the connector with the current context.

Initialization is the ideal time to start any threads to do extra behind-the-scenes work. The context allows access to other useful objects that can be used at any time such as the IndexingService.

If an unrecoverable fatal error occurs during initialization, throw a StartupException to cancel the startup process. If a recoverable error occurs during initialization, most Exception instances other than StartupException cause a retry of initialization after a short delay.

Parameters
context IndexingConnectorContext instance for accessing framework objects
Throws
Exception

public void process (Item item)

Processes each polled document from the Cloud Search queue.

Retrieve the document for indexing. For hierarchical data repositories, also push the children ids to the queue for later recursive processing.

Parameters
item Item representing a polled document
Throws
IOException on SDK upload errors
InterruptedException if exception handler is interrupted

public void saveCheckpoint (boolean isShutdown)

Saves checkpoint information such as current traversal position or incremental change tokens.

The checkpoint contents are implementation-specific as defined by the connector code. This method is called during shutdown to allow the connector to save the current traversal state.

Parameters
isShutdown flag indicating a connector shutdown
Throws
IOException
InterruptedException

public void traverse ()

Performs a list traversal on the data repository.

Push document ids to the Cloud Search queue. For hierarchical data repositories, push only the root document ids. For non-hierarchical data repositories, push all the document ids.

Throws
IOException on SDK push errors
InterruptedException if exception handler is interrupted

Send feedback about...

Cloud Search
Cloud Search