Index

A B C D E F G H I K L M N O P R S T U V W

A

AbstractAdaptor - Class in com.google.enterprise.adaptor: Provides a reasonable default implementation for most Adaptor methods.
AbstractAdaptor() - Constructor for class com.google.enterprise.adaptor.AbstractAdaptor
Acl - Class in com.google.enterprise.adaptor: Immutable access control list.
Acl.BatchRetriever - Interface in com.google.enterprise.adaptor: Batch retrieval of ACLs for efficent processing of many authz checks at once.
Acl.Builder - Class in com.google.enterprise.adaptor: Mutable ACL for creating instances of Acl.
Acl.InheritanceType - Enum in com.google.enterprise.adaptor: The rule for combining a parent's authz response with its child's.
AclPopulator - Class in com.google.enterprise.adaptor.experimental: Result of running this adaptor: 1.
AclPopulator() - Constructor for class com.google.enterprise.adaptor.experimental.AclPopulator
Adaptor - Interface in com.google.enterprise.adaptor: Interface for user-specific implementation details of an Adaptor.
AdaptorContext - Interface in com.google.enterprise.adaptor: Methods for an Adaptor to communicate with the adaptor library.
AdaptorTemplate - Class in com.google.enterprise.adaptor.examples: Demonstrates what code is necessary for putting public content onto a GSA.
AdaptorTemplate() - Constructor for class com.google.enterprise.adaptor.examples.AdaptorTemplate
AdaptorWithCrawlTimeMetadataTemplate - Class in com.google.enterprise.adaptor.examples: Demonstrates what code is necessary for putting restricted content onto a GSA.
AdaptorWithCrawlTimeMetadataTemplate() - Constructor for class com.google.enterprise.adaptor.examples.AdaptorWithCrawlTimeMetadataTemplate
AdaptorWithRespondNoContentTemplate - Class in com.google.enterprise.adaptor.examples: Demonstrates what code is necessary for responding NO_CONTENT (204) to GSA.
AdaptorWithRespondNoContentTemplate() - Constructor for class com.google.enterprise.adaptor.examples.AdaptorWithRespondNoContentTemplate
AdaptorWithTwoParentOverrides - Class in com.google.enterprise.adaptor.examples: Example with depth three ACL chain.
AdaptorWithTwoParentOverrides() - Constructor for class com.google.enterprise.adaptor.examples.AdaptorWithTwoParentOverrides
add(String, String) - Method in class com.google.enterprise.adaptor.Metadata: Increases values mapped to k with v.
addAnchor(URI, String) - Method in interface com.google.enterprise.adaptor.Response: Add a hyperlink for the GSA to follow without modifying the document contents.
AddContentTypeToMetadata - Class in com.google.enterprise.adaptor.examples: Example transform adding type metadata based on extension.
AddContentTypeToMetadata(String) - Constructor for class com.google.enterprise.adaptor.examples.AddContentTypeToMetadata
addKey(String, String) - Method in class com.google.enterprise.adaptor.Config: Add configuration key.
addMetadata(String, String) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Add a new name/value to the metadata for the document this record is providing information for.
addMetadata(String, String) - Method in interface com.google.enterprise.adaptor.Response: Add metadata element that applies to the document.
addStatusSource(StatusSource) - Method in interface com.google.enterprise.adaptor.AdaptorContext: Add a status source to the dashboard.
Application - Class in com.google.enterprise.adaptor: Provides framework for adaptors to act as a stand-alone application.
Application(Adaptor, Config) - Constructor for class com.google.enterprise.adaptor.Application
AsyncDocIdPusher - Interface in com.google.enterprise.adaptor: Interface that allows asynchronous at-will pushing of DocIds to the GSA.
authenticateUser(HttpExchange, AuthnAuthority.Callback) - Method in interface com.google.enterprise.adaptor.AuthnAuthority: Authenticate the user connected via ex.
AuthnAuthority - Interface in com.google.enterprise.adaptor: Interface for adaptors capable of authenticating users.
AuthnAuthority.Callback - Interface in com.google.enterprise.adaptor: Interface for replying to AuthnAdaptor.authenticateUser(HttpExchange, Callback).
AuthnIdentity - Interface in com.google.enterprise.adaptor: User identification information for understanding who a user is or if they are allowed to access a resource.
AuthzAuthority - Interface in com.google.enterprise.adaptor: Interface for adaptors capable of authorizing users.
AuthzStatus - Enum in com.google.enterprise.adaptor: Authorization status codes.

B

build() - Method in class com.google.enterprise.adaptor.Acl.Builder: Create immutable Acl instance of the current state.
build() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Creates single instance of Record.
Builder() - Constructor for class com.google.enterprise.adaptor.Acl.Builder: Create new empty builder.
Builder(Acl) - Constructor for class com.google.enterprise.adaptor.Acl.Builder: Create and initialize builder with ACL information provided in acl.
Builder(DocId) - Constructor for class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Create mutable builder for building DocIdPusher.Record instances.
Builder(DocIdPusher.Record) - Constructor for class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Create mutable builder initialized to values provided by startPoint.

C

canRespondWithNoContent(Date) - Method in interface com.google.enterprise.adaptor.Request: Returns true if the GSA or other client's current copy of the document was retrieved after the lastModified date and GSA can handle HTTP 204 response; false otherwise.
checkAndScheduleImmediatePushOfDocIds() - Method in class com.google.enterprise.adaptor.GsaCommunicationHandler: Ensure there is a push running right now.
checkAndScheduleIncrementalPushOfDocIds() - Method in class com.google.enterprise.adaptor.GsaCommunicationHandler: Perform an push of incremental changes.
close() - Method in class com.google.enterprise.adaptor.ContentTransform
com.google.enterprise.adaptor - package com.google.enterprise.adaptor: Adaptor interfaces and implementation.
com.google.enterprise.adaptor.examples - package com.google.enterprise.adaptor.examples
com.google.enterprise.adaptor.experimental - package com.google.enterprise.adaptor.experimental
com.google.enterprise.adaptor.prebuilt - package com.google.enterprise.adaptor.prebuilt
Command - Class in com.google.enterprise.adaptor.prebuilt: Exec helper that allows easy handling of stdin, stdout, and stderr.
Command.Result - Class in com.google.enterprise.adaptor.prebuilt: Result data from an invocation
CommandLineAdaptor - Class in com.google.enterprise.adaptor.prebuilt: Command Line Adaptor
CommandLineAdaptor() - Constructor for class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
CommandLineTransform - Class in com.google.enterprise.adaptor.prebuilt: A conduit that allows a simple way to create a document transform based on a command line program.
CommandLineTransform() - Constructor for class com.google.enterprise.adaptor.prebuilt.CommandLineTransform
CommandStreamParser - Class in com.google.enterprise.adaptor: Parses the adaptor data format into individual commands with associated data.
CommandStreamParser(InputStream) - Constructor for class com.google.enterprise.adaptor.CommandStreamParser
compareTo(DocId) - Method in class com.google.enterprise.adaptor.DocId: Provides comparison for ids based on the unique id string.
compareTo(Principal) - Method in class com.google.enterprise.adaptor.Principal: Sorts by 1) namespace, 2) user or group, 3) name.
Config - Class in com.google.enterprise.adaptor: Configuration values for this program, like the GSA's hostname.
Config() - Constructor for class com.google.enterprise.adaptor.Config
config - Variable in class com.google.enterprise.adaptor.ContentTransform
ContentTransform - Class in com.google.enterprise.adaptor: The document content transform can modify the content of a document.
ContentTransform(Map<String, String>, Metadata, String, OutputStream) - Constructor for class com.google.enterprise.adaptor.ContentTransform: Constructs a document content transform.
contentType - Variable in class com.google.enterprise.adaptor.ContentTransform
copyMetadata(Map<String, String>) - Static method in class com.google.enterprise.adaptor.prebuilt.PrebuiltTransforms: Returns a transform that copies metadata values from one key to another.
copyStream(InputStream, OutputStream) - Static method in class com.google.enterprise.adaptor.IOHelper: Copy contents of in to out.
create(Map<String, String>) - Static method in class com.google.enterprise.adaptor.examples.AddContentTypeToMetadata
create(Map<String, String>) - Static method in class com.google.enterprise.adaptor.examples.MetadataTransformExample: Makes transform from config with "src" and "dest" keys.
create(Map<String, String>) - Static method in class com.google.enterprise.adaptor.prebuilt.CommandLineTransform: Accepts keys "cmd", "workingDirectory", and "arg?".
create(Map<String, String>) - Static method in class com.google.enterprise.adaptor.prebuilt.FilterMimetypes
create(Map<String, String>) - Static method in class com.google.enterprise.adaptor.prebuilt.SkipDocumentFilter
createHttpContext(String, HttpHandler) - Method in interface com.google.enterprise.adaptor.AdaptorContext: Registers a handler with the library's HttpServer in similar fashion to HttpServer.createContext(java.lang.String, com.sun.net.httpserver.HttpHandler).
createInstance(String, File, File) - Method in class com.google.enterprise.adaptor.Service
CustomFormatter - Class in com.google.enterprise.adaptor: Custom log formatter for ease of development.
CustomFormatter() - Constructor for class com.google.enterprise.adaptor.CustomFormatter

