com.google.enterprise.connector.util.filter

Class AclPropertyFilter

java.lang.Object

com.google.enterprise.connector.util.filter.AbstractDocumentFilter

com.google.enterprise.connector.util.filter.AclPropertyFilter

All Implemented Interfaces:

DocumentFilterFactory

public class AclPropertyFilter
extends AbstractDocumentFilter

A Document filter that forces the SpiConstants.CaseSensitivityType field for all ACL Principals supplied by the connector to be set to a specified value.

This will over-ride any SpiConstants.CaseSensitivityType that may have been set by the connector, and supply one if none was set by the connector.

Example documentFilters.xml Configurations:

The following example forces all ACL Principals for all fed documents to be considered case-insensitive.

   <!-- Force case-insensitive ACLs. -->
   <bean id="CaseInsensitiveACLs"
      class="com.google.enterprise.connector.util.filter.AclPropertyFilter">
     <property name="caseSensitivityType" value="everything-case-insensitive"/>
   </bean>
   

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
AclPropertyFilter()

Method Summary

Modifier and Type	Method and Description
Property	findProperty(Document source, java.lang.String name) Finds a Property by name.
void	setCaseSensitivityType(java.lang.String caseSensitivityType) Sets the SpiConstants.CaseSensitivityType to be used for all ACL Principals supplied by the connector.
void	setOverwriteUserDomain(boolean overwriteUserDomain) Sets the overwrite value flag.
void	setUserDomain(java.lang.String userDomain) Sets the domain for users for ACL Principals.

Methods inherited from class com.google.enterprise.connector.util.filter.AbstractDocumentFilter

getPropertyNames, getPropertyValues, newDocumentFilter, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AclPropertyFilter

public AclPropertyFilter()

Method Detail

setCaseSensitivityType

public void setCaseSensitivityType(java.lang.String caseSensitivityType)

Sets the SpiConstants.CaseSensitivityType to be used for all ACL Principals supplied by the connector.

Parameters:

caseSensitivityType - a String representation of a SpiConstants.CaseSensitivityType; i.e. everything-case-sensitive or everything-case-insensitive.

setUserDomain

public void setUserDomain(java.lang.String userDomain)

Sets the domain for users for ACL Principals.

Parameters:

userDomain - the domain name to set for user principals.

Since:

3.0.8

setOverwriteUserDomain

public void setOverwriteUserDomain(boolean overwriteUserDomain)

Sets the overwrite value flag.

Parameters:

overwriteUserDomain - the overwrite flag. Overwrites the existing domain values if true, or preserves existing domain values if false.

Since:

3.0.8

findProperty

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

Finds a Property by name. If the requested property is ACL property, then checks for case sensitivity type and modifies the value if different than specified in filter. Returns ACL property with modified values.

Overrides:

findProperty in class AbstractDocumentFilter

Parameters:

source - the source Document for this filter

name - the name of the property to find

Returns:

the Property, if found; null otherwise

Throws:

RepositoryException - if a repository access error occurs

RepositoryDocumentException - if a document has fatal processing errors