public abstract class AbstractDocIdPusher extends Object implements DocIdPusher
DocIdPusher interface.DocIdPusher.FeedType, DocIdPusher.RecordEVERYTHING_CASE_INSENSITIVE, EVERYTHING_CASE_SENSITIVE| Constructor and Description |
|---|
AbstractDocIdPusher() |
| 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,
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.
|
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. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpushGroupDefinitions, pushNamedResources, pushRecordspublic DocId pushDocIds(Iterable<DocId> docIds) throws InterruptedException
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 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 failInterruptedException - if interrupted and no DocIds were sentDocIdPusher.pushDocIds(Iterable, ExceptionHandler)public DocId pushDocIds(Iterable<DocId> docIds, ExceptionHandler handler) throws InterruptedException
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 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 failInterruptedException - if interrupted and no DocIds were sentpublic DocIdPusher.Record pushRecords(Iterable<DocIdPusher.Record> records) throws InterruptedException
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).
pushRecords in interface DocIdPusherrecords - are document ids to be pushednull on success, otherwise the first Record to failInterruptedException - if interrupted and no Records were sentDocIdPusher.pushRecords(Iterable, ExceptionHandler)public DocId pushNamedResources(Map<DocId,Acl> resources) throws InterruptedException
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).
pushNamedResources in interface DocIdPusherresources - are labeled access control listsnull on success, otherwise the first DocId to failInterruptedException - if interrupted and no resources were sentDocIdPusher.pushNamedResources(Map, ExceptionHandler)public GroupPrincipal pushGroupDefinitions(Map<GroupPrincipal,? extends Collection<Principal>> defs, boolean caseSensitive) throws InterruptedException
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).
pushGroupDefinitions in interface DocIdPusherdefs - map of group definitionscaseSensitive - when comparing Principalsnull on success, otherwise the first GroupPrincipal to failInterruptedException - 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
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.
pushGroupDefinitions in interface DocIdPusherdefs - map of group definitionscaseSensitive - when comparing Principalshandler - for dealing with errors pushingnull on success, otherwise the first GroupPrincipal to failInterruptedException - if interrupted and no definitions were sentDocIdPusher.pushGroupDefinitions(Map, boolean, FeedType, String, ExceptionHandler)