D

Daemon - Class in com.google.enterprise.adaptor: Allows running an adaptor as a daemon when used in conjunction with procrun or jsvc.
Daemon() - Constructor for class com.google.enterprise.adaptor.Daemon
DateSplitTransform - Class in com.google.enterprise.adaptor.examples: Metadata Transform to split date field into 3 separate metadata fields (month, day, year) Specify the name of the metadata field containing the date as dateField and the format of the date as dateFormat.
DbAdaptorTemplate - Class in com.google.enterprise.adaptor.examples: Demonstrates what code is necessary for putting DB content onto a GSA.
DbAdaptorTemplate() - Constructor for class com.google.enterprise.adaptor.examples.DbAdaptorTemplate
decodeValue(String) - Method in interface com.google.enterprise.adaptor.SensitiveValueDecoder: Decode an encoded sensitive string into its original string.
DEFAULT_NAMESPACE - Static variable in class com.google.enterprise.adaptor.Principal
defaultHandler() - Static method in class com.google.enterprise.adaptor.ExceptionHandlers: The default exception handler.
deleteInstance(String, long, TimeUnit) - Method in class com.google.enterprise.adaptor.Service
deleteMetadata(Map<String, String>) - Static method in class com.google.enterprise.adaptor.prebuilt.PrebuiltTransforms: Returns a transform that deletes metadata keys.
destroy() - Method in class com.google.enterprise.adaptor.AbstractAdaptor: Shutdown and release resources of adaptor.
destroy() - Method in interface com.google.enterprise.adaptor.Adaptor: Shutdown and release resources of adaptor.
destroy() - Method in class com.google.enterprise.adaptor.Daemon
DocId - Class in com.google.enterprise.adaptor: Refers to a unique document in repository.
DocId(String) - Constructor for class com.google.enterprise.adaptor.DocId: Construct an identifier based on id.
DocIdEncoder - Interface in com.google.enterprise.adaptor: Allows generating a URI for a particular DocId.
DocIdPusher - Interface in com.google.enterprise.adaptor: Interface that allows at-will pushing of DocIds to the GSA.
DocIdPusher.Record - Class in com.google.enterprise.adaptor: Immutable feed attributes for a document identified by its DocId.
DocIdPusher.Record.Builder - Class in com.google.enterprise.adaptor: Builder to create instances of Record.
DocumentTransform - Interface in com.google.enterprise.adaptor: Deprecated.

E

EMPTY - Static variable in class com.google.enterprise.adaptor.Acl: Empty convenience instance with all defaults used.
enableCompressionIfSupported(HttpExchange) - Static method in class com.google.enterprise.adaptor.HttpExchanges: If the client supports it, set the correct headers and streams to provide GZIPed response data to the client.
encodeDocId(DocId) - Method in interface com.google.enterprise.adaptor.DocIdEncoder
ensureLatestConfigLoaded() - Method in class com.google.enterprise.adaptor.Config
equals(Object) - Method in class com.google.enterprise.adaptor.Acl: Equality is determined if all the permit/deny sets are equal and the inheritance is equal.
equals(Object) - Method in class com.google.enterprise.adaptor.DocId: Determines equality based on the unique id string.
equals(Object) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: Checks for equality based on all visible fields.
equals(Object) - Method in class com.google.enterprise.adaptor.Metadata: True if exactly the same key-values are represented.
equals(Object) - Method in class com.google.enterprise.adaptor.Principal
ExceptionHandler - Interface in com.google.enterprise.adaptor: Interface for handling errors and handling retrying policy.
ExceptionHandlers - Class in com.google.enterprise.adaptor: Utility class for ExceptionHandlers.
exec(String[]) - Static method in class com.google.enterprise.adaptor.prebuilt.Command: Same as exec(command, null, new byte[0]).
exec(String[], File) - Static method in class com.google.enterprise.adaptor.prebuilt.Command: Same as exec(command, workingDir, new byte[0]).
exec(String[], byte[]) - Static method in class com.google.enterprise.adaptor.prebuilt.Command: Same as exec(command, null, stdin).
exec(String[], File, byte[]) - Static method in class com.google.enterprise.adaptor.prebuilt.Command: Create process command starting in the workingDir and providing stdin as input.
exec(String[], StreamingCommand.InputSource, StreamingCommand.OutputSink, StreamingCommand.OutputSink) - Static method in class com.google.enterprise.adaptor.prebuilt.StreamingCommand: Same as exec(command, null, stdin, stdout, stderr).
exec(String[], File, StreamingCommand.InputSource, StreamingCommand.OutputSink, StreamingCommand.OutputSink) - Static method in class com.google.enterprise.adaptor.prebuilt.StreamingCommand: Create process command starting in the workingDir and providing stdin as input.
executeAuthorizer(String[], byte[]) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
executeLister(String[], StreamingCommand.InputSource, StreamingCommand.OutputSink, StreamingCommand.OutputSink) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
executeRetriever(String[], StreamingCommand.InputSource, StreamingCommand.OutputSink, StreamingCommand.OutputSink) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
exponentialBackoffHandler(int, long, TimeUnit) - Static method in class com.google.enterprise.adaptor.ExceptionHandlers: Create a handler that uses exponential backoff to sleep before retrying.

F

FileSystemAdaptor - Class in com.google.enterprise.adaptor.examples: Simple example adaptor that serves files from the local filesystem.
FileSystemAdaptor() - Constructor for class com.google.enterprise.adaptor.examples.FileSystemAdaptor
FileSystemAdaptor - Class in com.google.enterprise.adaptor.prebuilt: Adaptor serving files from current directory
FileSystemAdaptor() - Constructor for class com.google.enterprise.adaptor.prebuilt.FileSystemAdaptor
FilterMimetypes - Class in com.google.enterprise.adaptor.prebuilt: Transform causing exclusion of certain mime-types.
flush() - Method in class com.google.enterprise.adaptor.ContentTransform
format(LogRecord) - Method in class com.google.enterprise.adaptor.CustomFormatter
from(String) - Static method in enum com.google.enterprise.adaptor.MetadataTransform.TransmissionDecision

