RecordingResponse

java.lang.Object
- com.google.enterprise.adaptor.testing.RecordingResponse

All Implemented Interfaces:

Response
```
public class RecordingResponse
extends Object
implements Response
```
A fake implementation of Response that simply records the values it receives, and implements the interface semantics of the methods that must be called last. This implementation is not thread-safe.
Methods that return collections all return unmodifiable views of the recorded values. The collections cannot be changed directly, but they will reflect changes to the recorded values that are made through the Response interface.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RecordingResponse.AnchorMap` An unmodifiable view of the accumulated anchors as a multimap that supports duplicate, ordered key-value pairs.
`static class`	`RecordingResponse.State` Response states based on calls to the `respondXXX` and `getOutputStream` methods.

Constructor Summary

Constructors
Constructor and Description
`RecordingResponse()` Constructs a mock `Response` with a `ByteArrayOutputStream`.
`RecordingResponse(OutputStream os)` Constructs a mock `Response` with the given `OutputStream`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnchor(URI uri, String text)` Add a hyperlink for the GSA to follow without modifying the document contents.
`void`	`addMetadata(String key, String value)` Add metadata element that applies to the document.
`Acl`	`getAcl()`
`RecordingResponse.AnchorMap`	`getAnchors()` Gets an unmodifiable view of the accumulated anchors as a multimap.
`String`	`getContentType()`
`URI`	`getDisplayUrl()`
`MetadataTransform.TransmissionDecision`	`getForcedTransmissionDecision()`
`Date`	`getLastModified()`
`Metadata`	`getMetadata()` Gets an unmodifiable view of the accumulated `Metadata`.
`Map<String,Acl>`	`getNamedResources()` Gets an unmodifiable view of the named resources as a `Map` from URI fragments to ACLs.
`OutputStream`	`getOutputStream()` Get stream to write document contents to.
`Map<String,String>`	`getParams()` Gets an unmodifiable view of the accumulated params as a `Map`.
`RecordingResponse.State`	`getState()`
`boolean`	`isCrawlOnce()`
`boolean`	`isLock()`
`boolean`	`isNoArchive()`
`boolean`	`isNoFollow()`
`boolean`	`isNoIndex()`
`boolean`	`isSecure()`
`void`	`putNamedResource(String fragment, Acl acl)` Provide alternative ACLs for this document, uniquely identified by response document's `DocId` and `fragment`.
`void`	`respondNoContent()` 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.
`void`	`respondNotFound()` Respond to the GSA or other client that the request document does not exist.
`void`	`respondNotModified()` Respond to the GSA or other client that it already has the latest version of a file and its metadata.
`void`	`setAcl(Acl acl)` Provide the document's ACLs for early-binding security on the GSA.
`void`	`setContentType(String contentType)` Describe the content type of the document.
`void`	`setCrawlOnce(boolean crawlOnce)` Instruct the GSA to not recrawl the document after the initial retrieval.
`void`	`setDisplayUrl(URI displayUrl)` Set the URI to be displayed in search results.
`void`	`setForcedTransmissionDecision(MetadataTransform.TransmissionDecision decision)` Set a forced `MetadataTransform.TransmissionDecision` that can override transmission decisions made by `MetadataTransforms`.
`void`	`setLastModified(Date lastModified)` Provide the last modification time of the document.
`void`	`setLock(boolean lock)` Instruct the GSA to "lock" the document into its index.
`void`	`setNoArchive(boolean noArchive)` Whether the GSA should show the "Cached" link in search results for this document.
`void`	`setNoFollow(boolean noFollow)` Whether the GSA should follow the links within the document to find other documents.
`void`	`setNoIndex(boolean noIndex)` Whether the GSA should index the content for searching.
`void`	`setParam(String key, String value)` Adds a parameter to a Map for use by `MetadataTransforms` when making transforms or decisions.
`void`	`setSecure(boolean secure)` Mark the document as secure, for use with late-binding security.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RecordingResponse
```
public RecordingResponse()
```
    Constructs a mock Response with a ByteArrayOutputStream.
  - RecordingResponse
```
public RecordingResponse(OutputStream os)
```
    Constructs a mock Response with the given OutputStream.
    
    Parameters:
    
    os - the output stream that will be returned from getOutputStream()
- Method Detail
  - respondNotModified
```
public void respondNotModified()
                        throws IOException
```
    Description copied from interface: Response
    
    Respond to the GSA or other client that it already has the latest version of a file and its metadata. If you have called other methods on this object to provide various metadata, the effects of those methods will be ignored.
    If called, this must be the last call to this interface. Once you call this method, for the rest of the processing, exceptions may no longer be communicated to clients cleanly.
    
    Specified by:
    
    respondNotModified in interface Response
    
    Throws:
    
    IOException - if communicating with client fails
  - respondNotFound
