com.google.enterprise.connector.spi

Interface Retriever

public interface Retriever

A Retriever provides access to document content, based upon a docid.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getContent(java.lang.String docid) Return an InputStream that may be used to access content for the document identified by docid.
Document	getMetaData(java.lang.String docid) Return a Document instance populated with meta-data for the document identified by docid.

Method Detail

getContent

java.io.InputStream getContent(java.lang.String docid)
                        throws RepositoryException

Return an InputStream that may be used to access content for the document identified by docid.

Parameters:

docid - the document identifier

Returns:

an InputStream for the document content or null if the document has no content.

Throws:

RepositoryDocumentException - if there was a document-specific error accessing the content, for instance the document does not exist or should be skipped

RepositoryException - if there was a problem accessing the document repository

getMetaData

Document getMetaData(java.lang.String docid)
              throws RepositoryException

Return a Document instance populated with meta-data for the document identified by docid. The returned Document should not include the document content. The meta-data should minimally include the google:lastmodified Property. It should also include the document google:mimetype Properties, if readily available, to satisfy HEAD requests.

Returns:

a Document instance with Properties containing document meta-data

Throws:

RepositoryDocumentException - if there was a document-specific error accessing the metadata, for instance the document does not exist or should be skipped

RepositoryException - if there was a problem accessing the document repository