G

getAdaptor() - Method in class com.google.enterprise.adaptor.GsaCommunicationHandler
getAllKeys() - Method in class com.google.enterprise.adaptor.Config
getAllValues(String) - Method in class com.google.enterprise.adaptor.Metadata: Gives unmodifiable reference to inserted values for key, empty if none.
getAsyncDocIdPusher() - Method in interface com.google.enterprise.adaptor.AdaptorContext: Callback object for asynchronously pushing DocIds to the GSA at any time.
getAttribute(String) - Method in interface com.google.enterprise.adaptor.Session: Get attribute value.
getCause() - Method in exception com.google.enterprise.adaptor.prebuilt.RecursiveFileIterator.WrappedIOException
getCode() - Method in interface com.google.enterprise.adaptor.Status: The code to represent the state of the status.
getCommandAcceptsParameters() - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineTransform
getConfig() - Method in interface com.google.enterprise.adaptor.AdaptorContext: Configuration instance for the adaptor and all things within the adaptor library.
getConfig() - Method in class com.google.enterprise.adaptor.Application
getContentTypeOutputForContentTypeInput(String) - Static method in class com.google.enterprise.adaptor.ContentTransform: Specify the transformation in ContentType, where applicable.
getDenies() - Method in class com.google.enterprise.adaptor.Acl: Returns immutable set of denied users and groups;
getDenyGroups() - Method in class com.google.enterprise.adaptor.Acl: Returns immutable set of denied groups.
getDenyUsers() - Method in class com.google.enterprise.adaptor.Acl: Returns immutable set of denied users.
getDescription() - Method in enum com.google.enterprise.adaptor.AuthzStatus
getDocContent(Request, Response) - Method in interface com.google.enterprise.adaptor.Adaptor: Provides contents and metadata of particular document.
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.examples.AdaptorTemplate: Gives the bytes of a document referenced with id.
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithCrawlTimeMetadataTemplate: Gives the bytes of a document referenced with id.
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithRespondNoContentTemplate
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithTwoParentOverrides: Gives the bytes of a document referenced with id.
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.examples.DbAdaptorTemplate: Gives the bytes of a document referenced with id.
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.examples.FileSystemAdaptor
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsFromCsv
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsScaleTester
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsWriter
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.experimental.AclPopulator
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.experimental.MetadataExplorer: Gives the bytes of a document referenced with id.
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.experimental.NamedResourceFirehose
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.experimental.SharePointStateFileAdaptor
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.experimental.StresserAdaptor
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor: Gives the bytes of a document referenced with id.
getDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.prebuilt.FileSystemAdaptor
getDocId() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: The identifier for the document this record is providing information for.
getDocId() - Method in interface com.google.enterprise.adaptor.Request: Provides the document ID for the document that is being requested.
getDocIdEncoder() - Method in interface com.google.enterprise.adaptor.AdaptorContext: A way to construct URIs from DocIds.
getDocIdPusher() - Method in interface com.google.enterprise.adaptor.AdaptorContext: Callback object for pushing DocIds to the GSA at any time.
getDocIds(DocIdPusher) - Method in interface com.google.enterprise.adaptor.Adaptor: Pushes all the DocIds that are suppose to be indexed by the GSA.
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.examples.AdaptorTemplate: Gives list of document ids that you'd like on the GSA.
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithCrawlTimeMetadataTemplate: Gives list of document ids that you'd like on the GSA.
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithRespondNoContentTemplate
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithTwoParentOverrides: Gives list of document ids that you'd like on the GSA.
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.examples.DbAdaptorTemplate: Get all doc ids from database.
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.examples.FileSystemAdaptor
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsFromCsv
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsScaleTester
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsWriter
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.experimental.AclPopulator
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.experimental.MetadataExplorer: Gives list of document ids that you'd like on the GSA.
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.experimental.NamedResourceFirehose
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.experimental.SharePointStateFileAdaptor
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.experimental.StresserAdaptor
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
getDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.prebuilt.FileSystemAdaptor
getExcludedMimetypes() - Method in class com.google.enterprise.adaptor.prebuilt.FilterMimetypes
getGetDocIdsFullErrorHandler() - Method in interface com.google.enterprise.adaptor.AdaptorContext: Retrieve the current ExceptionHandler for full push.
getGetDocIdsIncrementalErrorHandler() - Method in interface com.google.enterprise.adaptor.AdaptorContext: Retrieve the current ExceptionHandler for incremental push.
getGroups() - Method in interface com.google.enterprise.adaptor.AuthnIdentity: Gets all the groups a user belongs to in an immutable set.
getGsaCommunicationHandler() - Method in class com.google.enterprise.adaptor.Application
getIfModifiedSince(HttpExchange) - Static method in class com.google.enterprise.adaptor.HttpExchanges: Retrieves and parses the If-Modified-Since from the request, returning null if there was no such header or there was an error.
getInheritanceType() - Method in class com.google.enterprise.adaptor.Acl: Returns the inheritance type used to combine authz decisions of these ACLs with its child.
getInheritFrom() - Method in class com.google.enterprise.adaptor.Acl: Returns DocId these ACLs are inherited from.
getInheritFromFragment() - Method in class com.google.enterprise.adaptor.Acl: Returns fragment, if there is one, that specifies which of the parent's ACLs is to to be inhertied from.
getKeys() - Method in class com.google.enterprise.adaptor.Metadata: Get modifiable set of all keys with at least one value.
getLastAccessTime() - Method in interface com.google.enterprise.adaptor.Request: Returns the last time a GSA or other client retrieved the data, or null if none was provided by the client.
getLastModified() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: The last modified date of the document.
getListerCommand() - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
getListOfConfigs(String) - Method in class com.google.enterprise.adaptor.Config: Returns a list of maps corresponding to each item of the comma-separated value of key.
getMessage(Locale) - Method in interface com.google.enterprise.adaptor.Status: A message appropriate for displaying to an end-user concerning the state of the status.
getMetadata() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: The Metadata (possibly null) for the document this record is providing information for.
getModifiedDocIds(DocIdPusher) - Method in class com.google.enterprise.adaptor.experimental.NamedResourceFirehose
getModifiedDocIds(DocIdPusher) - Method in interface com.google.enterprise.adaptor.PollingIncrementalLister: Check for documents modified since the last call to the method.
getName() - Method in class com.google.enterprise.adaptor.Principal
getName(Locale) - Method in interface com.google.enterprise.adaptor.StatusSource: Get the name of this source, for displaying to the user.
getNamespace() - Method in class com.google.enterprise.adaptor.Principal
getOneValue(String) - Method in class com.google.enterprise.adaptor.Metadata: One of the inserted values, or null if none.
getOutputStream() - Method in interface com.google.enterprise.adaptor.Response: Get stream to write document contents to.
getPassword() - Method in interface com.google.enterprise.adaptor.AuthnIdentity: Gets the user's password.
getPermitGroups() - Method in class com.google.enterprise.adaptor.Acl: Returns immutable set of permitted groups.
getPermits() - Method in class com.google.enterprise.adaptor.Acl: Returns immutable set of permitted users and groups.
getPermitUsers() - Method in class com.google.enterprise.adaptor.Acl: Returns immutable set of permitted users.
getRawValue(String) - Method in class com.google.enterprise.adaptor.Config: Get a configuration value exactly as provided in configuration.
getRequestUri(HttpExchange) - Static method in class com.google.enterprise.adaptor.HttpExchanges: Best-effort attempt to reform the identical URI the client used to contact the server.
getResultLink() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: The URI that should be displayed to the user in search results.
getRetrieverCommand() - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
getReturnCode() - Method in class com.google.enterprise.adaptor.prebuilt.Command.Result
getSensitiveValueDecoder() - Method in interface com.google.enterprise.adaptor.AdaptorContext: Retrieve decoder for sensitive values, like passwords.
getStatsDocContent(Request, Response) - Method in class com.google.enterprise.adaptor.experimental.SharePointStateFileAdaptor
getStderr() - Method in class com.google.enterprise.adaptor.prebuilt.Command.Result
getStdout() - Method in class com.google.enterprise.adaptor.prebuilt.Command.Result
getSupportedMimetypes() - Method in class com.google.enterprise.adaptor.prebuilt.FilterMimetypes
getTransformCommand() - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineTransform
getUniqueId() - Method in class com.google.enterprise.adaptor.DocId: Returns the string identifier provided to the constructor.
getUnsupportedMimetypes() - Method in class com.google.enterprise.adaptor.prebuilt.FilterMimetypes
getUser() - Method in interface com.google.enterprise.adaptor.AuthnIdentity: Gets the user principal.
getUserSession(HttpExchange, boolean) - Method in interface com.google.enterprise.adaptor.AdaptorContext: Get the session for the user communicating via ex.
getValue(String) - Method in class com.google.enterprise.adaptor.Config: Get a configuration value as computed based on the configuration.
getValuesWithPrefix(String) - Method in class com.google.enterprise.adaptor.Config: Gets all configuration values that begin with prefix, returning them as a map with the keys having prefix removed.
getVersionNumber() - Method in class com.google.enterprise.adaptor.CommandStreamParser
getWorkingDirectory() - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineTransform
GroupDefinitionsFromCsv - Class in com.google.enterprise.adaptor.examples: Reads memberships from CSV, forms groups, and sends to to GSA.
GroupDefinitionsFromCsv() - Constructor for class com.google.enterprise.adaptor.examples.GroupDefinitionsFromCsv
GroupDefinitionsScaleTester - Class in com.google.enterprise.adaptor.examples: Creates groups and users and pushes some number of principals per group.
GroupDefinitionsScaleTester() - Constructor for class com.google.enterprise.adaptor.examples.GroupDefinitionsScaleTester
GroupDefinitionsWriter - Class in com.google.enterprise.adaptor.examples: Demonstrates sending group definitions to GSA.
GroupDefinitionsWriter() - Constructor for class com.google.enterprise.adaptor.examples.GroupDefinitionsWriter
GroupPrincipal - Class in com.google.enterprise.adaptor: Represents group.
GroupPrincipal(String, String) - Constructor for class com.google.enterprise.adaptor.GroupPrincipal
GroupPrincipal(String) - Constructor for class com.google.enterprise.adaptor.GroupPrincipal
GsaCommunicationHandler - Class in com.google.enterprise.adaptor: This class handles the communications with GSA.
GsaCommunicationHandler(Adaptor, Config) - Constructor for class com.google.enterprise.adaptor.GsaCommunicationHandler

