com.google.enterprise.connector.spi

Interface TraversalContext

All Known Implementing Classes:

FakeTraversalContext, SimpleTraversalContext

public interface TraversalContext

A callback interface that the Connector Manager will pass in to a TraversalManager, which the traversal manager can the use to call back to get information from the Connector Manager. Thus, the connector developer does not need to provide an implementation of this object. However, for testing purposes, the developer may want to provide a temporary implementation.

Since:

1.0

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.
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.

Method Detail

maxDocumentSize

long maxDocumentSize()

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.

Returns:

the maximum supported document size limit in bytes

mimeTypeSupportLevel

int mimeTypeSupportLevel(java.lang.String mimeType)

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.

Returns:

the support level - non-positive means no support

preferredMimeType

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

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.

Parameters:

mimeTypes - a Set of mime types

Returns:

the most preferred mime type from the Set

Since:

1.3

traversalTimeLimitSeconds

long traversalTimeLimitSeconds()

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.

Returns:

the time in seconds allotted for traversals to complete

Since:

2.4

supportsInheritedAcls

boolean supportsInheritedAcls()

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 supportsDenyAcls() will also return true.

Returns:

true if Documents may include enhanced ACL support

Since:

3.0

See Also:

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

supportsDenyAcls

boolean supportsDenyAcls()

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 supportsInheritedAcls() instead of this method. If this method returns false, then supportsDenyAcls() will also return false.

Returns:

true if Documents may include DENY users or groups

Since:

3.0.4

See Also:

SecureDocument, SpiConstants.PROPNAME_ACLDENYGROUPS, SpiConstants.PROPNAME_ACLDENYUSERS