com.google.enterprise.connector.spi

Interface Connector

All Known Implementing Classes:

DiffingConnector

public interface Connector

The root of the SPI for connector instances. The connector manager will use Spring to instantiate objects that implement this interface. The implementor MUST provide a Spring XML configuration file named connectorInstance.xml to control this process. See the package documentation for more details.

A Connector object is used as something against which to authenticate, via the login() method. By authenticating, one gets a Session, which then gives access to all other services. Note, this is presumably "superuser", one-time only authentication, not authentication for a given user query session (which takes place via the AuthenticationManager).

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Session	login() Gets a session with sufficient privileges to perform all actions related to the SPI.

Method Detail

login

Session login()
       throws RepositoryLoginException,
              RepositoryException

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.

Returns:

an object implementing the Session interface

Throws:

RepositoryLoginException - if there is a credentials-related problem

RepositoryException - if there is a more general problem, such as the system is unreachable or down