H

handleException(Exception, int) - Method in interface com.google.enterprise.adaptor.ExceptionHandler: Determine how to proceed after an exception was thrown.
hasChangedSinceLastAccess(Date) - Method in interface com.google.enterprise.adaptor.Request: Returns true if the GSA or other client's current copy of the document was retrieved after the lastModified date; false otherwise.
hashCode() - Method in class com.google.enterprise.adaptor.Acl: Returns a hash code for this object that agrees with equals.
hashCode() - Method in class com.google.enterprise.adaptor.DocId: Generates a hash code based on the unique id string.
hashCode() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: Generates hash code based on all visible fields.
hashCode() - Method in class com.google.enterprise.adaptor.Metadata
hashCode() - Method in class com.google.enterprise.adaptor.Principal
hasNext() - Method in class com.google.enterprise.adaptor.prebuilt.RecursiveFileIterator: Returns true if the iteration has more elements.
headersSent(HttpExchange) - Static method in class com.google.enterprise.adaptor.HttpExchanges: Determines if the headers have already been sent for the exchange.
HttpExchanges - Class in com.google.enterprise.adaptor: Utility class for working with HttpExchanges.

I

init(AdaptorContext) - Method in class com.google.enterprise.adaptor.AbstractAdaptor: Initialize adaptor with the current context.
init(AdaptorContext) - Method in interface com.google.enterprise.adaptor.Adaptor: Initialize adaptor with the current context.
init(DaemonContext) - Method in class com.google.enterprise.adaptor.Daemon
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithCrawlTimeMetadataTemplate
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithRespondNoContentTemplate
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.examples.DbAdaptorTemplate
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.examples.FileSystemAdaptor
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsFromCsv
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsScaleTester
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.experimental.AclPopulator
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.experimental.MetadataExplorer
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.experimental.NamedResourceFirehose
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.experimental.SharePointStateFileAdaptor
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.experimental.StresserAdaptor
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
init(AdaptorContext) - Method in class com.google.enterprise.adaptor.prebuilt.FileSystemAdaptor
initConfig(Config) - Method in class com.google.enterprise.adaptor.AbstractAdaptor: Provides the opportunity for the Adaptor to create new configuration values or override default values.
initConfig(Config) - Method in interface com.google.enterprise.adaptor.Adaptor: Provides the opportunity for the Adaptor to create new configuration values or override default values.
initConfig(Config) - Method in class com.google.enterprise.adaptor.examples.DbAdaptorTemplate
initConfig(Config) - Method in class com.google.enterprise.adaptor.examples.FileSystemAdaptor
initConfig(Config) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsFromCsv
initConfig(Config) - Method in class com.google.enterprise.adaptor.examples.GroupDefinitionsScaleTester
initConfig(Config) - Method in class com.google.enterprise.adaptor.experimental.NamedResourceFirehose
initConfig(Config) - Method in class com.google.enterprise.adaptor.experimental.SharePointStateFileAdaptor
initConfig(Config) - Method in class com.google.enterprise.adaptor.experimental.StresserAdaptor
initConfig(Config) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
initConfig(Config) - Method in class com.google.enterprise.adaptor.prebuilt.FileSystemAdaptor
InvalidConfigurationException - Exception in com.google.enterprise.adaptor: Thrown for unrecoverable configuration errors.
InvalidConfigurationException() - Constructor for exception com.google.enterprise.adaptor.InvalidConfigurationException: Constructs a new InvalidConfigurationException with no message and no cause.
InvalidConfigurationException(String) - Constructor for exception com.google.enterprise.adaptor.InvalidConfigurationException: Constructs a InvalidConfigurationException with a supplied message but no cause.
InvalidConfigurationException(String, Throwable) - Constructor for exception com.google.enterprise.adaptor.InvalidConfigurationException: Constructs a InvalidConfigurationException with message and cause.
InvalidConfigurationException(Throwable) - Constructor for exception com.google.enterprise.adaptor.InvalidConfigurationException: Constructs a InvalidConfigurationException with specified cause, copying its message if cause is non-null.
IOHelper - Class in com.google.enterprise.adaptor: Utility class for providing useful methods when handling streams or other forms of I/O.
isAuthorized(AuthnIdentity, List<Acl>) - Static method in class com.google.enterprise.adaptor.Acl: Determine if the provided userIdentity belonging to groups is authorized for the provided aclChain.
isAuthorizedBatch(AuthnIdentity, Collection<DocId>, Acl.BatchRetriever) - Static method in class com.google.enterprise.adaptor.Acl: Check authz for many DocIds at once.
isAuthorizedLocal(AuthnIdentity) - Method in class com.google.enterprise.adaptor.Acl: Determine if the provided userIdentifier belonging to groups is authorized, ignoring inheritance.
isEmpty() - Method in class com.google.enterprise.adaptor.Metadata
isEverythingCaseInsensitive() - Method in class com.google.enterprise.adaptor.Acl: Says whether letter casing doesn't matter during authorization.
isEverythingCaseSensitive() - Method in class com.google.enterprise.adaptor.Acl: Says whether letter casing differentiates names during authorization.
isGroup() - Method in class com.google.enterprise.adaptor.GroupPrincipal: Always returns true.
isGroup() - Method in class com.google.enterprise.adaptor.Principal
isGroup() - Method in class com.google.enterprise.adaptor.UserPrincipal: Always returns false.
isToBeCrawledImmediately() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: Informs the GSA that the document has been modified, and the GSA should give high priority to recrawling the document.
isToBeCrawledOnce() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: Informs the GSA that it should only crawl the document once.
isToBeDeleted() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: Whether the GSA is being informed the document has been deleted.
isToBeLocked() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: Locks the document into the GSA's index.
isUseColor() - Method in class com.google.enterprise.adaptor.CustomFormatter
isUser() - Method in class com.google.enterprise.adaptor.GroupPrincipal: Always returns false.
isUser() - Method in class com.google.enterprise.adaptor.Principal
isUser() - Method in class com.google.enterprise.adaptor.UserPrincipal: Always returns true.
isUserAuthorized(AuthnIdentity, Collection<DocId>) - Method in interface com.google.enterprise.adaptor.AuthzAuthority: Determines whether the user identified is allowed to access the DocIds.
isUserAuthorized(AuthnIdentity, Collection<DocId>) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithCrawlTimeMetadataTemplate
isUserAuthorized(AuthnIdentity, Collection<DocId>) - Method in class com.google.enterprise.adaptor.examples.AdaptorWithRespondNoContentTemplate
isUserAuthorized(AuthnIdentity, Collection<DocId>) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor: Determines whether the user identified is allowed to access the DocIds.
iterator() - Method in class com.google.enterprise.adaptor.Metadata: Provides every key and value in immutable entries sorted alphabetically, first by key, and secondly by value.
iterator() - Method in class com.google.enterprise.adaptor.prebuilt.RecursiveFileIterator: Returns this to allow using with foreach loops.

