com.google.enterprise.adaptor

Interface DocIdPusher

All Known Implementing Classes:

AbstractDocIdPusher, RecordingDocIdPusher, UnsupportedDocIdPusher

public interface DocIdPusher

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

Avoid implementing this interface in adaptor unit tests because new methods may be added in the future. Instead use UnsupportedDocIdPusher, or use an automated mock generator like Mockito or java.lang.reflect.Proxy.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DocIdPusher.FeedType FeedType used for group definition pushes.
static class	DocIdPusher.Record Immutable feed attributes for a document identified by its DocId.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	EVERYTHING_CASE_INSENSITIVE
static boolean	EVERYTHING_CASE_SENSITIVE Not as good as an enum for case sensitivity, but backward compatible.

Method Summary

Modifier and Type	Method and Description
DocId	pushDocIds(Iterable<DocId> docIds) Push DocIds immediately and block until they are successfully provided to the GSA or the error handler gives up.
DocId	pushDocIds(Iterable<DocId> docIds, ExceptionHandler handler) Push DocIds immediately and block until they are successfully provided to the GSA or the error handler gives up.
GroupPrincipal	pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs, boolean caseSensitive) Blocking call to push group definitions to GSA ends in success or when default error handler gives up.
GroupPrincipal	pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs, boolean caseSensitive, DocIdPusher.FeedType feedType, String groupSource, ExceptionHandler handler) Blocking call to push group definitions to GSA ends in success or when provided error handler gives up.
GroupPrincipal	pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs, boolean caseSensitive, ExceptionHandler handler) Blocking call to push group definitions to GSA ends in success or when provided error handler gives up.
DocId	pushNamedResources(Map<DocId,Acl> resources) Push named resources immediately and block until they are successfully provided to the GSA or the error handler gives up.
DocId	pushNamedResources(Map<DocId,Acl> resources, ExceptionHandler handler) Push named resources immediately and block until they are successfully provided to the GSA or the error handler gives up.
DocIdPusher.Record	pushRecords(Iterable<DocIdPusher.Record> records) Push Records immediately and block until they are successfully provided to the GSA or the error handler gives up.
DocIdPusher.Record	pushRecords(Iterable<DocIdPusher.Record> records, ExceptionHandler handler) Push Records immediately and block until they are successfully provided to the GSA or the error handler gives up.

Field Detail

EVERYTHING_CASE_SENSITIVE

static final boolean EVERYTHING_CASE_SENSITIVE

Not as good as an enum for case sensitivity, but backward compatible.

See Also:

Constant Field Values

EVERYTHING_CASE_INSENSITIVE

static final boolean EVERYTHING_CASE_INSENSITIVE

See Also:

Constant Field Values

Method Detail

pushDocIds

DocId pushDocIds(Iterable<DocId> docIds)
          throws InterruptedException

Push DocIds immediately and block until they are successfully provided to the GSA or the error handler gives up. This method can take a while in error conditions, but is not something that generally needs to be avoided.

Equivalent to pushDocIds(docIds, null), and to pushRecords(Iterable) with default values for each Record.

Parameters:

docIds - are document ids to be pushed

Returns:

null on success, otherwise the first DocId to fail

Throws:

InterruptedException - if interrupted and no DocIds were sent

See Also:

pushDocIds(Iterable, ExceptionHandler)

pushDocIds

DocId pushDocIds(Iterable<DocId> docIds,
                 ExceptionHandler handler)
          throws InterruptedException

Push DocIds immediately and block until they are successfully provided to the GSA or the error handler gives up. This method can take a while in error conditions, but is not something that generally needs to be avoided.

If handler is null, then a default error handler is used.

Equivalent to pushRecords(Iterable, ExceptionHandler) with default values for each Record.

Parameters:

docIds - are document ids to be pushed

handler - for dealing with errors pushing

Returns:

null on success, otherwise the first DocId to fail

Throws:

InterruptedException - if interrupted and no DocIds were sent

pushRecords

DocIdPusher.Record pushRecords(Iterable<DocIdPusher.Record> records)
                        throws InterruptedException

Push Records immediately and block until they are successfully provided to the GSA or the error handler gives up. This method can take a while in error conditions, but is not something that generally needs to be avoided.

Equivalent to pushRecords(records, null).

Parameters:

records - are document ids to be pushed

Returns:

null on success, otherwise the first Record to fail

Throws:

InterruptedException - if interrupted and no Records were sent

See Also:

pushRecords(Iterable, ExceptionHandler)

pushRecords

DocIdPusher.Record pushRecords(Iterable<DocIdPusher.Record> records,
                               ExceptionHandler handler)
                        throws InterruptedException

