com.google.enterprise.adaptor.examples

Class AdaptorWithRespondNoContentTemplate

java.lang.Object

com.google.enterprise.adaptor.AbstractAdaptor

com.google.enterprise.adaptor.examples.AdaptorWithRespondNoContentTemplate

All Implemented Interfaces:

Adaptor, AuthzAuthority

public class AdaptorWithRespondNoContentTemplate
extends AbstractAdaptor
implements AuthzAuthority

Demonstrates what code is necessary for responding NO_CONTENT (204) to GSA. The key operations are:

1. providing document ids
2. providing document bytes and ACLs given a document id
3. responding with NO_CONTENT (204) when document content is same and metadata or ACLs are updated.

Constructor Summary

Constructors

Constructor and Description
AdaptorWithRespondNoContentTemplate()

Method Summary

Modifier and Type	Method and Description
void	getDocContent(Request request, Response response) Provides contents and metadata of particular document.
void	getDocIds(DocIdPusher pusher) Pushes all the DocIds that are suppose to be indexed by the GSA.
void	init(AdaptorContext context) Initialize adaptor with the current context.
Map<DocId,AuthzStatus>	isUserAuthorized(AuthnIdentity userIdentity, Collection<DocId> ids) Determines whether the user identified is allowed to access the DocIds.
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

AdaptorWithRespondNoContentTemplate

public AdaptorWithRespondNoContentTemplate()

Method Detail

init

public void init(AdaptorContext context)

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

getDocContent

public void getDocContent(Request request,
                          Response response)
                   throws IOException,
                          InterruptedException

Description copied from interface: Adaptor

Provides contents and metadata of particular document. This method should be highly parallelizable and support twenty or more concurrent calls. Two to three concurrent calls may be average during initial GSA crawling, but twenty or more concurrent calls is typical when the GSA is recrawling unmodified content.

If you experience a fatal error, feel free to throw an IOException or RuntimeException. In the case of an error, the GSA will determine if and when to retry.

Specified by:

getDocContent in interface Adaptor

Parameters:

request - info about document being sought

response - place to put document data

Throws:

IOException - if getting data fails

InterruptedException - if an IO operation throws it

getDocIds

public void getDocIds(DocIdPusher pusher)
               throws IOException,
                      InterruptedException

Description copied from interface: Adaptor

Pushes all the DocIds that are suppose to be indexed by the GSA. This will frequently involve re-sending DocIds to the GSA, but this allows healing previous errors and cache inconsistencies. Re-sending DocIds is very fast and should be considered free on the GSA. This method should determine a list of DocIds to push and call DocIdPusher.pushDocIds(java.lang.Iterable<com.google.enterprise.adaptor.DocId>) one or more times and DocIdPusher.pushNamedResources(java.util.Map<com.google.enterprise.adaptor.DocId, com.google.enterprise.adaptor.Acl>) if using named resources.

pusher is provided as convenience and is the same object provided to Adaptor.init(com.google.enterprise.adaptor.AdaptorContext) previously. This method may take a while and implementations are free to call Thread.sleep(long) occasionally to reduce load.

If you experience a fatal error, feel free to throw an IOException or RuntimeException. In the case of an error, the ExceptionHandler in use in AdaptorContext will determine if and when to retry.

Specified by:

getDocIds in interface Adaptor

Parameters:

pusher - used to send doc ids to GSA

Throws:

IOException - if getting data fails

InterruptedException - if an IO operations throws it

isUserAuthorized

public Map<DocId,AuthzStatus> isUserAuthorized(AuthnIdentity userIdentity,
                                               Collection<DocId> ids)
                                        throws IOException

Description copied from interface: AuthzAuthority

Determines whether the user identified is allowed to access the DocIds. The user is either anonymous or assumed to be previously authenticated. If an anonymous user is denied access to a document, then the caller may prompt the user to go through an authentication process and then try again.

Returns AuthzStatus.PERMIT for DocIds the user is allowed to access. Retutrns AuthzStatus.DENY for DocIds the user is not allowed to access. If the document exists, AuthzStatus.INDETERMINATE will not be returned for that DocId.

If the document doesn't exist, then there are several possibilities. If the repository is fully-public then it will return PERMIT. This will allow the caller to provide a cached version of the file to the user or call Adaptor.getDocContent(com.google.enterprise.adaptor.Request, com.google.enterprise.adaptor.Response) which should call Response.respondNotFound(). If the adaptor is not sensitive to users knowing that certain documents do not exist, then it will return INDETERMINATE. This will be interpreted as the document does not exist; no cached copy will be provided to the user but the user may be informed the document doesn't exist. Highly sensitive repositories may return DENY.

If you experience a fatal error, feel free to throw an IOException or RuntimeException. In the case of an error, the users will be denied access to the resources.

Specified by:

isUserAuthorized in interface AuthzAuthority

Parameters:

userIdentity - user to authorize, or null for anonymous users

ids - Collection of DocIds that need to be checked

Returns:

an AuthzStatus for each DocId provided in ids

Throws:

IOException - on failure

main

public static void main(String[] args)

Call default main for adaptors.

Parameters:

args - argv