K

KEY_CONTENT_TYPE - Static variable in interface com.google.enterprise.adaptor.MetadataTransform
KEY_CRAWL_ONCE - Static variable in interface com.google.enterprise.adaptor.MetadataTransform
KEY_DISPLAY_URL - Static variable in interface com.google.enterprise.adaptor.MetadataTransform
KEY_DOC_ID - Static variable in interface com.google.enterprise.adaptor.MetadataTransform
KEY_LAST_MODIFIED_MILLIS_UTC - Static variable in interface com.google.enterprise.adaptor.MetadataTransform
KEY_LOCK - Static variable in interface com.google.enterprise.adaptor.MetadataTransform
KEY_TRANSMISSION_DECISION - Static variable in interface com.google.enterprise.adaptor.MetadataTransform

L

load(String) - Method in class com.google.enterprise.adaptor.Config: Load user-provided configuration file.
load(File) - Method in class com.google.enterprise.adaptor.Config: Load user-provided configuration file.
load(Map<String, String>) - Static method in class com.google.enterprise.adaptor.examples.DateSplitTransform: Called as metadata.transform.pipeline.<stepX>.factoryMethod for this transformation pipeline as specified in adaptor-config.properties.

M

main(Adaptor, String[]) - Static method in class com.google.enterprise.adaptor.AbstractAdaptor: Standard main for all adaptors (including those not extending AbstractAdaptor).
main(Adaptor, String[]) - Static method in class com.google.enterprise.adaptor.Application: Main for adaptors to utilize when wanting to act as an application.
main(String[]) - Static method in class com.google.enterprise.adaptor.examples.AdaptorTemplate: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.examples.AdaptorWithCrawlTimeMetadataTemplate: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.examples.AdaptorWithRespondNoContentTemplate: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.examples.AdaptorWithTwoParentOverrides: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.examples.DbAdaptorTemplate
main(String[]) - Static method in class com.google.enterprise.adaptor.examples.FileSystemAdaptor: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.examples.GroupDefinitionsFromCsv
main(String[]) - Static method in class com.google.enterprise.adaptor.examples.GroupDefinitionsScaleTester
main(String[]) - Static method in class com.google.enterprise.adaptor.examples.GroupDefinitionsWriter
main(String[]) - Static method in class com.google.enterprise.adaptor.experimental.AclPopulator: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.experimental.MetadataExplorer: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.experimental.NamedResourceFirehose: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.experimental.SharePointStateFileAdaptor: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.experimental.Sim
main(String[]) - Static method in class com.google.enterprise.adaptor.experimental.StresserAdaptor: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.prebuilt.FileSystemAdaptor: Call default main for adaptors.
main(String[]) - Static method in class com.google.enterprise.adaptor.Service
metadata - Variable in class com.google.enterprise.adaptor.ContentTransform
Metadata - Class in com.google.enterprise.adaptor: Allows storing multiple metadata values to a single key.
Metadata() - Constructor for class com.google.enterprise.adaptor.Metadata: Create empty instance.
Metadata(Iterable<Map.Entry<String, String>>) - Constructor for class com.google.enterprise.adaptor.Metadata: Duplicate.
MetadataExplorer - Class in com.google.enterprise.adaptor.experimental: Demonstrates what happens when "intersecting" Metadata elements are specified in the Lister, Retriever, and internal Metadata of an object.
MetadataExplorer() - Constructor for class com.google.enterprise.adaptor.experimental.MetadataExplorer
MetadataTransform - Interface in com.google.enterprise.adaptor: Represents an individual transform in the transform pipeline.
MetadataTransform.HistoricalWrapper - Class in com.google.enterprise.adaptor: Versions prior to 4.1.1 used class named "DocumentTransform".
MetadataTransform.TransmissionDecision - Enum in com.google.enterprise.adaptor: Transforms can cancel sending doc, or cancel sending its contents.
MetadataTransformExample - Class in com.google.enterprise.adaptor.examples: Example transform which will move values from one key to another.
moveMetadata(Map<String, String>) - Static method in class com.google.enterprise.adaptor.prebuilt.PrebuiltTransforms: Returns a transform that moves metadata values from one key to another.

N

NamedResourceFirehose - Class in com.google.enterprise.adaptor.experimental: Result of running this adaptor: 1.
NamedResourceFirehose() - Constructor for class com.google.enterprise.adaptor.experimental.NamedResourceFirehose
next() - Method in class com.google.enterprise.adaptor.prebuilt.RecursiveFileIterator: Returns the next file in the iteratior.
noRetryHandler() - Static method in class com.google.enterprise.adaptor.ExceptionHandlers: Create a handler that always returns false, causing no retries.