Push Records immediately and block until they are successfully provided to the GSA or the error handler gives up. This method can take a while in error conditions, but is not something that generally needs to be avoided.

If handler is null, then a default error handler is used.

Parameters:

records - are document ids to be pushed

handler - for dealing with errors pushing

Returns:

null on success, otherwise the first Record to fail

Throws:

InterruptedException - if interrupted and no Records were sent

pushNamedResources

DocId pushNamedResources(Map<DocId,Acl> resources)
                  throws InterruptedException

Push named resources immediately and block until they are successfully provided to the GSA or the error handler gives up. This method can take a while in error conditions, but is not something that generally needs to be avoided.

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.

If you plan on using the return code, then the provided map should have a predictable iteration order, like TreeMap.

Equivalent to pushNamedResources(resources, null).

Parameters:

resources - are labeled access control lists

Returns:

null on success, otherwise the first DocId to fail

Throws:

InterruptedException - if interrupted and no resources were sent

See Also:

pushNamedResources(Map, ExceptionHandler)

pushNamedResources

DocId pushNamedResources(Map<DocId,Acl> resources,
                         ExceptionHandler handler)
                  throws InterruptedException

Push named resources immediately and block until they are successfully provided to the GSA or the error handler gives up. This method can take a while in error conditions, but is not something that generally needs to be avoided.

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.

If you plan on using the return code, then the provided map should have a predictable iteration order, like TreeMap.

If handler is null, then a default error handler is used.

Parameters:

resources - are labeled access control lists

handler - for dealing with errors pushing

Returns:

null on success, otherwise the first DocId to fail

Throws:

InterruptedException - if interrupted and no resources were sent

pushGroupDefinitions

GroupPrincipal pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs,
                                    boolean caseSensitive)
                             throws InterruptedException

Blocking call to push group definitions to GSA ends in success or when default error handler gives up. Can take significant time if errors arise.

A group definition consists of a group being defined and members, which is a collection of users and groups.

If you plan on using the return code, then the provided map should have a predictable iteration order, like TreeMap.

This method performs INCREMENTAL group pushes, using the default group source name, and the default ExceptionHandler.

Equivalent to pushGroupDefinitions(defs, caseSensitive, null).

Parameters:

defs - map of group definitions

caseSensitive - when comparing Principals

Returns:

null on success, otherwise the first GroupPrincipal to fail

Throws:

InterruptedException - if interrupted and no definitions were sent

See Also:

pushGroupDefinitions(Map, boolean, FeedType, String, ExceptionHandler)

pushGroupDefinitions

GroupPrincipal pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs,
                                    boolean caseSensitive,
                                    ExceptionHandler handler)
                             throws InterruptedException

Blocking call to push group definitions to GSA ends in success or when provided error handler gives up. Can take significant time if errors arise.

A group definition consists of a group being defined and members, which is a collection of users and groups.

If you plan on using the return code, then the provided map should have a predictable iteration order, like TreeMap.

If handler is null, then a default error handler is used.

This method performs INCREMENTAL group pushes, using the default group source name.

Parameters:

defs - map of group definitions

caseSensitive - when comparing Principals

handler - for dealing with errors pushing

Returns:

null on success, otherwise the first GroupPrincipal to fail

Throws:

InterruptedException - if interrupted and no definitions were sent

See Also:

pushGroupDefinitions(Map, boolean, FeedType, String, ExceptionHandler)

pushGroupDefinitions

GroupPrincipal pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs,
                                    boolean caseSensitive,
                                    DocIdPusher.FeedType feedType,
                                    String groupSource,
                                    ExceptionHandler handler)
                             throws InterruptedException

Blocking call to push group definitions to GSA ends in success or when provided error handler gives up. Can take significant time if errors arise.

A group definition consists of a group being defined and members, which is a list of users and groups.

If you plan on using the return code, then the provided map should have a predictable iteration order, like TreeMap.

An incremental push augments or updates any existing group definitions for the groupSource on the GSA. Otherwise, the supplied group definitions will wholly replace all existing definitions for the groupSource on the GSA.

A groupSource identifies the source of the group definitions. If provided, it must be a string of the form [a-zA-Z_][a-zA-Z0-9_-]* with at most 250 characters. If groupSource is null, then the feed.name configuration property is used.

If handler is null, then a default error handler is used.

Parameters:

defs - map of group definitions

caseSensitive - when comparing Principals

feedType - if INCREMENTAL, an incremental update is done; if REPLACE, a full replacement is done.

groupSource - the feed data source name

handler - for dealing with errors pushing

Returns:

null on success, otherwise the first GroupPrincipal to fail

Throws:

InterruptedException - if interrupted and no definitions were sent

Since:

4.1.4