com.google.enterprise.adaptor.testing

Class UnsupportedRequest

java.lang.Object

com.google.enterprise.adaptor.testing.UnsupportedRequest

All Implemented Interfaces:

Request

public class UnsupportedRequest
extends Object
implements Request

An implementation of Request that throws an UnsupportedOperationException if any method is called.

This class is intended to be extended for unit testing, rather than implementing the Request interface directly.

See Also:

DocRequest

Constructor Summary

Constructors

Constructor and Description
UnsupportedRequest()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnsupportedRequest

public UnsupportedRequest()

Method Detail

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

Throws:

UnsupportedOperationException - always

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:

whether sending headers (metadata, ACLs, etc) is enough

Throws:

UnsupportedOperationException - always

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

Throws:

UnsupportedOperationException - always

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

Throws:

UnsupportedOperationException - always