com.google.enterprise.adaptor

Class DocRequest

java.lang.Object

com.google.enterprise.adaptor.DocRequest

All Implemented Interfaces:

Request

public class DocRequest
extends Object
implements Request

A complete implementation of Request.

See Also:

UnsupportedRequest

Constructor Summary

Constructors

Constructor and Description
DocRequest(DocId docId) Constructs a request with a null access time that supports HTTP 204 responses.
DocRequest(DocId docId, Date lastAccessTime) Constructs a request that supports HTTP 204 responses.
DocRequest(DocId docId, Date lastAccessTime, boolean isNoContentSupported) Constructs a request.

Method Summary

Modifier and Type	Method and Description
boolean	canRespondWithNoContent(Date lastModified) 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.
DocId	getDocId() Provides the document ID for the document that is being requested.
Date	getLastAccessTime() Returns the last time a GSA or other client retrieved the data, or null if none was provided by the client.
boolean	hasChangedSinceLastAccess(Date lastModified) Returns true if the GSA or other client's current copy of the document was retrieved after the lastModified date; false otherwise.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocRequest

public DocRequest(DocId docId)

Constructs a request with a null access time that supports HTTP 204 responses. A null access time implies that the document has never been crawled.

Parameters:

docId - the requested document ID

Throws:

NullPointerException - if docId is null

DocRequest

public DocRequest(DocId docId,
                  Date lastAccessTime)

Constructs a request that supports HTTP 204 responses.

Parameters:

docId - the requested document ID

lastAccessTime - the last time the document was crawled

Throws:

NullPointerException - if docId is null

DocRequest

public DocRequest(DocId docId,
                  Date lastAccessTime,
                  boolean isNoContentSupported)

Constructs a request.

Parameters:

docId - the requested document ID

lastAccessTime - the last time the document was crawled; null implies that the document has never been crawled

isNoContentSupported - true if an HTTP 204 response is allowed, and false otherwise

Throws:

NullPointerException - if docId is null

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getDocId

public DocId getDocId()

Description copied from interface: Request

Provides the document ID for the document that is being requested. DocId was not necessarily provided previously by the Adaptor; it is client-provided and must not be trusted. If the document does not exist, then Adaptor.getDocContent(com.google.enterprise.adaptor.Request, com.google.enterprise.adaptor.Response) must call Response.respondNotFound().

Specified by:

getDocId in interface Request

Returns:

id being requested

getLastAccessTime

public Date getLastAccessTime()

Description copied from interface: Request

Returns the last time a GSA or other client retrieved the data, or null if none was provided by the client. The returned Date is in GMT.

This is useful for determining if the client needs to be re-sent the data since what they have cached may be the most recent version. If the client is up-to-date, then call Response.respondNotModified().

Specified by:

getLastAccessTime in interface Request

Returns:

date in GMT client last accessed the DocId or null

hasChangedSinceLastAccess

public boolean hasChangedSinceLastAccess(Date lastModified)

Description copied from interface: Request

Returns true if the GSA or other client's current copy of the document was retrieved after the lastModified date; false otherwise. lastModified must be in GMT.

If false, the client does not need to be re-sent the data, since what they have cached is the most recent version. In this case, you should then call Response.respondNotModified().

Specified by:

hasChangedSinceLastAccess in interface Request

Parameters:

lastModified - is actual time document was last modified

Returns:

whether updated content should be sent

canRespondWithNoContent

public boolean canRespondWithNoContent(Date lastModified)

Description copied from interface: 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. lastModified must be in GMT.

If true, the client does not need to be re-sent the file content , since what they have cached is the most recent version. In this case, you should then call Response.respondNoContent().

Specified by:

canRespondWithNoContent in interface Request

Parameters:

lastModified - is actual time document was last modified

Returns:

true if the docuemnt has not changed and we are either talking to GSA version 7.4 or higher, or a web browser, and false otherwise