com.google.enterprise.connector.util.diffing

Class DiffingConnector

java.lang.Object

com.google.enterprise.connector.util.diffing.DiffingConnector

All Implemented Interfaces:

Connector, ConnectorShutdownAware, Session

public class DiffingConnector
extends java.lang.Object
implements Connector, ConnectorShutdownAware, Session

Diffing connector implementation of the SPI Connector interface.

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
DiffingConnector(AuthorizationManager authorizationManager, DocumentSnapshotRepositoryMonitorManager repositoryMonitorManager, TraversalContextManager traversalContextManager) Creates a DiffingConnector.

Method Summary

Modifier and Type	Method and Description
void	delete() Delete the snapshot and persistent storage for this connector.
AuthenticationManager	getAuthenticationManager() Gets an AuthenticationManager.
AuthorizationManager	getAuthorizationManager() Gets an AuthorizationManager.
TraversalManager	getTraversalManager() Creates and returns a TraversalManager which can start and resume traversals.
Session	login() Gets a session with sufficient privileges to perform all actions related to the SPI.
void	shutdown() Shut down this connector: interrupt the background threads and wait for them to terminate.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiffingConnector

public DiffingConnector(AuthorizationManager authorizationManager,
                        DocumentSnapshotRepositoryMonitorManager repositoryMonitorManager,
                        TraversalContextManager traversalContextManager)

Creates a DiffingConnector.

Parameters:

authorizationManager - an AuthorizationManager

repositoryMonitorManager - a DocumentSnapshotRepositoryMonitorManager

traversalContextManager - a TraversalContextManager

Method Detail

shutdown

public void shutdown()

Shut down this connector: interrupt the background threads and wait for them to terminate.

Specified by:

shutdown in interface ConnectorShutdownAware

delete

public void delete()

Delete the snapshot and persistent storage for this connector. Invokes shutdown() first.

Specified by:

delete in interface ConnectorShutdownAware

login

public Session login()

Description copied from interface: Connector

Gets a session with sufficient privileges to perform all actions related to the SPI. Credentials, if needed, are supplied externally through injection via Spring or some other mechanism. If an exception is thrown, the implementor should provide an explanatory message.

Specified by:

login in interface Connector

Returns:

an object implementing the Session interface

getAuthenticationManager

public AuthenticationManager getAuthenticationManager()

Description copied from interface: Session

Gets an AuthenticationManager. It is permissible to return null. A null return means that this implementation does not support an authentication manager. This may be for one of these reasons:

• Authentication is not needed for this data source
• Authentication is handled through another Search Appliance-supported mechanism, such as LDAP

Specified by:

getAuthenticationManager in interface Session

Returns:

an AuthenticationManager - may be null

getAuthorizationManager

public AuthorizationManager getAuthorizationManager()

Description copied from interface: Session

Gets an AuthorizationManager. It is permissible to return null. A null return means that this implementation does not support an authorization manager. This may be for one of these reasons:

• Authorization is not needed for this data source - all documents are public
• Authorization is handled through another Search Appliance-supported mechanism, such as NTLM or Basic Auth

Specified by:

getAuthorizationManager in interface Session

Returns:

an AuthorizationManager - may be null

getTraversalManager

public TraversalManager getTraversalManager()

Creates and returns a TraversalManager which can start and resume traversals. Getting a traversal manager invalidates previously acquired TraversalManagers. This operation has the expense of stopping current crawls, forcing them to be restarted (at initial or resume points) when further docs are requested via returned TraversalManager.

Specified by:

getTraversalManager in interface Session

Returns:

a Diffing Connector TraversalManager