Package com.google.enterprise.adaptor

Adaptor interfaces and implementation.

See:
          Description

Interface Summary
Acl.BatchRetriever Batch retrieval of ACLs for efficent processing of many authz checks at once.
Adaptor Interface for user-specific implementation details of an Adaptor.
AdaptorContext Methods for an Adaptor to communicate with the adaptor library.
AsyncDocIdPusher Interface that allows asynchronous at-will pushing of DocIds to the GSA.
AuthnAuthority Interface for adaptors capable of authenticating users.
AuthnAuthority.Callback Interface for replying to AuthnAdaptor.authenticateUser(HttpExchange, Callback).
AuthnIdentity User identification information for understanding who a user is or if they are allowed to access a resource.
AuthzAuthority Interface for adaptors capable of authorizing users.
DocIdEncoder Allows generating a URI for a particular DocId.
DocIdPusher Interface that allows at-will pushing of DocIds to the GSA.
DocumentTransform Represents an individual transform in the transform pipeline.
ExceptionHandler Interface for handling errors and handling retrying policy.
PollingIncrementalLister Interface for library-assisted polling incremental adaptors.
Request Interface provided to Adaptor.getDocContent(Request, Response) for describing the action that should be taken.
Response Interface provided to Adaptor.getDocContent(Request, Response) for performing the actions needed to satisfy a request.
SensitiveValueDecoder Provides parsing of sensitive values that can be plain text, obfuscated, or encrypted.
Session Generic session-state container, but intended for authn bookkeeping.
Status Multi-state indicator providing the user with a notification of broken parts of the system.
StatusSource A source of Status messages.
 

Class Summary
AbstractAdaptor Provides a reasonable default implementation for most Adaptor methods.
Acl Immutable access control list.
Acl.Builder Mutable ACL for creating instances of Acl.
Application Provides framework for adaptors to act as a stand-alone application.
CommandStreamParser Parses the adaptor data format into individual commands with associated data.
Config Configuration values for this program, like the GSA's hostname.
CustomFormatter Custom log formatter for ease of development.
Daemon Allows running an adaptor as a daemon when used in conjunction with procrun or jsvc.
DocId Refers to a unique document in repository.
DocIdPusher.Record Immutable feed attributes for a document identified by its DocId.
DocIdPusher.Record.Builder Builder to create instances of Record.
ExceptionHandlers Utility class for ExceptionHandlers.
GroupPrincipal Represents group.
GsaCommunicationHandler This class handles the communications with GSA.
HttpExchanges Utility class for working with HttpExchanges.
IOHelper Utility class for providing useful methods when handling streams or other forms of I/O.
Metadata Allows storing multiple metadata values to a single key.
Principal Represents either a user or a group.
Service Provides environment for running multiple adaptors on the same port and having each instance be managed.
UserPrincipal Represents user.
 

Enum Summary
Acl.InheritanceType The rule for combining a parent's authz response with its child's.
AuthzStatus Authorization status codes.
Status.Code Available statuses for displaying state indicators on the dashboard.
 

Exception Summary
InvalidConfigurationException Thrown for unrecoverable configuration errors.
StartupException Thrown for unrecoverable startup errors, such as fatal configuration errors or running on the wrong platform.
UnsupportedPlatformException Thrown if the adaptor cannot be run on this OS environment.
 

Package com.google.enterprise.adaptor Description

Adaptor interfaces and implementation. Uses combination of a document feed and an accompanying HTTP server.

Feed files, with lists of ids encoded as URLs, are pushed to GSA.

GSA crawls by making requests for file contents.