com.google.enterprise.adaptor

Interface Acl.BatchRetriever

Enclosing class:

Acl

public static interface Acl.BatchRetriever

Batch retrieval of ACLs for efficent processing of many authz checks at once.

See Also:

Acl.isAuthorizedBatch(com.google.enterprise.adaptor.AuthnIdentity, java.util.Collection<com.google.enterprise.adaptor.DocId>, com.google.enterprise.adaptor.Acl.BatchRetriever)

Method Summary

Modifier and Type	Method and Description
Map<DocId,Acl>	retrieveAcls(Set<DocId> ids) Retrieve the ACLs for the requested DocIds.

Method Detail

retrieveAcls

Map<DocId,Acl> retrieveAcls(Set<DocId> ids)
                     throws IOException

Retrieve the ACLs for the requested DocIds. This method is permitted to return ACLs for DocIds not requested, but it should never provide a null value for a DocId's ACLs. If a DocId does not exist, then it should be missing in the returned map.

This method should provide any ACLs for named resources (if any are in use, which is not the common case) in addition to any normal documents. For more information about named resources, see DocIdPusher.pushNamedResources(java.util.Map<com.google.enterprise.adaptor.DocId, com.google.enterprise.adaptor.Acl>).

Parameters:

ids - ids

Returns:

Acls for ids

Throws:

IOException - if there was an error contacting the data store