com.google.enterprise.adaptor.experimental

Class MetadataExplorer

java.lang.Object

com.google.enterprise.adaptor.AbstractAdaptor

com.google.enterprise.adaptor.experimental.MetadataExplorer

All Implemented Interfaces:

Adaptor

public class MetadataExplorer
extends AbstractAdaptor

Demonstrates what happens when "intersecting" Metadata elements are specified in the Lister, Retriever, and internal Metadata of an object. Code based mostly on the AdaptorTemplate from the "examples" directory.

Constructor Summary

Constructors

Constructor and Description
MetadataExplorer()

Method Summary

Modifier and Type	Method and Description
void	getDocContent(Request req, Response resp) Gives the bytes of a document referenced with id.
void	getDocIds(DocIdPusher pusher) Gives list of document ids that you'd like on the GSA.
void	init(AdaptorContext context) Initialize adaptor with the current context.
static void	main(String[] args) Call default main for adaptors.

Methods inherited from class com.google.enterprise.adaptor.AbstractAdaptor

destroy, initConfig, main

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataExplorer

public MetadataExplorer()

Method Detail

init

public void init(AdaptorContext context)
          throws Exception

Description copied from class: AbstractAdaptor

Initialize adaptor with the current context. This is the ideal time to start any threads to do extra behind-the-scenes work. The context points to other useful objects that can be used at any time. For example, methods on DocIdPusher provided via AdaptorContext.getDocIdPusher() are allowed to be called whenever the Adaptor wishes. This allows doing event-based incremental pushes at any time.

The method is called at the end of GsaCommunicationHandler.start(java.lang.Runnable).

If you experience a fatal error during initialization, feel free to throw an Exception to cancel the startup process.

This implementation does nothing.

Specified by:

init in interface Adaptor

Overrides:

init in class AbstractAdaptor

Parameters:

context - for instance includes completed config

Throws:

Exception - if things are not going well

getDocIds

public void getDocIds(DocIdPusher pusher)
               throws InterruptedException

Gives list of document ids that you'd like on the GSA. DocIdPusher.Records are used, so that Metadata is specified.

Parameters:

pusher - used to send doc ids to GSA

Throws:

InterruptedException - if an IO operations throws it

getDocContent

public void getDocContent(Request req,
                          Response resp)
                   throws IOException

Gives the bytes of a document referenced with id. Includes "Retriever Metadata" and "Internal Metadata" elements.

Parameters:

req - info about document being sought

resp - place to put document data

Throws:

IOException - if getting data fails

main

public static void main(String[] args)

Call default main for adaptors.

Parameters:

args - argv