com.google.enterprise.connector.spi

Class SecureDocument

java.lang.Object

com.google.enterprise.connector.spi.SecureDocument

All Implemented Interfaces:

Document

public class SecureDocument
extends java.lang.Object
implements Document

An implementation of the Document interface for use with ACLs. Instances are created using the static factory methods. There are no public constructors. Implementors may use this directly or for reference.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
void	addPrincipal(java.lang.String name, SpiConstants.AclScope scope, SpiConstants.AclAccess access) Adds a user or group to the ACL.
static SecureDocument	createAcl(java.util.Map<java.lang.String,java.util.List<Value>> properties) Constructs a SecureDocument representing a stand-alone ACL whose metadata consists of the supplied Map of properties, associating property names with their Values.
static SecureDocument	createAcl(java.lang.String docId, java.lang.String searchUrl) Constructs a SecureDocument representing a stand-alone ACL.
static SecureDocument	createDocumentWithAcl(Document document) Constructs a SecureDocument representing a document with an ACL whose metadata consists of the properties of the given Document.
static SecureDocument	createDocumentWithAcl(java.util.Map<java.lang.String,java.util.List<Value>> properties) Constructs a SecureDocument representing a document with an ACL whose metadata consists of the supplied Map of properties, associating property names with their Values.
Property	findProperty(java.lang.String name) Finds a Property by name.
java.util.Set<java.lang.String>	getPropertyNames() Gets the set of names of all Properties in this Document.
void	setInheritanceType(SpiConstants.AclInheritanceType type) Sets the inheritance type.
void	setInheritFrom(java.lang.String url) Sets the URL for an inherited ACL.
void	setInheritFrom(java.lang.String docid, SpiConstants.FeedType feedType) Sets the components needed to construct the inherit-from URL of an ACL that was fed using FeedType.CONTENT, FeedType.CONTENTURL, or FeedType.ACL.

Methods inherited from class java.lang.Object

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

Method Detail

createAcl

public static SecureDocument createAcl(java.lang.String docId,
                                       java.lang.String searchUrl)

Constructs a SecureDocument representing a stand-alone ACL. Implies a document type of ACL.

Parameters:

docId - the unique document ID

searchUrl - the repository URL, may be null

See Also:

SpiConstants.PROPNAME_DOCID, SpiConstants.PROPNAME_SEARCHURL

createAcl

public static SecureDocument createAcl(java.util.Map<java.lang.String,java.util.List<Value>> properties)

Constructs a SecureDocument representing a stand-alone ACL whose metadata consists of the supplied Map of properties, associating property names with their Values. Implies a document type of ACL.

Parameters:

properties - a Map of document metadata

createDocumentWithAcl

public static SecureDocument createDocumentWithAcl(Document document)
                                            throws RepositoryException

Constructs a SecureDocument representing a document with an ACL whose metadata consists of the properties of the given Document. The document may represent a stand-alone ACL or an indexable document.

Parameters:

document - a base document whose properties are included in the return SecureDocument

Throws:

RepositoryException - if an error occurs accessing the underlying document

createDocumentWithAcl

public static SecureDocument createDocumentWithAcl(java.util.Map<java.lang.String,java.util.List<Value>> properties)

Constructs a SecureDocument representing a document with an ACL whose metadata consists of the supplied Map of properties, associating property names with their Values. Implies a document type of RECORD.

Parameters:

properties - a Map of document metadata

findProperty

public Property findProperty(java.lang.String name)
                      throws RepositoryException

Finds a Property by name. If the current document has a property then that property is returned.

Specified by:

findProperty in interface Document

Parameters:

name - the name of the Property to find

Returns:

the Property, if found; null otherwise

Throws:

RepositoryException - if an error occurs accessing the underlying document

getPropertyNames

public java.util.Set<java.lang.String> getPropertyNames()
                                                 throws RepositoryException

Gets the set of names of all Properties in this Document.

Specified by:

getPropertyNames in interface Document

Returns:

the names, as a Set of Strings

Throws:

RepositoryException - if an error occurs accessing the underlying document

setInheritFrom

public void setInheritFrom(java.lang.String url)

Sets the URL for an inherited ACL.

Only one of setInheritFrom(String url) or setInheritFrom(String docid, SpiConstants.FeedType feedType) should be called. If both are called the inherit-from docid and feedType will be ignored in favor of the inherit-from url.

Parameters:

url - the URL of the parent ACL

See Also:

SpiConstants.PROPNAME_ACLINHERITFROM

setInheritFrom

public void setInheritFrom(java.lang.String docid,
                           SpiConstants.FeedType feedType)

Sets the components needed to construct the inherit-from URL of an ACL that was fed using FeedType.CONTENT, FeedType.CONTENTURL, or FeedType.ACL.

Only one of setInheritFrom(String url) or setInheritFrom(String docid, SpiConstants.FeedType feedType) should be called. If both are called the inherit-from docid and feedType will be ignored in favor of the inherit-from url.

Parameters:

docid - the docid of the parent ACL document

feedType - the FeedType of the parent ACL document, or null if this document's FeedType should be used.

See Also:

SpiConstants.PROPNAME_ACLINHERITFROM

setInheritanceType

public void setInheritanceType(SpiConstants.AclInheritanceType type)

Sets the inheritance type.

Parameters:

type - one of the SpiConstants.AclInheritanceType values

See Also:

SpiConstants.PROPNAME_ACLINHERITANCETYPE

addPrincipal

public void addPrincipal(java.lang.String name,
                         SpiConstants.AclScope scope,
                         SpiConstants.AclAccess access)
                  throws RepositoryException

Adds a user or group to the ACL. The scope determines whether the principal is a user or group, and the access determines whether the principal is permitted or denied access.

Parameters:

name - the user or group name

scope - whether the principal is a user or group name, one of the SpiConstants.AclScope values

access - whether access is permitted or denied, one of the SpiConstants.AclAccess values

Throws:

RepositoryException - if an error occurs accessing the underlying document

See Also:

SpiConstants.PROPNAME_ACLGROUPS, SpiConstants.PROPNAME_ACLUSERS, SpiConstants.PROPNAME_ACLDENYGROUPS, SpiConstants.PROPNAME_ACLDENYUSERS