```
public void respondNotFound()
                     throws IOException
```
    Description copied from interface: Response
    
    Respond to the GSA or other client that the request document does not exist. If you have called other methods on this object, the effects of those methods will be ignored.
    If called, this must be the last call to this interface. Once you call this method, for the rest of the processing, exceptions may no longer be communicated to the clients cleanly.
    
    Specified by:
    
    respondNotFound in interface Response
    
    Throws:
    
    IOException - if communicating with client fails
  - respondNoContent
```
public void respondNoContent()
                      throws IOException
```
    Description copied from interface: 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.
    If called, this must be the last call to this interface. Once you call this method, for the rest of the processing, exceptions may no longer be communicated to the clients cleanly.
    
    Specified by:
    
    respondNoContent in interface Response
    
    Throws:
    
    IOException - if communicating with client fails
  - getOutputStream
```
public OutputStream getOutputStream()
```
    Description copied from interface: Response
    
    Get stream to write document contents to. There is no need to flush or close the OutputStream when done.
    If called, this must be the last call to this interface (although, for convenience, you may call this method multiple times). Once you call this method, for the rest of the processing, exceptions may no longer be communicated to clients cleanly.
    
    Specified by:
    
    getOutputStream in interface Response
    
    Returns:
    
    OutputStream for client to write content onto
  - setContentType
```
public void setContentType(String contentType)
```
    Description copied from interface: Response
    
    Describe the content type of the document.
    
    Specified by:
    
    setContentType in interface Response
    
    Parameters:
    
    contentType - to set in response headers
  - setLastModified
```
public void setLastModified(Date lastModified)
```
    Description copied from interface: Response
    
    Provide the last modification time of the document.
    
    Specified by:
    
    setLastModified in interface Response
    
    Parameters:
    
    lastModified - to send in response headers
  - addMetadata
```
public void addMetadata(String key,
                        String value)
```
    Description copied from interface: Response
    
    Add metadata element that applies to the document. Providing multiple values for the same key is supported; simply repeat the call once for each value.
    
    Specified by:
    
    addMetadata in interface Response
    
    Parameters:
    
    key - the key of metadata element
    
    value - the value of metadata element
  - setAcl
```
public void setAcl(Acl acl)
```
    Description copied from interface: Response
    
    Provide the document's ACLs for early-binding security on the GSA. By default, the document's ACL will be null, which means the document is public if the document isn't marked as secure via Response.setSecure(boolean).
    
    Specified by:
    
    setAcl in interface Response
    
    Parameters:
    
    acl - access controls for document being sent
  - putNamedResource
```
public void putNamedResource(String fragment,
                             Acl acl)
```
    Description copied from interface: Response
    
    Provide alternative ACLs for this document, uniquely identified by response document's DocId and fragment.
    
    Specified by:
    
    putNamedResource in interface Response
    
    Parameters:
    
    fragment - disambiguating name when document has multiple ACLs
    
    acl - access controls for document being sent
  - setSecure
```
public void setSecure(boolean secure)
```
    Description copied from interface: Response
    
    Mark the document as secure, for use with late-binding security. By default, the secure setting will be false, which means the document is public if there are no ACLs. ACLs should be used, if possible, instead of setting this option to true. When true, the GSA needs to be correctly configured to issue a SAML request to the Adaptor. Setting ACLs to non-null will override setSecure and send secure indicator to GSA.
    
    Specified by:
    
    setSecure in interface Response
    
    Parameters:
    
    secure - controls whether access is controlled or public
  - addAnchor
```
public void addAnchor(URI uri,
                      String text)
```
    Description copied from interface: Response
    
    Add a hyperlink for the GSA to follow without modifying the document contents. This is equivalent to the following HTML: <a href='$uri'>$text</a>. If you want to link to a DocId, then you may use the DocIdEncoder provided by AdaptorContext.getDocIdEncoder() to produce an appropriate URI.
    
    Specified by:
    
    addAnchor in interface Response
    
    Parameters:
    
    uri - the URI of the anchor
    
    text - the text of the anchor, or null
  - setNoIndex
```
public void setNoIndex(boolean noIndex)
```
    Description copied from interface: Response
    
    Whether the GSA should index the content for searching. When true, the document will not be visible in search results. This does not change the GSA's behavior of following links within the document to find other documents. By default, the GSA will index the document (a value of false).
    
    Specified by:
    
    setNoIndex in interface Response
    
    Parameters:
    
    noIndex - true when the GSA shouldn't index this document
  - setNoFollow
```
public void setNoFollow(boolean noFollow)
```
    Description copied from interface: Response
    
    Whether the GSA should follow the links within the document to find other documents. By default, the GSA will follow links (a value of false).
    
    Specified by:
    
    setNoFollow in interface Response
    
    Parameters:
    
    noFollow - true when the GSA shouldn't follow links from this document to find other documents
  - setNoArchive