O

overrideKey(String, String) - Method in class com.google.enterprise.adaptor.Config: Change the default value of a preexisting configuration key.

P

parseQueryParameters(HttpExchange, Charset) - Static method in class com.google.enterprise.adaptor.HttpExchanges: Parse request GET query parameters of ex into its parts, correctly taking into account charset.
percentDecode(String) - Static method in class com.google.enterprise.adaptor.experimental.Sim
PollingIncrementalLister - Interface in com.google.enterprise.adaptor: Interface for library-assisted polling incremental adaptors.
PrebuiltTransforms - Class in com.google.enterprise.adaptor.prebuilt: Common transforms that you would expect to have available.
Principal - Class in com.google.enterprise.adaptor: Represents either a user or a group.
pushDocId(DocId) - Method in interface com.google.enterprise.adaptor.AsyncDocIdPusher: Push a DocId asynchronously to the GSA.
pushDocIds(Iterable<DocId>) - Method in interface com.google.enterprise.adaptor.DocIdPusher: Push DocIds immediately and block until they are successfully provided to the GSA or the error handler gives up.
pushDocIds(Iterable<DocId>, ExceptionHandler) - Method in interface com.google.enterprise.adaptor.DocIdPusher: Push DocIds immediately and block until they are successfully provided to the GSA or the error handler gives up.
pushGroupDefinitions(Map<GroupPrincipal, ? extends Collection<Principal>>, boolean) - Method in interface com.google.enterprise.adaptor.DocIdPusher: Blocking call to push group definitions to GSA ends in success or when default error handler gives up.
pushGroupDefinitions(Map<GroupPrincipal, ? extends Collection<Principal>>, boolean, ExceptionHandler) - Method in interface com.google.enterprise.adaptor.DocIdPusher: Blocking call to push group definitions to GSA ends in success or when provided error handler gives up.
pushNamedResource(DocId, Acl) - Method in interface com.google.enterprise.adaptor.AsyncDocIdPusher: Push a named resource asynchronously to the GSA.
pushNamedResources(Map<DocId, Acl>) - Method in interface com.google.enterprise.adaptor.DocIdPusher: Push named resources immediately and block until they are successfully provided to the GSA or the error handler gives up.
pushNamedResources(Map<DocId, Acl>, ExceptionHandler) - Method in interface com.google.enterprise.adaptor.DocIdPusher: Push named resources immediately and block until they are successfully provided to the GSA or the error handler gives up.
pushRecord(DocIdPusher.Record) - Method in interface com.google.enterprise.adaptor.AsyncDocIdPusher: Push a Record asynchronously to the GSA.
pushRecords(Iterable<DocIdPusher.Record>) - Method in interface com.google.enterprise.adaptor.DocIdPusher: Push Records immediately and block until they are successfully provided to the GSA or the error handler gives up.
pushRecords(Iterable<DocIdPusher.Record>, ExceptionHandler) - Method in interface com.google.enterprise.adaptor.DocIdPusher: Push Records immediately and block until they are successfully provided to the GSA or the error handler gives up.
putNamedResource(String, Acl) - Method in interface com.google.enterprise.adaptor.Response: Provide alternative ACLs for this document, uniquely identified by response document's DocId and fragment.

R

readFromAuthorizer() - Method in class com.google.enterprise.adaptor.CommandStreamParser
readFromLister(DocIdPusher, ExceptionHandler) - Method in class com.google.enterprise.adaptor.CommandStreamParser: Parse a listing response, sending results to pusher.
readFromRetriever(DocId, Response) - Method in class com.google.enterprise.adaptor.CommandStreamParser
readFully(InputStream, byte[], int, int) - Static method in class com.google.enterprise.adaptor.IOHelper: Reads a specified number of bytes from a stream.
readInputStreamToByteArray(InputStream) - Static method in class com.google.enterprise.adaptor.IOHelper: Read the contents of is into a byte array.
readInputStreamToString(InputStream, Charset) - Static method in class com.google.enterprise.adaptor.IOHelper: Form a string from the contents of instream with charset charset.
RecursiveFileIterator - Class in com.google.enterprise.adaptor.prebuilt: Iterate over all files within a folder, including files in subdirectories.
RecursiveFileIterator(File) - Constructor for class com.google.enterprise.adaptor.prebuilt.RecursiveFileIterator
RecursiveFileIterator.WrappedIOException - Exception in com.google.enterprise.adaptor.prebuilt: Allows throwing IOExceptions and allowing the caller to unpack and rethrow them with certainty.
remove() - Method in class com.google.enterprise.adaptor.prebuilt.RecursiveFileIterator: Unsupported.
removeAttribute(String) - Method in interface com.google.enterprise.adaptor.Session: Remove attribute value.
replaceMetadata(Map<String, String>) - Static method in class com.google.enterprise.adaptor.prebuilt.PrebuiltTransforms: Returns a transform that preforms string replacements within metadata values.
Request - Interface in com.google.enterprise.adaptor: Interface provided to Adaptor.getDocContent(Request, Response) for describing the action that should be taken.
respondNoContent() - Method in interface com.google.enterprise.adaptor.Response: Respond to the GSA that it already has the latest content of a file but not necessarily the latest ACLs or metadata; Respond to non GSA client that it already has the latest version of a file.
respondNotFound() - Method in interface com.google.enterprise.adaptor.Response: Respond to the GSA or other client that the request document does not exist.
respondNotModified() - Method in interface com.google.enterprise.adaptor.Response: Respond to the GSA or other client that it already has the latest version of a file and its metadata.
Response - Interface in com.google.enterprise.adaptor: Interface provided to Adaptor.getDocContent(Request, Response) for performing the actions needed to satisfy a request.
Result(int, byte[], byte[]) - Constructor for class com.google.enterprise.adaptor.prebuilt.Command.Result: Construct a result.
retrieveAcls(Set<DocId>) - Method in interface com.google.enterprise.adaptor.Acl.BatchRetriever: Retrieve the ACLs for the requested DocIds.
retrieveStatus() - Method in interface com.google.enterprise.adaptor.StatusSource: Retrieve the current status.
run() - Method in class com.google.enterprise.adaptor.experimental.Sim

S

