| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Response</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Response"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/google/enterprise/adaptor/Request.html" title="interface in com.google.enterprise.adaptor"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../../com/google/enterprise/adaptor/SensitiveValueDecoder.html" title="interface in com.google.enterprise.adaptor"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/google/enterprise/adaptor/Response.html" target="_top">FRAMES</a></li> |
| <li><a href="Response.html" target="_top">NO FRAMES</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>SUMMARY: </li> |
| <li>NESTED | </li> |
| <li>FIELD | </li> |
| <li>CONSTR | </li> |
| <li><a href="#method_summary">METHOD</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>DETAIL: </li> |
| <li>FIELD | </li> |
| <li>CONSTR | </li> |
| <li><a href="#method_detail">METHOD</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <p class="subTitle">com.google.enterprise.adaptor</p> |
| <h2 title="Interface Response" class="title">Interface Response</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <strong>Response</strong></pre> |
| <div class="block">Interface provided to <a href="../../../../com/google/enterprise/adaptor/Adaptor.html#getDocContent(com.google.enterprise.adaptor.Request, com.google.enterprise.adaptor.Response)"><code>Adaptor.getDocContent(Request, Response)</code></a> for performing the actions needed |
| to satisfy a request. |
| |
| <p>There are several ways that a request can be processed. In the simplest |
| case an Adaptor always sets different pieces of metadata, calls <a href="../../../../com/google/enterprise/adaptor/Response.html#getOutputStream()"><code>getOutputStream()</code></a>, and writes the document contents. If the document does not |
| exist, it should call <a href="../../../../com/google/enterprise/adaptor/Response.html#respondNotFound()"><code>respondNotFound()</code></a> instead. |
| |
| <p>For improved efficiency during recrawl by the GSA, an Adaptor should check |
| <a href="../../../../com/google/enterprise/adaptor/Request.html#hasChangedSinceLastAccess(java.util.Date)"><code>Request.hasChangedSinceLastAccess(java.util.Date)</code></a> and call <a href="../../../../com/google/enterprise/adaptor/Response.html#respondNotModified()"><code>respondNotModified()</code></a> when it is <code>true</code>. This prevents the Adaptor from |
| ever needing to retrieve the document contents and metadata.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#addAnchor(java.net.URI, java.lang.String)">addAnchor</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text)</code> |
| <div class="block">Add a hyperlink for the GSA to follow without modifying the document |
| contents.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#addMetadata(java.lang.String, java.lang.String)">addMetadata</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> |
| <div class="block">Add metadata element that applies to the document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#getOutputStream()">getOutputStream</a></strong>()</code> |
| <div class="block">Get stream to write document contents to.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#respondNotFound()">respondNotFound</a></strong>()</code> |
| <div class="block">Respond to the GSA or other client that the request document does not |
| exist.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#respondNotModified()">respondNotModified</a></strong>()</code> |
| <div class="block">Respond to the GSA or other client that it already has the latest version |
| of a file and its metadata.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setAcl(com.google.enterprise.adaptor.Acl)">setAcl</a></strong>(<a href="../../../../com/google/enterprise/adaptor/Acl.html" title="class in com.google.enterprise.adaptor">Acl</a> acl)</code> |
| <div class="block">Provide the document's ACLs for early-binding security on the GSA.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setContentType(java.lang.String)">setContentType</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contentType)</code> |
| <div class="block">Describe the content type of the document.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setCrawlOnce(boolean)">setCrawlOnce</a></strong>(boolean crawlOnce)</code> |
| <div class="block">Instruct the GSA to not recrawl the document after the initial |
| retrieval.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setDisplayUrl(java.net.URI)">setDisplayUrl</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> displayUrl)</code> |
| <div class="block">Set the URI to be displayed in search results.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setLastModified(java.util.Date)">setLastModified</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> lastModified)</code> |
| <div class="block">Provide the last modification time of the document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setLock(boolean)">setLock</a></strong>(boolean lock)</code> |
| <div class="block">Instruct the GSA to "lock" the document into its index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setNoArchive(boolean)">setNoArchive</a></strong>(boolean noArchive)</code> |
| <div class="block">Whether the GSA should show the "Cached" link in search results for this |
| document.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setNoFollow(boolean)">setNoFollow</a></strong>(boolean noFollow)</code> |
| <div class="block">Whether the GSA should follow the links within the document to find other |
| documents.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setNoIndex(boolean)">setNoIndex</a></strong>(boolean noIndex)</code> |
| <div class="block">Whether the GSA should index the content for searching.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../com/google/enterprise/adaptor/Response.html#setSecure(boolean)">setSecure</a></strong>(boolean secure)</code> |
| <div class="block">Mark the document as secure, for use with late-binding security.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="respondNotModified()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>respondNotModified</h4> |
| <pre>void respondNotModified() |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">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. |
| |
| <p>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.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="respondNotFound()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>respondNotFound</h4> |
| <pre>void respondNotFound() |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">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. |
| |
| <p>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.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getOutputStream()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputStream</h4> |
| <pre><a href="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> getOutputStream() |
| throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Get stream to write document contents to. There is no need to flush or |
| close the <code>OutputStream</code> when done. |
| |
| <p>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.</div> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="setContentType(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setContentType</h4> |
| <pre>void setContentType(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> contentType)</pre> |
| <div class="block">Describe the content type of the document.</div> |
| </li> |
| </ul> |
| <a name="setLastModified(java.util.Date)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLastModified</h4> |
| <pre>void setLastModified(<a href="http://download.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> lastModified)</pre> |
| <div class="block">Provide the last modification time of the document.</div> |
| </li> |
| </ul> |
| <a name="addMetadata(java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addMetadata</h4> |
| <pre>void addMetadata(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre> |
| <div class="block">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.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of metadata element</dd><dd><code>value</code> - the value of metadata element</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>key</code> or <code>value</code> |
| is <code>null</code></dd></dl> |
| </li> |
| </ul> |
| <a name="setAcl(com.google.enterprise.adaptor.Acl)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAcl</h4> |
| <pre>void setAcl(<a href="../../../../com/google/enterprise/adaptor/Acl.html" title="class in com.google.enterprise.adaptor">Acl</a> acl)</pre> |
| <div class="block">Provide the document's ACLs for early-binding security on the GSA. By |
| default, the document's ACL will be <code>null</code>, which means the document |
| is public if the document isn't marked as secure via <a href="../../../../com/google/enterprise/adaptor/Response.html#setSecure(boolean)"><code>setSecure(boolean)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setSecure(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSecure</h4> |
| <pre>void setSecure(boolean secure)</pre> |
| <div class="block">Mark the document as secure, for use with late-binding security. By |
| default, the secure setting will be <code>false</code>, which means the document |
| is public if there are no ACLs. ACLs should be used, if possible, instead |
| of setting this option to <code>true</code>. When <code>true</code>, 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.</div> |
| </li> |
| </ul> |
| <a name="addAnchor(java.net.URI, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addAnchor</h4> |
| <pre>void addAnchor(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> text)</pre> |
| <div class="block">Add a hyperlink for the GSA to follow without modifying the document |
| contents. This is equivalent to the following HTML: <code><a href='$uri'>$text</a></code>. If you want to link to a <a href="../../../../com/google/enterprise/adaptor/DocId.html" title="class in com.google.enterprise.adaptor"><code>DocId</code></a>, then you |
| may use the <a href="../../../../com/google/enterprise/adaptor/DocIdEncoder.html" title="interface in com.google.enterprise.adaptor"><code>DocIdEncoder</code></a> provided by <a href="../../../../com/google/enterprise/adaptor/AdaptorContext.html#getDocIdEncoder()"><code>AdaptorContext.getDocIdEncoder()</code></a> to produce an appropriate URI.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>uri</code> - the URI of the anchor</dd><dd><code>text</code> - the text of the anchor, or <code>null</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>uri</code> is <code>null</code></dd></dl> |
| </li> |
| </ul> |
| <a name="setNoIndex(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNoIndex</h4> |
| <pre>void setNoIndex(boolean noIndex)</pre> |
| <div class="block">Whether the GSA should index the content for searching. When <code>true</code>, |
| 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 <code>false</code>).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>noIndex</code> - <code>true</code> when the GSA shouldn't index this document</dd></dl> |
| </li> |
| </ul> |
| <a name="setNoFollow(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNoFollow</h4> |
| <pre>void setNoFollow(boolean noFollow)</pre> |
| <div class="block">Whether the GSA should follow the links within the document to find other |
| documents. By default, the GSA will follow links (a value of <code>false</code>).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>noFollow</code> - <code>true</code> when the GSA shouldn't follow links from this |
| document to find other documents</dd></dl> |
| </li> |
| </ul> |
| <a name="setNoArchive(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNoArchive</h4> |
| <pre>void setNoArchive(boolean noArchive)</pre> |
| <div class="block">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 |
| <code>false</code>).</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>noArchive</code> - <code>true</code> when the GSA shouldn't show the "Cached" |
| link in search results</dd></dl> |
| </li> |
| </ul> |
| <a name="setDisplayUrl(java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDisplayUrl</h4> |
| <pre>void setDisplayUrl(<a href="http://download.oracle.com/javase/6/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> displayUrl)</pre> |
| <div class="block">Set the URI to be displayed in search results. If <code>null</code>, then the |
| crawl URI representing the <code>DocId</code> is used. The default is <code>null</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>displayUrl</code> - URI to be used for this document in search results</dd></dl> |
| </li> |
| </ul> |
| <a name="setCrawlOnce(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCrawlOnce</h4> |
| <pre>void setCrawlOnce(boolean crawlOnce)</pre> |
| <div class="block">Instruct the GSA to not recrawl the document after the initial |
| retrieval. The default is <code>false</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>crawlOnce</code> - if <code>true</code>, the document does not need to be |
| recrawled periodically</dd></dl> |
| </li> |
| </ul> |
| <a name="setLock(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setLock</h4> |
| <pre>void setLock(boolean lock)</pre> |
| <div class="block">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 <code>false</code>.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lock</code> - if <code>true</code>, keep this document in the index in preference |
| to unlocked documents</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/google/enterprise/adaptor/Request.html" title="interface in com.google.enterprise.adaptor"><span class="strong">PREV CLASS</span></a></li> |
| <li><a href="../../../../com/google/enterprise/adaptor/SensitiveValueDecoder.html" title="interface in com.google.enterprise.adaptor"><span class="strong">NEXT CLASS</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/google/enterprise/adaptor/Response.html" target="_top">FRAMES</a></li> |
| <li><a href="Response.html" target="_top">NO FRAMES</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>SUMMARY: </li> |
| <li>NESTED | </li> |
| <li>FIELD | </li> |
| <li>CONSTR | </li> |
| <li><a href="#method_summary">METHOD</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>DETAIL: </li> |
| <li>FIELD | </li> |
| <li>CONSTR | </li> |
| <li><a href="#method_detail">METHOD</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