```
public void setNoArchive(boolean noArchive)
```
    Description copied from interface: Response
    
    Whether the GSA should show the "Cached" link in search results for this document. By default, the GSA will show the "Cached" link (a value of false).
    
    Specified by:
    
    setNoArchive in interface Response
    
    Parameters:
    
    noArchive - true when the GSA shouldn't show the "Cached" link in search results
  - setDisplayUrl
```
public void setDisplayUrl(URI displayUrl)
```
    Description copied from interface: Response
    
    Set the URI to be displayed in search results. If null, then the crawl URI representing the DocId is used. The default is null.
    
    Specified by:
    
    setDisplayUrl in interface Response
    
    Parameters:
    
    displayUrl - URI to be used for this document in search results
  - setCrawlOnce
```
public void setCrawlOnce(boolean crawlOnce)
```
    Description copied from interface: Response
    
    Instruct the GSA to not recrawl the document after the initial retrieval. The default is false.
    
    Specified by:
    
    setCrawlOnce in interface Response
    
    Parameters:
    
    crawlOnce - if true, the document does not need to be recrawled periodically
  - setLock
```
public void setLock(boolean lock)
```
    Description copied from interface: Response
    
    Instruct the GSA to "lock" the document into its index. When the license limit is reached on the GSA, it deletes unlocked documents before locked documents while making room for new documents. The default is false.
    
    Specified by:
    
    setLock in interface Response
    
    Parameters:
    
    lock - if true, keep this document in the index in preference to unlocked documents
  - setForcedTransmissionDecision
```
public void setForcedTransmissionDecision(MetadataTransform.TransmissionDecision decision)
```
    Description copied from interface: Response
    
    Set a forced MetadataTransform.TransmissionDecision that can override transmission decisions made by MetadataTransforms.
    Some connectors send content that must be preserved in order for the connector to function properly, and transforms that decide to drop that content essentially break the connector. For instance, dropping folders disrupts graph traverser type connectors.
    
    Specified by:
    
    setForcedTransmissionDecision in interface Response
    
    Parameters:
    
    decision - a TransmissionDecision
  - setParam
```
public void setParam(String key,
                     String value)
```
    Description copied from interface: Response
    Adds a parameter to a Map for use by MetadataTransforms when making transforms or decisions. Params are data associated with the document, but might not be indexed and searchable. Before the metadata transforms are called, the params are seeded with the document's DocId, and values from setLock, setCrawlOnce, setDisplayUrl, setContentType, and setLastModified.
    To avoid possible name conflicts with parameter entries supplied by the library, the key of a connector-supplied parameter must start with X-.
    Example:
```
 response.setParam("X-LastAccessDate", ISO8601.format(lastAccessDate));
 
```
    Specified by:
    
    setParam in interface Response
    
    Parameters:
    
    key - a key for a Map entry
    
    value - the value for the Map entry for key
  - getState
```
public RecordingResponse.State getState()
```
  - getContentType
```
public String getContentType()
```
  - getLastModified
```
public Date getLastModified()
```
  - getMetadata
```
public Metadata getMetadata()
```
    Gets an unmodifiable view of the accumulated Metadata.
    
    Returns:
    
    an unmodifiable view of the accumulated Metadata
  - getAcl
```
public Acl getAcl()
```
  - getNamedResources
```
public Map<String,Acl> getNamedResources()
```
    Gets an unmodifiable view of the named resources as a Map from URI fragments to ACLs.
    
    Returns:
    
    an unmodifiable view of the named resources
  - isSecure
```
public boolean isSecure()
```
  - getAnchors
```
public RecordingResponse.AnchorMap getAnchors()
```
    Gets an unmodifiable view of the accumulated anchors as a multimap.
    
    Returns:
    
    a unmodifiable view of the accumulated anchors
  - isNoIndex
```
public boolean isNoIndex()
```
  - isNoFollow
```
public boolean isNoFollow()
```
  - isNoArchive
```
public boolean isNoArchive()
```
  - getDisplayUrl
```
public URI getDisplayUrl()
```
  - isCrawlOnce
```
public boolean isCrawlOnce()
```
  - isLock
```
public boolean isLock()
```
  - getForcedTransmissionDecision
```
public MetadataTransform.TransmissionDecision getForcedTransmissionDecision()
```
  - getParams
```
public Map<String,String> getParams()
```
    Gets an unmodifiable view of the accumulated params as a Map.
    
    Returns:
    
    an unmodifiable view of the accumulated params

Class RecordingResponse

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecordingResponse

RecordingResponse

Method Detail

respondNotModified

respondNotFound

respondNoContent

getOutputStream

setContentType

setLastModified

addMetadata

setAcl

putNamedResource

setSecure

addAnchor

setNoIndex

setNoFollow

setNoArchive

setDisplayUrl

setCrawlOnce

setLock

setForcedTransmissionDecision

setParam

getState

getContentType

getLastModified

getMetadata

getAcl

getNamedResources

isSecure

getAnchors

isNoIndex

isNoFollow

isNoArchive

getDisplayUrl

isCrawlOnce

isLock

getForcedTransmissionDecision

getParams