sendRedirect(HttpExchange, URI) - Static method in class com.google.enterprise.adaptor.HttpExchanges: Redirect client to location.
SensitiveValueDecoder - Interface in com.google.enterprise.adaptor: Provides parsing of sensitive values that can be plain text, obfuscated, or encrypted.
Service - Class in com.google.enterprise.adaptor: Provides environment for running multiple adaptors on the same port and having each instance be managed.
Service.Instance - Class in com.google.enterprise.adaptor: Maybe use this as an interface to allow disabling/enabling and starting/stopping of particular instances?
serviceStart(String[]) - Static method in class com.google.enterprise.adaptor.Daemon
serviceStop(String[]) - Static method in class com.google.enterprise.adaptor.Daemon
Session - Interface in com.google.enterprise.adaptor: Generic session-state container, but intended for authn bookkeeping.
set(String, String) - Method in class com.google.enterprise.adaptor.Metadata: Make value be only value associated with key.
set(String, Set<String>) - Method in class com.google.enterprise.adaptor.Metadata: Make copy of v be the values associated with key.
set(Iterable<Map.Entry<String, String>>) - Method in class com.google.enterprise.adaptor.Metadata: Replaces entries inside of this metadata with provided ones.
setAcl(Acl) - Method in interface com.google.enterprise.adaptor.Response: Provide the document's ACLs for early-binding security on the GSA.
setAttribute(String, Object) - Method in interface com.google.enterprise.adaptor.Session: Set attribute value, replacing existing value if it already exists.
setAuthnAuthority(AuthnAuthority) - Method in interface com.google.enterprise.adaptor.AdaptorContext: Register an authentication provider, so it can authenticate users for the GSA.
setAuthzAuthority(AuthzAuthority) - Method in interface com.google.enterprise.adaptor.AdaptorContext: Register an authorization provider, so it can check authorization of users for the GSA.
setCommandAcceptsParameters(boolean) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineTransform: This controls whether the input parameters to the transform call are passed along to the actual call to the command.
setContentType(String) - Method in interface com.google.enterprise.adaptor.Response: Describe the content type of the document.
setCrawlImmediately(boolean) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Inform the GSA that the document has been modified, and that the GSA should give high priority to recrawling the document.
setCrawlOnce(boolean) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Instruct the GSA to not recrawl the document after the initial retrieval.
setCrawlOnce(boolean) - Method in interface com.google.enterprise.adaptor.Response: Instruct the GSA to not recrawl the document after the initial retrieval.
setDeleteFromIndex(boolean) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Set whether the GSA is being informed the document has been deleted.
setDenies(Collection<Principal>) - Method in class com.google.enterprise.adaptor.Acl.Builder: Replace existing deny users and groups.
setDenyGroups(Collection<GroupPrincipal>) - Method in class com.google.enterprise.adaptor.Acl.Builder: Replace existing deny groups.
setDenyUsers(Collection<UserPrincipal>) - Method in class com.google.enterprise.adaptor.Acl.Builder: Replace existing deny users.
setDisplayUrl(URI) - Method in interface com.google.enterprise.adaptor.Response: Set the URI to be displayed in search results.
setDocId(DocId) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Set the identifier for the document this record is providing information for.
setEverythingCaseInsensitive() - Method in class com.google.enterprise.adaptor.Acl.Builder
setEverythingCaseSensitive() - Method in class com.google.enterprise.adaptor.Acl.Builder
setGetDocIdsFullErrorHandler(ExceptionHandler) - Method in interface com.google.enterprise.adaptor.AdaptorContext: Override the default ExceptionHandler for full push.
setGetDocIdsIncrementalErrorHandler(ExceptionHandler) - Method in interface com.google.enterprise.adaptor.AdaptorContext: Override the default ExceptionHandler for incremental push.
setInheritanceType(Acl.InheritanceType) - Method in class com.google.enterprise.adaptor.Acl.Builder: Set the type of inheritance of ACL information used to combine authz decisions of these ACLs with its child.
setInheritFrom(DocId) - Method in class com.google.enterprise.adaptor.Acl.Builder: Set DocId to inherit ACLs from.
setInheritFrom(DocId, String) - Method in class com.google.enterprise.adaptor.Acl.Builder: Set the parent to inherit ACLs from.
setLastModified(Date) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Provides the last-modified date of the document.
setLastModified(HttpExchange, Date) - Static method in class com.google.enterprise.adaptor.HttpExchanges
setLastModified(Date) - Method in interface com.google.enterprise.adaptor.Response: Provide the last modification time of the document.
setListerCommand(List<String>) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
setLock(boolean) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Instruct the GSA to "lock" the document into its index.
setLock(boolean) - Method in interface com.google.enterprise.adaptor.Response: Instruct the GSA to "lock" the document into its index.
setMetadata(Metadata) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Replace the metadata for the document this record is providing information for.
setNoArchive(boolean) - Method in interface com.google.enterprise.adaptor.Response: Whether the GSA should show the "Cached" link in search results for this document.
setNoFollow(boolean) - Method in interface com.google.enterprise.adaptor.Response: Whether the GSA should follow the links within the document to find other documents.
setNoIndex(boolean) - Method in interface com.google.enterprise.adaptor.Response: Whether the GSA should index the content for searching.
setPermitGroups(Collection<GroupPrincipal>) - Method in class com.google.enterprise.adaptor.Acl.Builder: Replace existing permit groups.
setPermits(Collection<Principal>) - Method in class com.google.enterprise.adaptor.Acl.Builder: Replace existing permit users and groups.
setPermitUsers(Collection<UserPrincipal>) - Method in class com.google.enterprise.adaptor.Acl.Builder: Replace existing permit users.
setPollingIncrementalLister(PollingIncrementalLister) - Method in interface com.google.enterprise.adaptor.AdaptorContext: Register a polling incremental lister, so that it can be called when appropriate.
setResultLink(URI) - Method in class com.google.enterprise.adaptor.DocIdPusher.Record.Builder: Set the URI to be displayed to the user in search results.
setRetrieverCommand(List<String>) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineAdaptor
setSecure(boolean) - Method in interface com.google.enterprise.adaptor.Response: Mark the document as secure, for use with late-binding security.
setTransformCommand(List<String>) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineTransform: Sets the command that is in charge of transforming the document content.
setup(HttpServer, HttpServer, String) - Method in class com.google.enterprise.adaptor.GsaCommunicationHandler: Start services necessary for handling outgoing requests.
setUseColor(boolean) - Method in class com.google.enterprise.adaptor.CustomFormatter
setWorkingDirectory(File) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineTransform: Sets the working directory.
SharePointStateFileAdaptor - Class in com.google.enterprise.adaptor.experimental: This is an experimental adaptor which reads State files created by 3.x SharePoint Connector and generate DocIds to create similar site structure.
SharePointStateFileAdaptor() - Constructor for class com.google.enterprise.adaptor.experimental.SharePointStateFileAdaptor
Sim - Class in com.google.enterprise.adaptor.experimental: Accepts adaptor feeds and issues requests for documents.
Sim() - Constructor for class com.google.enterprise.adaptor.experimental.Sim
sink(InputStream) - Method in interface com.google.enterprise.adaptor.prebuilt.StreamingCommand.OutputSink: Consume content from in.
SkipDocumentFilter - Class in com.google.enterprise.adaptor.prebuilt: Transform causing exclusion of certain Documents, based on that document's Metadata properties.
source(OutputStream) - Method in interface com.google.enterprise.adaptor.prebuilt.StreamingCommand.InputSource: Generate content and write it to out.
start() - Method in class com.google.enterprise.adaptor.Application: Start necessary services for receiving requests and managing background tasks.
start() - Method in class com.google.enterprise.adaptor.Daemon
start(Runnable) - Method in class com.google.enterprise.adaptor.GsaCommunicationHandler: Start servicing incoming requests.
start() - Method in class com.google.enterprise.adaptor.Service
StartupException - Exception in com.google.enterprise.adaptor: Thrown for unrecoverable startup errors, such as fatal configuration errors or running on the wrong platform.
StartupException() - Constructor for exception com.google.enterprise.adaptor.StartupException: Constructs a new StartupException with no message and no cause.
StartupException(String) - Constructor for exception com.google.enterprise.adaptor.StartupException: Constructs a StartupException with a supplied message but no cause.
StartupException(String, Throwable) - Constructor for exception com.google.enterprise.adaptor.StartupException: Constructs a StartupException with message and cause.
StartupException(Throwable) - Constructor for exception com.google.enterprise.adaptor.StartupException: Constructs a StartupException with specified cause, copying its message if cause is non-null.
Status - Interface in com.google.enterprise.adaptor: Multi-state indicator providing the user with a notification of broken parts of the system.
Status.Code - Enum in com.google.enterprise.adaptor: Available statuses for displaying state indicators on the dashboard.
StatusSource - Interface in com.google.enterprise.adaptor: A source of Status messages.
stop(long, TimeUnit) - Method in class com.google.enterprise.adaptor.Application: Stop processing incoming requests and background tasks, allowing graceful shutdown.
stop() - Method in class com.google.enterprise.adaptor.Daemon
stop(long, TimeUnit) - Method in class com.google.enterprise.adaptor.GsaCommunicationHandler: Stops servicing incoming requests, allowing up to maxDelay seconds for things to shutdown.
stop(long, TimeUnit) - Method in class com.google.enterprise.adaptor.Service
StreamingCommand - Class in com.google.enterprise.adaptor.prebuilt: Exec helper that allows easy handling of stdin, stdout, and stderr.
StreamingCommand.InputSource - Interface in com.google.enterprise.adaptor.prebuilt: Content source that generates content at the rate it can be consumed.
StreamingCommand.OutputSink - Interface in com.google.enterprise.adaptor.prebuilt: Content sink that consumes content as soon as it becomes available.
streamInputSource(InputStream) - Static method in class com.google.enterprise.adaptor.prebuilt.StreamingCommand: InputStream to StreamingCommand.InputSource adaptor.
streamOutputSink(OutputStream) - Static method in class com.google.enterprise.adaptor.prebuilt.StreamingCommand: OutputStream to StreamingCommand.OutputSink adaptor.
StresserAdaptor - Class in com.google.enterprise.adaptor.experimental: Result of running this adaptor: 1.
StresserAdaptor() - Constructor for class com.google.enterprise.adaptor.experimental.StresserAdaptor

