com.google.enterprise.connector.spi

Interface DocumentAcceptor

public interface DocumentAcceptor

Interface for a DocumentAcceptor - something that takes spi Documents and sends them along on their way.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels a feed.
void	flush() Finishes processing a document feed.
void	take(Document document) Takes an spi Document and pushes it along, presumably to the GSA Feed.

Method Detail

take

void take(Document document)
   throws DocumentAcceptorException,
          RepositoryException

Takes an spi Document and pushes it along, presumably to the GSA Feed.

Parameters:

document - A Document

Throws:

RepositoryException - if transient error accessing the Repository

RepositoryDocumentException - if fatal error accessing the Document

DocumentAcceptorException - if a transient error occurs in the DocumentAcceptor

flush

void flush()
    throws DocumentAcceptorException,
           RepositoryException

Finishes processing a document feed. If the caller anticipates no further calls to take(Document) will be made, this method should be called, so that the DocumentAcceptor may send a cached, accumulated feed to the GSA.

Throws:

RepositoryException - if transient error accessing the Repository

RepositoryDocumentException - if fatal error accessing the Document

DocumentAcceptorException - if a transient error occurs in the DocumentAcceptor

cancel

void cancel()
     throws DocumentAcceptorException,
            RepositoryException

Cancels a feed. Discard any accumulated feed data. Note that some documents submitted to this DocumentAcceptor may have already been sent on to the GSA.

Throws:

DocumentAcceptorException

RepositoryException