Package | Description |
---|---|
com.google.enterprise.connector.spi |
Defines the SPI for connector developers who wish to write
plug-ins to the Google Search Appliance.
|
com.google.enterprise.connector.util.diffing |
The
diffing package provides a framework for writing
connectors to repositories that do not provide information about
added, deleted, or updated documents. |
com.google.enterprise.connector.util.filter |
Document
filters act to transform their source Document's
Properties . |
Modifier and Type | Class and Description |
---|---|
class |
DocumentAccessException
Thrown in cases where the search or traversal user does not have enough
privileges to access a document.
|
class |
DocumentNotFoundException
Thrown for documents that do not exist or are unknown to the connector.
|
class |
RepositoryDocumentException
Thrown for problems accessing individual documents in a repository.
|
class |
RepositoryLoginException
Thrown to indicate unsuccessful login.
|
class |
SkippedDocumentException
Thrown for documents that should be skipped for non-error reasons.
|
Modifier and Type | Method and Description |
---|---|
void |
SecureDocument.addPrincipal(java.lang.String name,
SpiConstants.AclScope scope,
SpiConstants.AclAccess access)
Adds a user or group to the ACL.
|
AuthenticationResponse |
AuthenticationManager.authenticate(AuthenticationIdentity identity)
Authenticates against the repository and returns an
AuthenticationResponse indicating whether authentication
was successful. |
java.util.Collection<AuthorizationResponse> |
AuthorizationManager.authorizeDocids(java.util.Collection<java.lang.String> docids,
AuthenticationIdentity identity)
Gets authorization from the repository for a set of documents by ID.
|
void |
DocumentAcceptor.cancel()
Cancels a feed.
|
java.lang.String |
SimpleDocumentList.checkpoint() |
java.lang.String |
DocumentList.checkpoint()
Provides a checkpoint that can be used to control traversal.
|
static SecureDocument |
SecureDocument.createDocumentWithAcl(Document document)
Constructs a
SecureDocument representing a document with
an ACL whose metadata consists of the properties of the given
Document . |
void |
ConnectorShutdownAware.delete()
The Connector instance is being removed.
|
Property |
SecureDocument.findProperty(java.lang.String name)
Finds a
Property by name. |
Property |
Document.findProperty(java.lang.String name)
Finds a
Property by name. |
void |
DocumentAcceptor.flush()
Finishes processing a document feed.
|
AuthenticationManager |
Session.getAuthenticationManager()
Gets an
AuthenticationManager . |
AuthorizationManager |
Session.getAuthorizationManager()
Gets an
AuthorizationManager . |
java.io.InputStream |
Retriever.getContent(java.lang.String docid)
Return an
InputStream that may be used to access content for the
document identified by docid . |
Lister |
ListerAware.getLister()
Return a
Lister that may be used to supply documents for indexing. |
Document |
Retriever.getMetaData(java.lang.String docid)
Return a
Document instance populated with meta-data for the
document identified by docid . |
java.util.Set<java.lang.String> |
SocialUserProfileDocument.getPropertyNames()
Gets the set of names of all
Properties in this
Document . |
java.util.Set<java.lang.String> |
SecureDocument.getPropertyNames()
Gets the set of names of all
Properties in this
Document . |
java.util.Set<java.lang.String> |
Document.getPropertyNames()
Gets the set of names of all
Properties in this
Document . |
Retriever |
RetrieverAware.getRetriever()
Return a
Retriever that may be used to access content for
specific documents. |
static Value |
Value.getSingleValue(Document document,
java.lang.String propertyName)
Convenience function for access to a single named value from a
Document . |
static java.lang.String |
Value.getSingleValueString(Document document,
java.lang.String propertyName)
Convenience function for access to a single string value from a
Document . |
TraversalManager |
Session.getTraversalManager()
Gets a
TraversalManager to implement query-based traversal. |
Session |
Connector.login()
Gets a session with sufficient privileges to perform all actions related to
the SPI.
|
Connector |
SimpleConnectorFactory.makeConnector(java.util.Map<java.lang.String,java.lang.String> config) |
Connector |
ConnectorFactory.makeConnector(java.util.Map<java.lang.String,java.lang.String> config)
Make a
Connector instance of the ConnectorType
that owns this ConnectorFactory instance using the supplied
Map of configuration properties. |
Document |
DocumentList.nextDocument()
Returns the next
Document in this document list, if there is one. |
Value |
Property.nextValue()
Returns the next
Value in this property, if there is one. |
DocumentList |
TraversalManager.resumeTraversal(java.lang.String checkPoint)
Continues traversal from a supplied checkpoint.
|
void |
TraversalManager.setBatchHint(int batchHint)
Sets the preferred batch size.
|
void |
SocialUserProfileDocument.setColleagues(java.util.List<SocialUserProfileDocument.ColleagueData> colleagues)
Sets list of colleagues of user.
|
void |
Lister.setDocumentAcceptor(DocumentAcceptor documentAcceptor)
|
void |
Lister.shutdown()
Shuts down the
Lister . |
void |
ConnectorShutdownAware.shutdown()
Instructs the Connector to shutdown.
|
void |
Lister.start()
Starts the
Lister . |
DocumentList |
TraversalManager.startTraversal()
Starts (or restarts) traversal from the beginning.
|
void |
DocumentAcceptor.take(Document document)
Takes an spi Document and pushes it along, presumably to the GSA Feed.
|
Modifier and Type | Method and Description |
---|---|
Document |
DocumentHandle.getDocument()
Returns the non-
null Document for applying this change
to the Google Search Appliance. |
DocumentHandle |
DocumentSnapshot.getUpdate(DocumentSnapshot onGsa)
Returns a
DocumentHandle for updating the referenced
document on the GSA or null if the document on the GSA
does not need updating. |
Document |
DiffingConnectorDocumentList.nextDocument() |
DocumentList |
DiffingConnectorTraversalManager.resumeTraversal(java.lang.String checkpoint) |
void |
DocumentSnapshotRepositoryMonitorManagerImpl.start(java.lang.String connectorManagerCheckpoint)
Go from "cold" to "warm" including CheckpointAndChangeQueue.
|
void |
DocumentSnapshotRepositoryMonitorManager.start(java.lang.String checkpoint)
Ensures all monitor threads are running.
|
DocumentList |
DiffingConnectorTraversalManager.startTraversal()
Start document crawling and piping as if from beginning.
|
Modifier and Type | Method and Description |
---|---|
Property |
SkipDocumentFilter.findProperty(Document source,
java.lang.String name) |
Property |
ModifyPropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
DeletePropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
CopyPropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
AddPropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
AclPropertyFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
Property |
AbstractDocumentFilter.findProperty(Document source,
java.lang.String name)
Finds a
Property by name . |
java.util.Set<java.lang.String> |
SkipDocumentFilter.getPropertyNames(Document source) |
java.util.Set<java.lang.String> |
MovePropertyFilter.getPropertyNames(Document source)
Gets the set of names of all
Properties in the
Document , substituting original names of renamed Properties
with the new name. |
java.util.Set<java.lang.String> |
DeletePropertyFilter.getPropertyNames(Document source)
Gets the set of names of all
Properties in the
Document , removing the names of deleted Properties from
the Set returned by the source Document . |
java.util.Set<java.lang.String> |
CopyPropertyFilter.getPropertyNames(Document source)
Gets the set of names of all
Properties in the
Document , including any new Properties that might be
produced by copying other Properties. |
java.util.Set<java.lang.String> |
AddPropertyFilter.getPropertyNames(Document source)
Gets the set of names of all
Properties in the
Document , including any new Properties that might be
added. |
java.util.Set<java.lang.String> |
AbstractDocumentFilter.getPropertyNames(Document source)
|
java.util.List<Value> |
AbstractDocumentFilter.getPropertyValues(Document source,
java.lang.String name)
|
Document |
DocumentFilterFactory.newDocumentFilter(Document source)
Returns a new
Document that acts as a filter for the
supplied source Document. |
Document |
DocumentFilterChain.newDocumentFilter(Document source)
Constructs a document procssing pipeline, assembled from filters fetched
from each of the
DocumentFilterFactories
in the list. |
Document |
AbstractDocumentFilter.newDocumentFilter(Document source) |