com.google.enterprise.adaptor

Interface AsyncDocIdPusher

public interface AsyncDocIdPusher

Interface that allows asynchronous at-will pushing of DocIds to the GSA.

Method Summary

Modifier and Type	Method and Description
boolean	pushDocId(DocId docId) Push a DocId asynchronously to the GSA.
boolean	pushNamedResource(DocId docId, Acl acl) Push a named resource asynchronously to the GSA.
boolean	pushRecord(DocIdPusher.Record record) Push a Record asynchronously to the GSA.

Method Detail

pushDocId

boolean pushDocId(DocId docId)

Push a DocId asynchronously to the GSA. The DocId is enqueued and sent in the next batch to the GSA. If the queue is full, then the item will be dropped and a warning will be logged.

Parameters:

docId - that is to be crawled

Returns:

true if the DocId was accepted, false otherwise

pushRecord

boolean pushRecord(DocIdPusher.Record record)

Push a Record asynchronously to the GSA. The Record is enqueued and sent in the next batch to the GSA. If the queue is full, then the item will be dropped and a warning will be logged.

Parameters:

record - that is to be crawled

Returns:

true if the Record was accepted, false otherwise

pushNamedResource

boolean pushNamedResource(DocId docId,
                          Acl acl)

Push a named resource asynchronously to the GSA. The named resource is enqueued and sent in the next batch to the GSA. If the queue is full, then the item will be dropped and a warning will be logged.

Named resources are DocIds without any content or metadata, that only exist for ACL inheritance. These DocId will never be visible to the user and have no meaning outside of ACL processing.

Parameters:

docId - name or label of the access control list

acl - is the access control list mapped onto by docId

Returns:

true if the NamedResource was accepted, false otherwise