com.google.enterprise.adaptor.testing

Class RecordingDocIdPusher

java.lang.Object

com.google.enterprise.adaptor.AbstractDocIdPusher

com.google.enterprise.adaptor.testing.RecordingDocIdPusher

All Implemented Interfaces:

DocIdPusher

public class RecordingDocIdPusher
extends AbstractDocIdPusher

A fake implementation of DocIdPusher that simply records the values it receives. This implementation is not thread-safe.

Methods that return collections all return unmodifiable views of the recorded values. The collections cannot be changed directly, but they will reflect changes to the recorded values that are made through the DocIdPusher interface.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.enterprise.adaptor.DocIdPusher

DocIdPusher.FeedType, DocIdPusher.Record

Field Summary

Fields inherited from interface com.google.enterprise.adaptor.DocIdPusher

EVERYTHING_CASE_INSENSITIVE, EVERYTHING_CASE_SENSITIVE

Constructor Summary

Constructors

Constructor and Description
RecordingDocIdPusher()

Method Summary

Modifier and Type	Method and Description
List<DocId>	getDocIds() Gets an unmodifiable list of the accumulated DocIds passed to any of the pushDocIds or pushRecords methods.
Map<GroupPrincipal,Collection<Principal>>	getGroupDefinitions() Gets an unmodifiable map of the accumulated group definitions passed to any of the pushGroupDefinitions methods.
Map<GroupPrincipal,Collection<Principal>>	getGroupDefinitions(String sourceName) Gets an unmodifiable map of the accumulated group definitions passed to any of the pushGroupDefinitions methods.
Map<DocId,Acl>	getNamedResources() Gets an unmodifiable map of the accumulated named resources passed to any of the pushNamedResources methods.
List<DocIdPusher.Record>	getRecords() Gets an unmodifiable list of the accumulated Records passed to any of the pushRecords methods.
GroupPrincipal	pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs, boolean caseSensitive, DocIdPusher.FeedType feedType, String sourceName, ExceptionHandler exceptionHandler) Records the group definitions.
DocId	pushNamedResources(Map<DocId,Acl> resources, ExceptionHandler handler) Records the named resources.
DocIdPusher.Record	pushRecords(Iterable<DocIdPusher.Record> records, ExceptionHandler handler) Records the records and their DocId values.
void	reset() Clears all of the recorded data.

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

pushDocIds, pushDocIds, pushGroupDefinitions, pushGroupDefinitions, pushNamedResources, pushRecords

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordingDocIdPusher

public RecordingDocIdPusher()

Method Detail

pushRecords

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

Records the records and their DocId values.

Parameters:

records - are document ids to be pushed

handler - for dealing with errors pushing

Returns:

null, to indicate success

Throws:

InterruptedException - if interrupted and no Records were sent

pushNamedResources

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

Records the named resources.

Parameters:

resources - are labeled access control lists

handler - for dealing with errors pushing

Returns:

null, to indicate success

Throws:

InterruptedException - if interrupted and no resources were sent

pushGroupDefinitions

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

Records the group definitions.

If a membership Collection for a group is a List or Set, then a copy of the collection is made that preserves order and equality.

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.

sourceName - the feed data source name

exceptionHandler - for dealing with errors pushing

Returns:

null, to indicate success

Throws:

InterruptedException - if interrupted and no definitions were sent

getDocIds

public List<DocId> getDocIds()

Gets an unmodifiable list of the accumulated DocIds passed to any of the pushDocIds or pushRecords methods.

Returns:

an unmodifiable list of the recorded DocIds

getRecords

public List<DocIdPusher.Record> getRecords()

Gets an unmodifiable list of the accumulated Records passed to any of the pushRecords methods.

Returns:

an unmodifiable list of the recorded Records

getNamedResources

public Map<DocId,Acl> getNamedResources()

Gets an unmodifiable map of the accumulated named resources passed to any of the pushNamedResources methods. In cases where the same DocId has been passed multiple times in different calls to pushNamedResources, the most recently pushed one is included in the returned map.

Returns:

an unmodifiable map of the recorded named resources

getGroupDefinitions

public Map<GroupPrincipal,Collection<Principal>> getGroupDefinitions()

Gets an unmodifiable map of the accumulated group definitions passed to any of the pushGroupDefinitions methods. In cases where the same GroupPrincipal has been passed multiple times in different calls to pushGroupDefinitions, the most recently pushed one is included in the returned map.

Returns:

an unmodifiable map of the recorded group definitions

getGroupDefinitions

public Map<GroupPrincipal,Collection<Principal>> getGroupDefinitions(String sourceName)

Gets an unmodifiable map of the accumulated group definitions passed to any of the pushGroupDefinitions methods. In cases where the same GroupPrincipal has been passed multiple times in different calls to pushGroupDefinitions, the most recently pushed one is included in the returned map.

Parameters:

sourceName - the group source for the group definitions

Returns:

an unmodifiable map of the recorded group definitions

reset

public void reset()

Clears all of the recorded data.