public class UnsupportedDocIdPusher extends Object implements DocIdPusher
DocIdPusher that throws an
UnsupportedOperationException if any method is called.
This class is intended to be extended for unit testing, rather
than implementing the DocIdPusher interface directly.
DocIdPusher.FeedType, DocIdPusher.RecordEVERYTHING_CASE_INSENSITIVE, EVERYTHING_CASE_SENSITIVE| Constructor and Description |
|---|
UnsupportedDocIdPusher() |
| 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. |
public DocId pushDocIds(Iterable<DocId> docIds) throws InterruptedException
DocIdPusherDocIds 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 DocIdPusher.pushRecords(Iterable)
with default values for each Record.
pushDocIds in interface DocIdPusherdocIds - are document ids to be pushednull on success, otherwise the first DocId to failUnsupportedOperationException - alwaysInterruptedException - if interrupted and no DocIds were sentDocIdPusher.pushDocIds(Iterable, ExceptionHandler)public DocId pushDocIds(Iterable<DocId> docIds, ExceptionHandler handler) throws InterruptedException
DocIdPusherDocIds 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 DocIdPusher.pushRecords(Iterable, ExceptionHandler)
with default values for each Record.
pushDocIds in interface DocIdPusherdocIds - are document ids to be pushedhandler - for dealing with errors pushingnull on success, otherwise the first DocId to failUnsupportedOperationException - alwaysInterruptedException - if interrupted and no DocIds were sentpublic DocIdPusher.Record pushRecords(Iterable<DocIdPusher.Record> records) throws InterruptedException
DocIdPusherRecords 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).
pushRecords in interface DocIdPusherrecords - are document ids to be pushednull on success, otherwise the first Record to failUnsupportedOperationException - alwaysInterruptedException - if interrupted and no Records were sentDocIdPusher.pushRecords(Iterable, ExceptionHandler)public DocIdPusher.Record pushRecords(Iterable<DocIdPusher.Record> records, ExceptionHandler handler) throws InterruptedException
DocIdPusherRecords 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.
pushRecords in interface DocIdPusherrecords - are document ids to be pushedhandler - for dealing with errors pushingnull on success, otherwise the first Record to failUnsupportedOperationException - alwaysInterruptedException - if interrupted and no Records were sentpublic DocId pushNamedResources(Map<DocId,Acl> resources) throws InterruptedException
DocIdPusherNamed 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).
pushNamedResources in interface DocIdPusherresources - are labeled access control listsnull on success, otherwise the first DocId to failUnsupportedOperationException - alwaysInterruptedException - if interrupted and no resources were sentDocIdPusher.pushNamedResources(Map, ExceptionHandler)public DocId pushNamedResources(Map<DocId,Acl> resources, ExceptionHandler handler) throws InterruptedException
DocIdPusherNamed 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.
pushNamedResources in interface DocIdPusherresources - are labeled access control listshandler - for dealing with errors pushingnull on success, otherwise the first DocId to failUnsupportedOperationException - alwaysInterruptedException - if interrupted and no resources were sentpublic GroupPrincipal pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs, boolean caseSensitive) throws InterruptedException
DocIdPusherA 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).
pushGroupDefinitions in interface DocIdPusherdefs - map of group definitionscaseSensitive - when comparing Principalsnull on success, otherwise the first GroupPrincipal to failUnsupportedOperationException - alwaysInterruptedException - if interrupted and no definitions were sentDocIdPusher.pushGroupDefinitions(Map, boolean, FeedType, String, ExceptionHandler)public GroupPrincipal pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs, boolean caseSensitive, ExceptionHandler handler) throws InterruptedException
DocIdPusherA 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.
pushGroupDefinitions in interface DocIdPusherdefs - map of group definitionscaseSensitive - when comparing Principalshandler - for dealing with errors pushingnull on success, otherwise the first GroupPrincipal to failUnsupportedOperationException - alwaysInterruptedException - if interrupted and no definitions were sentDocIdPusher.pushGroupDefinitions(Map, boolean, FeedType, String, ExceptionHandler)public GroupPrincipal pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs, boolean caseSensitive, DocIdPusher.FeedType feedType, String groupSource, ExceptionHandler handler) throws InterruptedException
DocIdPusherA 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.
pushGroupDefinitions in interface DocIdPusherdefs - map of group definitionscaseSensitive - when comparing PrincipalsfeedType - if INCREMENTAL, an incremental update is done;
if REPLACE, a full replacement is done.groupSource - the feed data source namehandler - for dealing with errors pushingnull on success, otherwise the first GroupPrincipal to failUnsupportedOperationException - alwaysInterruptedException - if interrupted and no definitions were sent