com.google.enterprise.connector.spi

Class SimpleTraversalContext

java.lang.Object

com.google.enterprise.connector.spi.SimpleTraversalContext

All Implemented Interfaces:

TraversalContext

Direct Known Subclasses:

FakeTraversalContext

public class SimpleTraversalContext
extends java.lang.Object
implements TraversalContext

Simple implementation of the TraversalContext interface. Connector developers may want to use this to implement unit tests.

By default, instances of this class accept all document sizes and content types.

Since:

2.4

Constructor Summary

Constructors

Constructor and Description
SimpleTraversalContext()

Method Summary

Modifier and Type	Method and Description
long	maxDocumentSize() Gets a size limit for contents passed through the connector framework.
int	mimeTypeSupportLevel(java.lang.String mimeType) Gets information about whether a mime type is supported.
java.lang.String	preferredMimeType(java.util.Set<java.lang.String> mimeTypes) Returns the most preferred mime type from the supplied set.
void	setMaxDocumentSize(long maxDocumentSize)
void	setMimeTypeSet(java.util.Set<java.lang.String> mimeTypeSet)
void	setSupportsDenyAcls(boolean supportsDenyAcls)
void	setSupportsInheritedAcls(boolean supportsInheritedAcls)
void	setTraversalTimeLimitSeconds(long limit)
boolean	supportsDenyAcls() Returns true if Documents may include DENY users or groups in an ACL.
boolean	supportsInheritedAcls() Returns true if Documents may include full ACL support, specifically DENY users or groups, ACL inheritance, and ACL-only Documents.
long	traversalTimeLimitSeconds() Returns the time in seconds for allotted traversals to complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleTraversalContext

public SimpleTraversalContext()

Method Detail

setMaxDocumentSize

public void setMaxDocumentSize(long maxDocumentSize)

setMimeTypeSet

public void setMimeTypeSet(java.util.Set<java.lang.String> mimeTypeSet)

setTraversalTimeLimitSeconds

public void setTraversalTimeLimitSeconds(long limit)

setSupportsInheritedAcls

public void setSupportsInheritedAcls(boolean supportsInheritedAcls)

Since:

3.0

setSupportsDenyAcls

public void setSupportsDenyAcls(boolean supportsDenyAcls)

Since:

3.0.4

maxDocumentSize

public long maxDocumentSize()

Description copied from interface: TraversalContext

Gets a size limit for contents passed through the connector framework. If a developer has a way of asking the repository for the size of a content file before fetching it, then a comparison with this size would save the developer the cost of fetching a content that is too big to be used.

Specified by:

maxDocumentSize in interface TraversalContext

Returns:

the maximum supported document size limit in bytes

mimeTypeSupportLevel

public int mimeTypeSupportLevel(java.lang.String mimeType)

Description copied from interface: TraversalContext

Gets information about whether a mime type is supported. Positive values indicate possible support for this mime type, with larger values indicating better support or preference.

Non-positive numbers mean that there is no support for this mime type. A zero value indicates the content encoding is not supported. The connector may choose to supply meta-data for the document, but the content should not be provided.

A negative value indicates the document should be skipped entirely. Neither the content, nor the meta-data should be provided.

Specified by:

mimeTypeSupportLevel in interface TraversalContext

Returns:

the support level - non-positive means no support

preferredMimeType

public java.lang.String preferredMimeType(java.util.Set<java.lang.String> mimeTypes)

Description copied from interface: TraversalContext

Returns the most preferred mime type from the supplied set. This returns the mime type from the set with the highest support level. Mime types with "/vnd.*" subtypes are preferred over others, and mime types registered with IANA are preferred over those with "/x-*" experimental subtypes.

If a repository contains multiple renditions of a particular item, it may use this to select the best rendition to supply for indexing.

Specified by:

preferredMimeType in interface TraversalContext

Parameters:

mimeTypes - a Set of mime types

Returns:

the most preferred mime type from the Set

traversalTimeLimitSeconds

public long traversalTimeLimitSeconds()

Description copied from interface: TraversalContext

Returns the time in seconds for allotted traversals to complete. Both TraversalManager.startTraversal() and TraversalManager.resumeTraversal(String) can avoid interrupts due to timeouts by returning within this amount of time.

Specified by:

traversalTimeLimitSeconds in interface TraversalContext

Returns:

the time in seconds allotted for traversals to complete

supportsInheritedAcls

public boolean supportsInheritedAcls()

Description copied from interface: TraversalContext

Returns true if Documents may include full ACL support, specifically DENY users or groups, ACL inheritance, and ACL-only Documents. Some earlier Search Appliance implementations do not support these features. This method will always return false if the feed.disable.inherited.acls property in applicationContext.xml is set to true. If this method returns true, then TraversalContext.supportsDenyAcls() will also return true.

Specified by:

supportsInheritedAcls in interface TraversalContext

Returns:

true if Documents may include enhanced ACL support

See Also:

SecureDocument, SpiConstants.AclInheritanceType, SpiConstants.FeedType, SpiConstants.PROPNAME_ACLINHERITFROM, SpiConstants.PROPNAME_ACLINHERITANCETYPE, SpiConstants.PROPNAME_ACLDENYGROUPS, SpiConstants.PROPNAME_ACLDENYUSERS

supportsDenyAcls

public boolean supportsDenyAcls()

Description copied from interface: TraversalContext

Returns true if Documents may include DENY users or groups in an ACL. Some earlier Search Appliance implementations do not support this feature. A connector that requires inheritance in order to implement DENY should use TraversalContext.supportsInheritedAcls() instead of this method. If this method returns false, then TraversalContext.supportsDenyAcls() will also return false.

Specified by:

supportsDenyAcls in interface TraversalContext

Returns:

true if Documents may include DENY users or groups

See Also:

SecureDocument, SpiConstants.PROPNAME_ACLDENYGROUPS, SpiConstants.PROPNAME_ACLDENYUSERS