T

teardown() - Method in class com.google.enterprise.adaptor.GsaCommunicationHandler: Stop services necessary for handling outgoing requests.
toString() - Method in class com.google.enterprise.adaptor.Acl: Generates a string useful for debugging that contains users and groups along with inheritance information.
toString() - Method in class com.google.enterprise.adaptor.ContentTransform
toString() - Method in class com.google.enterprise.adaptor.DocId: Generates a string useful for debugging that contains the unique id.
toString() - Method in class com.google.enterprise.adaptor.DocIdPusher.Record: Generates a string representation of this instance useful for debugging that contains all visible fields.
toString() - Method in class com.google.enterprise.adaptor.examples.AddContentTypeToMetadata
toString() - Method in class com.google.enterprise.adaptor.examples.MetadataTransformExample
toString() - Method in class com.google.enterprise.adaptor.Metadata: Contains every key and value pair; useful for debugging.
toString() - Method in enum com.google.enterprise.adaptor.MetadataTransform.TransmissionDecision
toString() - Method in class com.google.enterprise.adaptor.prebuilt.FilterMimetypes
toString() - Method in class com.google.enterprise.adaptor.prebuilt.SkipDocumentFilter
toString() - Method in class com.google.enterprise.adaptor.Principal
transform(Metadata, Map<String, String>) - Method in interface com.google.enterprise.adaptor.DocumentTransform: Deprecated.
transform(Metadata, Map<String, String>) - Method in class com.google.enterprise.adaptor.examples.AddContentTypeToMetadata
transform(Metadata, Map<String, String>) - Method in class com.google.enterprise.adaptor.examples.DateSplitTransform: Here we check to see if the current doc contains a "dateField" key and if so, add the additional values
transform(Metadata, Map<String, String>) - Method in class com.google.enterprise.adaptor.examples.MetadataTransformExample
transform(Metadata, Map<String, String>) - Method in class com.google.enterprise.adaptor.MetadataTransform.HistoricalWrapper
transform(Metadata, Map<String, String>) - Method in interface com.google.enterprise.adaptor.MetadataTransform: Any changes to metadata and params will be passed on to subsequent transforms.
transform(Metadata, Map<String, String>) - Method in class com.google.enterprise.adaptor.prebuilt.CommandLineTransform
transform(Metadata, Map<String, String>) - Method in class com.google.enterprise.adaptor.prebuilt.FilterMimetypes
transform(Metadata, Map<String, String>) - Method in class com.google.enterprise.adaptor.prebuilt.SkipDocumentFilter: Adds a single Map.Entry to the params Map: key Transmission-Decision, value TransmissionDecision.AS_IS to indicate that the document is to be retained, or value TransmissionDecision.DO_NOT_INDEX to indicate that the document is to be skipped.

U

unmodifiableView() - Method in class com.google.enterprise.adaptor.Metadata: Get a reference to an unmodifiable view of this object.
UnsupportedPlatformException - Exception in com.google.enterprise.adaptor: Thrown if the adaptor cannot be run on this OS environment.
UnsupportedPlatformException() - Constructor for exception com.google.enterprise.adaptor.UnsupportedPlatformException: Constructs a new UnsupportedPlatformException with no message.
UnsupportedPlatformException(String) - Constructor for exception com.google.enterprise.adaptor.UnsupportedPlatformException: Constructs a UnsupportedPlatformException with a supplied message.
UnsupportedPlatformException(String, Throwable) - Constructor for exception com.google.enterprise.adaptor.UnsupportedPlatformException: Constructs a UnsupportedPlatformException with a supplied message and cause.
UnsupportedPlatformException(Throwable) - Constructor for exception com.google.enterprise.adaptor.UnsupportedPlatformException: Constructs a UnsupportedPlatformException with specified cause, copying its message if cause is non-null.
userAuthenticated(HttpExchange, AuthnIdentity) - Method in interface com.google.enterprise.adaptor.AuthnAuthority.Callback: Respond with authentication information discovered during AuthnAdaptor.authenticateUser(HttpExchange, Callback).
UserPrincipal - Class in com.google.enterprise.adaptor: Represents user.
UserPrincipal(String, String) - Constructor for class com.google.enterprise.adaptor.UserPrincipal
UserPrincipal(String) - Constructor for class com.google.enterprise.adaptor.UserPrincipal

V

validate() - Method in class com.google.enterprise.adaptor.Config
valueOf(String) - Static method in enum com.google.enterprise.adaptor.Acl.InheritanceType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.google.enterprise.adaptor.AuthzStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.google.enterprise.adaptor.MetadataTransform.TransmissionDecision: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.google.enterprise.adaptor.Status.Code: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.google.enterprise.adaptor.Acl.InheritanceType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.google.enterprise.adaptor.AuthzStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.google.enterprise.adaptor.MetadataTransform.TransmissionDecision: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.google.enterprise.adaptor.Status.Code: Returns an array containing the constants of this enum type, in the order they are declared.

W

WrappedIOException(IOException) - Constructor for exception com.google.enterprise.adaptor.prebuilt.RecursiveFileIterator.WrappedIOException
write(int) - Method in class com.google.enterprise.adaptor.ContentTransform
write(byte[]) - Method in class com.google.enterprise.adaptor.ContentTransform
write(byte[], int, int) - Method in class com.google.enterprise.adaptor.ContentTransform
writeToTempFile(InputStream) - Static method in class com.google.enterprise.adaptor.IOHelper: Write contents of in to a temporary file.
writeToTempFile(String, Charset) - Static method in class com.google.enterprise.adaptor.IOHelper: Write contents of string to a temporary file, encoded using charset.

A B C D E F G H I K L M N O P R S T U V W