blob: 6936331677ee45acdea808eb65b5c8bafdfa8b11 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>FsAdaptor</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="FsAdaptor";
}
//-->
</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="../../../../../com/google/enterprise/adaptor/fs/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/fs/AclFileAttributeViews.html" title="class in com.google.enterprise.adaptor.fs"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/enterprise/adaptor/fs/FsAdaptor.html" target="_top">Frames</a></li>
<li><a href="FsAdaptor.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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">
<div class="subTitle">com.google.enterprise.adaptor.fs</div>
<h2 title="Class FsAdaptor" class="title">Class FsAdaptor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.google.enterprise.adaptor.AbstractAdaptor</li>
<li>
<ul class="inheritance">
<li>com.google.enterprise.adaptor.fs.FsAdaptor</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.google.enterprise.adaptor.Adaptor, com.google.enterprise.adaptor.PollingIncrementalLister</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">FsAdaptor</span>
extends com.google.enterprise.adaptor.AbstractAdaptor
implements com.google.enterprise.adaptor.PollingIncrementalLister</pre>
<div class="block">Runs on Microsoft Windows and serves files from networked shares.
<p>
Features:<br>
<ul>
<li>Supports UNC path to single matchine's share
<li>Supports UNC path to standalone DFS
<li>Supports UNC path to domain DFS
<li>Uses hierarchical ACL model
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../com/google/enterprise/adaptor/fs/FsAdaptor.html#FsAdaptor()">FsAdaptor</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</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/fs/FsAdaptor.html#destroy()">destroy</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/google/enterprise/adaptor/fs/FsAdaptor.html#getDocContent(com.google.enterprise.adaptor.Request, com.google.enterprise.adaptor.Response)">getDocContent</a></strong>(com.google.enterprise.adaptor.Request&nbsp;req,
com.google.enterprise.adaptor.Response&nbsp;resp)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/google/enterprise/adaptor/fs/FsAdaptor.html#getDocIds(com.google.enterprise.adaptor.DocIdPusher)">getDocIds</a></strong>(com.google.enterprise.adaptor.DocIdPusher&nbsp;pusher)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/google/enterprise/adaptor/fs/FsAdaptor.html#getModifiedDocIds(com.google.enterprise.adaptor.DocIdPusher)">getModifiedDocIds</a></strong>(com.google.enterprise.adaptor.DocIdPusher&nbsp;pusher)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/google/enterprise/adaptor/fs/FsAdaptor.html#init(com.google.enterprise.adaptor.AdaptorContext)">init</a></strong>(com.google.enterprise.adaptor.AdaptorContext&nbsp;context)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/google/enterprise/adaptor/fs/FsAdaptor.html#initConfig(com.google.enterprise.adaptor.Config)">initConfig</a></strong>(com.google.enterprise.adaptor.Config&nbsp;config)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../com/google/enterprise/adaptor/fs/FsAdaptor.html#main(java.lang.String[])">main</a></strong>(java.lang.String[]&nbsp;args)</code>
<div class="block">Call default main for adaptors.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_com.google.enterprise.adaptor.AbstractAdaptor">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.google.enterprise.adaptor.AbstractAdaptor</h3>
<code>main</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="FsAdaptor()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FsAdaptor</h4>
<pre>public&nbsp;FsAdaptor()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="initConfig(com.google.enterprise.adaptor.Config)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initConfig</h4>
<pre>public&nbsp;void&nbsp;initConfig(com.google.enterprise.adaptor.Config&nbsp;config)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>initConfig</code>&nbsp;in interface&nbsp;<code>com.google.enterprise.adaptor.Adaptor</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>initConfig</code>&nbsp;in class&nbsp;<code>com.google.enterprise.adaptor.AbstractAdaptor</code></dd>
</dl>
</li>
</ul>
<a name="init(com.google.enterprise.adaptor.AdaptorContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init(com.google.enterprise.adaptor.AdaptorContext&nbsp;context)
throws java.lang.Exception</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>init</code>&nbsp;in interface&nbsp;<code>com.google.enterprise.adaptor.Adaptor</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>init</code>&nbsp;in class&nbsp;<code>com.google.enterprise.adaptor.AbstractAdaptor</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd></dl>
</li>
</ul>
<a name="destroy()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroy</h4>
<pre>public&nbsp;void&nbsp;destroy()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>destroy</code>&nbsp;in interface&nbsp;<code>com.google.enterprise.adaptor.Adaptor</code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code>destroy</code>&nbsp;in class&nbsp;<code>com.google.enterprise.adaptor.AbstractAdaptor</code></dd>
</dl>
</li>
</ul>
<a name="getDocIds(com.google.enterprise.adaptor.DocIdPusher)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocIds</h4>
<pre>public&nbsp;void&nbsp;getDocIds(com.google.enterprise.adaptor.DocIdPusher&nbsp;pusher)
throws java.lang.InterruptedException,
java.io.IOException</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getDocIds</code>&nbsp;in interface&nbsp;<code>com.google.enterprise.adaptor.Adaptor</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getModifiedDocIds(com.google.enterprise.adaptor.DocIdPusher)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModifiedDocIds</h4>
<pre>public&nbsp;void&nbsp;getModifiedDocIds(com.google.enterprise.adaptor.DocIdPusher&nbsp;pusher)
throws java.lang.InterruptedException,
java.io.IOException</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getModifiedDocIds</code>&nbsp;in interface&nbsp;<code>com.google.enterprise.adaptor.PollingIncrementalLister</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code></dd>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getDocContent(com.google.enterprise.adaptor.Request, com.google.enterprise.adaptor.Response)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocContent</h4>
<pre>public&nbsp;void&nbsp;getDocContent(com.google.enterprise.adaptor.Request&nbsp;req,
com.google.enterprise.adaptor.Response&nbsp;resp)
throws java.io.IOException</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getDocContent</code>&nbsp;in interface&nbsp;<code>com.google.enterprise.adaptor.Adaptor</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="main(java.lang.String[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)</pre>
<div class="block">Call default main for adaptors.</div>
</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="../../../../../com/google/enterprise/adaptor/fs/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/fs/AclFileAttributeViews.html" title="class in com.google.enterprise.adaptor.fs"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/google/enterprise/adaptor/fs/FsAdaptor.html" target="_top">Frames</a></li>
<li><a href="FsAdaptor.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>