You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@manifoldcf.apache.org by kw...@apache.org on 2010/03/05 18:12:15 UTC
svn commit: r919506 - in /incubator/lcf/trunk/modules: ./
connectors/documentum/ connectors/filenet/
connectors/filenet/connector/org/apache/lcf/crawler/connectors/filenet/
connectors/filesystem/ connectors/gts/
connectors/gts/connector/org/apache/lcf/...
Author: kwright
Date: Fri Mar 5 17:12:14 2010
New Revision: 919506
URL: http://svn.apache.org/viewvc?rev=919506&view=rev
Log:
Add javadoc targets for all connectors, and fix up the javadoc in the source so there are no warnings.
Modified:
incubator/lcf/trunk/modules/build.xml
incubator/lcf/trunk/modules/connectors/documentum/build.xml
incubator/lcf/trunk/modules/connectors/filenet/build.xml
incubator/lcf/trunk/modules/connectors/filenet/connector/org/apache/lcf/crawler/connectors/filenet/FilenetConnector.java
incubator/lcf/trunk/modules/connectors/filesystem/build.xml
incubator/lcf/trunk/modules/connectors/gts/build.xml
incubator/lcf/trunk/modules/connectors/gts/connector/org/apache/lcf/agents/output/gts/GTSConnector.java
incubator/lcf/trunk/modules/connectors/jcifs/build.xml
incubator/lcf/trunk/modules/connectors/jcifs/connector/org/apache/lcf/crawler/connectors/sharedrive/SharedDriveConnector.java
incubator/lcf/trunk/modules/connectors/jdbc/build.xml
incubator/lcf/trunk/modules/connectors/jdbc/connector/org/apache/lcf/crawler/connectors/jdbc/JDBCConnector.java
incubator/lcf/trunk/modules/connectors/livelink/build.xml
incubator/lcf/trunk/modules/connectors/livelink/connector/org/apache/lcf/crawler/connectors/livelink/LivelinkConnector.java
incubator/lcf/trunk/modules/connectors/memex/build.xml
incubator/lcf/trunk/modules/connectors/memex/connector/org/apache/lcf/crawler/connectors/memex/MemexConnector.java
incubator/lcf/trunk/modules/connectors/meridio/build.xml
incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/CommonsHTTPSender.java
incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/MeridioConnector.java
incubator/lcf/trunk/modules/connectors/nulloutput/build.xml
incubator/lcf/trunk/modules/connectors/nulloutput/connector/org/apache/lcf/agents/output/nullconnector/NullConnector.java
incubator/lcf/trunk/modules/connectors/rss/build.xml
incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/RSSConnector.java
incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/ThrottledFetcher.java
incubator/lcf/trunk/modules/connectors/sharepoint/build.xml
incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/CommonsHTTPSender.java
incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SPSProxyHelper.java
incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SharePointRepository.java
incubator/lcf/trunk/modules/connectors/webcrawler/build.xml
incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/ThrottledFetcher.java
incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/WebcrawlerConnector.java
Modified: incubator/lcf/trunk/modules/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/build.xml (original)
+++ incubator/lcf/trunk/modules/build.xml Fri Mar 5 17:12:14 2010
@@ -275,6 +275,7 @@
<copy todir="connectors/sharepoint/lib" file="lib/saaj.jar"/>
<copy todir="connectors/sharepoint/lib" file="lib/wsdl4j.jar"/>
<copy todir="connectors/sharepoint/lib" file="lib/commons-discovery.jar"/>
+ <copy todir="connectors/sharepoint/lib" file="lib/geronimo-activation_1.1_spec.jar"/>
<copy todir="connectors/sharepoint/lib">
<fileset dir="framework/lib"/>
Modified: incubator/lcf/trunk/modules/connectors/documentum/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/documentum/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/documentum/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/documentum/build.xml Fri Mar 5 17:12:14 2010
@@ -25,7 +25,7 @@
<target name="doc" depends="precompile-check" if="canBuild">
<mkdir dir="doc"/>
- <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar">
+ <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
<fileset dir="connector" includes="**/*.java"/>
<fileset dir="interface" includes="**/*.java"/>
</javadoc>
@@ -256,6 +256,6 @@
<copy todir="dist/registry-process" file="build/jar/lcf-documentum-registry.jar"/>
</target>
- <target name="all" depends="processes,server-process,registry-process,iar-crawler-ui,iar-authority-service"/>
+ <target name="all" depends="processes,server-process,registry-process,iar-crawler-ui,iar-authority-service,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/filenet/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/filenet/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/filenet/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/filenet/build.xml Fri Mar 5 17:12:14 2010
@@ -3,6 +3,7 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
<target name="calculate-condition">
@@ -16,6 +17,14 @@
<echo message="FileNet Connector cannot be built without Jace.jar"/>
</target>
+ <target name="doc" depends="precompile-check" if="canBuild">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ <fileset dir="interface" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-interface" depends="precompile-check" if="canBuild">
<mkdir dir="build/interface/classes"/>
<javac srcdir="interface" destdir="build/interface/classes" classpath="" target="1.5" source="1.4"/>
@@ -223,6 +232,6 @@
<copy todir="dist/registry-process" file="build/jar/lcf-filenet-registry.jar"/>
</target>
- <target name="all" depends="processes,server-process,registry-process,iar-crawler-ui"/>
+ <target name="all" depends="processes,server-process,registry-process,iar-crawler-ui,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/filenet/connector/org/apache/lcf/crawler/connectors/filenet/FilenetConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/filenet/connector/org/apache/lcf/crawler/connectors/filenet/FilenetConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/filenet/connector/org/apache/lcf/crawler/connectors/filenet/FilenetConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/filenet/connector/org/apache/lcf/crawler/connectors/filenet/FilenetConnector.java Fri Mar 5 17:12:14 2010
@@ -724,7 +724,7 @@
*@param oldVersions is the corresponding array of version strings that have been saved for the document identifiers.
* A null value indicates that this is a first-time fetch, while an empty string indicates that the previous document
* had an empty version string.
- *@param activities is the interface this method should use to perform whatever framework actions are desired.
+ *@param activity is the interface this method should use to perform whatever framework actions are desired.
*@param spec is the current document specification for the current job. If there is a dependency on this
* specification, then the version string should include the pertinent data, so that reingestion will occur
* when the specification changes. This is primarily useful for metadata.
@@ -2079,10 +2079,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the place to write the unpacked array into.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)
Modified: incubator/lcf/trunk/modules/connectors/filesystem/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/filesystem/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/filesystem/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/filesystem/build.xml Fri Mar 5 17:12:14 2010
@@ -3,8 +3,16 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
+ <target name="doc">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-connector">
<mkdir dir="build/connector/classes"/>
<javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar" target="1.5" source="1.4"/>
@@ -93,6 +101,6 @@
<jar destfile="dist/tomcat/lcf-filesystemconnector-crawler-ui.iar" basedir="build/webapp/crawler-ui"/>
</target>
- <target name="all" depends="processes,iar-crawler-ui"/>
+ <target name="all" depends="processes,iar-crawler-ui,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/gts/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/gts/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/gts/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/gts/build.xml Fri Mar 5 17:12:14 2010
@@ -3,8 +3,16 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
-
+
+ <target name="doc">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-connector">
<mkdir dir="build/connector/classes"/>
<javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar" target="1.5" source="1.4"/>
@@ -93,6 +101,6 @@
<copy todir="dist/processes" file="build/jar/lcf-gts-connector.jar"/>
</target>
- <target name="all" depends="processes,iar-crawler-ui"/>
+ <target name="all" depends="processes,iar-crawler-ui,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/gts/connector/org/apache/lcf/agents/output/gts/GTSConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/gts/connector/org/apache/lcf/agents/output/gts/GTSConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/gts/connector/org/apache/lcf/agents/output/gts/GTSConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/gts/connector/org/apache/lcf/agents/output/gts/GTSConnector.java Fri Mar 5 17:12:14 2010
@@ -187,7 +187,7 @@
*@param outputDescription is the description string that was constructed for this document by the getOutputDescription() method.
*@param document is the document data to be processed (handed to the output data store).
*@param authorityNameString is the name of the authority responsible for authorizing any access tokens passed in with the repository document. May be null.
- *@activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
+ *@param activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
*@return the document status (accepted or permanently rejected).
*/
public int addOrReplaceDocument(String documentURI, String outputDescription, RepositoryDocument document, String authorityNameString, IOutputAddActivity activities)
@@ -221,7 +221,7 @@
*@param documentURI is the URI of the document. The URI is presumed to be the unique identifier which the output data store will use to process
* and serve the document. This URI is constructed by the repository connector which fetches the document, and is thus universal across all output connectors.
*@param outputDescription is the last description string that was constructed for this document by the getOutputDescription() method above.
- *@activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
+ *@param activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
*/
public void removeDocument(String documentURI, String outputDescription, IOutputRemoveActivity activities)
throws LCFException, ServiceInterruption
@@ -314,10 +314,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the array into which to write the unpacked result.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)
Modified: incubator/lcf/trunk/modules/connectors/jcifs/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/jcifs/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/jcifs/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/jcifs/build.xml Fri Mar 5 17:12:14 2010
@@ -3,6 +3,7 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
<target name="calculate-condition">
@@ -16,6 +17,13 @@
<echo message="JCifs Connector cannot be built without jcifs.jar"/>
</target>
+ <target name="doc" depends="precompile-check" if="canBuild">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="jcifs/jcifs.jar:lib/jakarta-poi.jar:lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-connector" depends="precompile-check" if="canBuild">
<mkdir dir="build/connector/classes"/>
<javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:jcifs/jcifs.jar:lib/jakarta-poi.jar" target="1.5" source="1.4"/>
@@ -128,6 +136,6 @@
<copy todir="dist/processes" file="jcifs.smb.client.soTimeout"/>
</target>
- <target name="all" depends="processes,iar-crawler-ui"/>
+ <target name="all" depends="processes,iar-crawler-ui,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/jcifs/connector/org/apache/lcf/crawler/connectors/sharedrive/SharedDriveConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/jcifs/connector/org/apache/lcf/crawler/connectors/sharedrive/SharedDriveConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/jcifs/connector/org/apache/lcf/crawler/connectors/sharedrive/SharedDriveConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/jcifs/connector/org/apache/lcf/crawler/connectors/sharedrive/SharedDriveConnector.java Fri Mar 5 17:12:14 2010
@@ -2177,10 +2177,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the array to write the unpacked results into.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)
Modified: incubator/lcf/trunk/modules/connectors/jdbc/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/jdbc/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/jdbc/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/jdbc/build.xml Fri Mar 5 17:12:14 2010
@@ -3,8 +3,16 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
-
+
+ <target name="doc">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-connector">
<mkdir dir="build/connector/classes"/>
<javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/jdbcpool-0.99.jar" target="1.5" source="1.4"/>
@@ -99,6 +107,6 @@
</copy>
</target>
- <target name="all" depends="processes,iar-crawler-ui"/>
+ <target name="all" depends="processes,iar-crawler-ui,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/jdbc/connector/org/apache/lcf/crawler/connectors/jdbc/JDBCConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/jdbc/connector/org/apache/lcf/crawler/connectors/jdbc/JDBCConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/jdbc/connector/org/apache/lcf/crawler/connectors/jdbc/JDBCConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/jdbc/connector/org/apache/lcf/crawler/connectors/jdbc/JDBCConnector.java Fri Mar 5 17:12:14 2010
@@ -890,10 +890,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the array to write the unpacked result into.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)
Modified: incubator/lcf/trunk/modules/connectors/livelink/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/livelink/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/livelink/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/livelink/build.xml Fri Mar 5 17:12:14 2010
@@ -3,6 +3,7 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
<target name="calculate-condition">
@@ -16,6 +17,13 @@
<echo message="LiveLink Connector cannot be built without lapi.jar"/>
</target>
+ <target name="doc" depends="precompile-check" if="canBuild">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="lapi/lapi.jar:lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-connector" depends="precompile-check" if="canBuild">
<mkdir dir="build/connector/classes"/>
<javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lapi/lapi.jar:lib/commons-httpclient-lcf.jar:lib/commons-codec.jar:lib/commons-collections.jar" target="1.5" source="1.4"/>
@@ -120,6 +128,6 @@
<copy todir="dist/processes" file="build/jar/lcf-livelink-connector.jar"/>
</target>
- <target name="all" depends="processes,iar-crawler-ui,iar-authority-service"/>
+ <target name="all" depends="processes,iar-crawler-ui,iar-authority-service,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/livelink/connector/org/apache/lcf/crawler/connectors/livelink/LivelinkConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/livelink/connector/org/apache/lcf/crawler/connectors/livelink/LivelinkConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/livelink/connector/org/apache/lcf/crawler/connectors/livelink/LivelinkConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/livelink/connector/org/apache/lcf/crawler/connectors/livelink/LivelinkConnector.java Fri Mar 5 17:12:14 2010
@@ -1985,10 +1985,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the array to write the unpacked result into.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)
Modified: incubator/lcf/trunk/modules/connectors/memex/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/memex/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/memex/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/memex/build.xml Fri Mar 5 17:12:14 2010
@@ -3,15 +3,27 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
- <target name="precompile-check">
+ <target name="calculate-condition">
<available file="mxie-java/JavaMXIELIB.jar" property="mxieStatus"/>
<condition property="canBuild">
<isset property="mxieStatus"/>
</condition>
</target>
+ <target name="precompile-check" depends="calculate-condition" unless="canBuild">
+ <echo message="Memex Connector cannot be built without JavaMXIELIB.jar"/>
+ </target>
+
+ <target name="doc" depends="precompile-check" if="canBuild">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="mxie-java/JavaMXIELIB.jar:lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.5">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-connector" depends="precompile-check" if="canBuild">
<property name="classpath" value="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:mxie-java/JavaMXIELIB.jar"/>
<mkdir dir="build/connector/classes"/>
@@ -123,6 +135,6 @@
<copy todir="dist/processes" file="build/jar/lcf-memex-connector.jar"/>
</target>
- <target name="all" depends="processes,iar-crawler-ui,iar-authority-service"/>
+ <target name="all" depends="processes,iar-crawler-ui,iar-authority-service,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/memex/connector/org/apache/lcf/crawler/connectors/memex/MemexConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/memex/connector/org/apache/lcf/crawler/connectors/memex/MemexConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/memex/connector/org/apache/lcf/crawler/connectors/memex/MemexConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/memex/connector/org/apache/lcf/crawler/connectors/memex/MemexConnector.java Fri Mar 5 17:12:14 2010
@@ -687,7 +687,7 @@
*@param oldVersions is the corresponding array of version strings that have been saved for the document identifiers.
* A null value indicates that this is a first-time fetch, while an empty string indicates that the previous document
* had an empty version string.
- *@param activities is the interface this method should use to perform whatever framework actions are desired.
+ *@param activity is the interface this method should use to perform whatever framework actions are desired.
*@param spec is the current document specification for the current job. If there is a dependency on this
* specification, then the version string should include the pertinent data, so that reingestion will occur
* when the specification changes. This is primarily useful for metadata.
@@ -1629,10 +1629,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the array to unpack the list into.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList<String> output, String value, int startPosition, char delimiter)
Modified: incubator/lcf/trunk/modules/connectors/meridio/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/meridio/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/meridio/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/meridio/build.xml Fri Mar 5 17:12:14 2010
@@ -3,6 +3,7 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
<target name="calculate-condition">
@@ -79,7 +80,7 @@
</target>
<target name="classcreate-xsds" depends="precompile-check" if="canBuild">
- <mkdir dir="build/xsdjava"/>
+ <delete dir="build/xsdjava"/>
<antcall target="classcreate-xsd">
<param name="xsdname" value="build/wsdls/DMDataSet.xsd"/>
<param name="packagename" value="DMDataSet"/>
@@ -93,20 +94,28 @@
<param name="packagename" value="RMDataSet"/>
</antcall>
</target>
-
+
+
<target name="compile-wsdls" depends="classcreate-wsdls,precompile-check" if="canBuild">
<mkdir dir="build/wsdlclasses"/>
- <javac srcdir="build/wsdljava" destdir="build/wsdlclasses" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/mailapi.jar:lib/axis.jar:lib/activation.jar:lib/jaxrpc.jar:lib/saaj.jar" target="1.5" source="1.4"/>
+ <javac srcdir="build/wsdljava" destdir="build/wsdlclasses" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/geronimo-javamail_1.4_spec.jar:lib/axis.jar:lib/geronimo-activation_1.1_spec.jar:lib/jaxrpc.jar:lib/saaj.jar" target="1.5" source="1.4"/>
</target>
<target name="compile-xsds" depends="classcreate-xsds,precompile-check" if="canBuild">
<mkdir dir="build/xsdclasses"/>
- <javac srcdir="build/xsdjava" destdir="build/xsdclasses" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/mailapi.jar:lib/castor-1.0.5-commons.jar:lib/castor-1.0.5.jar:lib/castor-1.0.5-xml.jar:lib/geronimo-activation_1.1_spec.jar" target="1.5" source="1.4"/>
+ <javac srcdir="build/xsdjava" destdir="build/xsdclasses" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/geronimo-javamail_1.4_spec.jar:lib/castor-1.0.5-commons.jar:lib/castor-1.0.5.jar:lib/castor-1.0.5-xml.jar:lib/geronimo-activation_1.1_spec.jar" target="1.5" source="1.4"/>
+ </target>
+
+ <target name="doc" depends="precompile-check,compile-wsdls,compile-xsds" if="canBuild">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="build/wsdljava:build/xsdjava:lib/xercesImpl-lcf.jar:lib/xml-apis.jar:lib/axis.jar:lib/geronimo-javamail_1.4_spec.jar:lib/geronimo-activation_1.1_spec.jar:lib/jaxrpc.jar:lib/saaj.jar:lib/castor-1.0.5-commons.jar:lib/castor-1.0.5.jar:lib/castor-1.0.5-xml.jar:lib/geronimo-activation_1.1_spec.jar:lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
</target>
<target name="compile-connector" depends="compile-wsdls,compile-xsds,precompile-check" if="canBuild">
<mkdir dir="build/connector/classes"/>
- <javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/mailapi.jar:lib/castor-1.0.5-commons.jar:lib/castor-1.0.5.jar:lib/castor-1.0.5-xml.jar:lib/geronimo-activation_1.1_spec.jar:lib/axis.jar:build/wsdlclasses:build/xsdclasses:lib/activation.jar:lib/jaxrpc.jar:lib/saaj.jar" target="1.5" source="1.4"/>
+ <javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/geronimo-javamail_1.4_spec.jar:lib/castor-1.0.5-commons.jar:lib/castor-1.0.5.jar:lib/castor-1.0.5-xml.jar:lib/geronimo-activation_1.1_spec.jar:lib/axis.jar:build/wsdlclasses:build/xsdclasses:lib/geronimo-activation_1.1_spec.jar:lib/jaxrpc.jar:lib/saaj.jar" target="1.5" source="1.4"/>
</target>
<target name="compile-crawler-ui" depends="compile-connector,compile-wsdls,compile-xsds,precompile-check" if="canBuild">
@@ -263,6 +272,6 @@
<copy todir="dist/processes" file="org.apache.lcf.meridio.wsddpath"/>
</target>
- <target name="all" depends="processes,wsdd,iar-crawler-ui,iar-authority-service,iar-wsdd"/>
+ <target name="all" depends="processes,wsdd,iar-crawler-ui,iar-authority-service,iar-wsdd,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/CommonsHTTPSender.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/CommonsHTTPSender.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/CommonsHTTPSender.java (original)
+++ incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/CommonsHTTPSender.java Fri Mar 5 17:12:14 2010
@@ -463,7 +463,6 @@
* a string or an array of strings (if there are more than one Set-Cookie)
*
* @param cookieName
- * @param setCookieName
* @param cookie
* @param msgContext
*/
Modified: incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/MeridioConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/MeridioConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/MeridioConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/meridio/connector/org/apache/lcf/crawler/connectors/meridio/MeridioConnector.java Fri Mar 5 17:12:14 2010
@@ -1487,10 +1487,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the array to fill with the unpacked list.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)
Modified: incubator/lcf/trunk/modules/connectors/nulloutput/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/nulloutput/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/nulloutput/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/nulloutput/build.xml Fri Mar 5 17:12:14 2010
@@ -3,8 +3,16 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
-
+
+ <target name="doc">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-connector">
<mkdir dir="build/connector/classes"/>
<javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar" target="1.5" source="1.4"/>
@@ -93,6 +101,6 @@
<copy todir="dist/processes" file="build/jar/lcf-nulloutput-connector.jar"/>
</target>
- <target name="all" depends="processes,iar-crawler-ui"/>
+ <target name="all" depends="processes,iar-crawler-ui,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/nulloutput/connector/org/apache/lcf/agents/output/nullconnector/NullConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/nulloutput/connector/org/apache/lcf/agents/output/nullconnector/NullConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/nulloutput/connector/org/apache/lcf/agents/output/nullconnector/NullConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/nulloutput/connector/org/apache/lcf/agents/output/nullconnector/NullConnector.java Fri Mar 5 17:12:14 2010
@@ -129,7 +129,7 @@
*@param outputDescription is the description string that was constructed for this document by the getOutputDescription() method.
*@param document is the document data to be processed (handed to the output data store).
*@param authorityNameString is the name of the authority responsible for authorizing any access tokens passed in with the repository document. May be null.
- *@activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
+ *@param activities is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.
*@return the document status (accepted or permanently rejected).
*/
public int addOrReplaceDocument(String documentURI, String outputDescription, RepositoryDocument document, String authorityNameString, IOutputAddActivity activities)
Modified: incubator/lcf/trunk/modules/connectors/rss/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/rss/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/rss/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/rss/build.xml Fri Mar 5 17:12:14 2010
@@ -3,8 +3,16 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
-
+
+ <target name="doc">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-connector">
<mkdir dir="build/connector/classes"/>
<javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/commons-httpclient-lcf.jar:lib/commons-collections.jar:lib/commons-codec.jar" target="1.5" source="1.4"/>
@@ -93,6 +101,6 @@
<copy todir="dist/processes" file="build/jar/lcf-rss-connector.jar"/>
</target>
- <target name="all" depends="processes,iar-crawler-ui"/>
+ <target name="all" depends="processes,iar-crawler-ui,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/RSSConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/RSSConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/RSSConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/RSSConnector.java Fri Mar 5 17:12:14 2010
@@ -486,7 +486,9 @@
* (Doing so would destroy the ability of virtually hosted sites to do the right thing,
* since the original host name would be lost.) Thus, we do the conversion to IP address
* right before we actually fetch the document.
- *@param the identifier of the document in which the raw url was found, or null if none.
+ *@param policies are the canonicalization policies in effect.
+ *@param parentIdentifier the identifier of the document in which the raw url was found, or null if none.
+ *@param rawURL is the raw, un-normalized and un-canonicalized url.
*@return the canonical URL (the document identifier), or null if the url was illegal.
*/
protected static String makeDocumentIdentifier(CanonicalizationPolicies policies, String parentIdentifier, String rawURL)
@@ -794,7 +796,7 @@
*@param spec is the current document specification for the current job. If there is a dependency on this
* specification, then the version string should include the pertinent data, so that reingestion will occur
* when the specification changes. This is primarily useful for metadata.
- *@param jobMode is an integer describing how the job is being run, whether continuous or once-only.
+ *@param jobType is an integer describing how the job is being run, whether continuous or once-only.
*@param usesDefaultAuthority will be true only if the authority in use for these documents is the default one.
*@return the corresponding version strings, with null in the places where the document no longer exists.
* Empty version strings indicate that there is no versioning ability for the corresponding document, and the document
@@ -3380,10 +3382,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the array to fill with the unpacked data.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)
Modified: incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/ThrottledFetcher.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/ThrottledFetcher.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/ThrottledFetcher.java (original)
+++ incubator/lcf/trunk/modules/connectors/rss/connector/org/apache/lcf/crawler/connectors/rss/ThrottledFetcher.java Fri Mar 5 17:12:14 2010
@@ -127,13 +127,14 @@
* stream will block on fetch until the number of bytes being fetched, done
* in the average time interval required for that fetch, would not exceed
* the desired bandwidth.
- * @param minimumMillisecondsPerFetch is the number of milliseconds
+ * @param minimumMillisecondsPerFetchPerServer is the number of milliseconds
* between fetches, as a minimum, on a per-server basis. Set
* to zero for no limit.
* @param maxOpenConnectionsPerServer is the maximum number of open connections to allow for a single server.
* If more than this number of connections would need to be open, then this connection request will block
* until this number will no longer be exceeded.
* @param connectionLimit is the maximum desired outstanding connections at any one time.
+ * @param connectionTimeoutMilliseconds is the number of milliseconds to wait for the connection before timing out.
*/
public synchronized IThrottledConnection createConnection(String serverName, double minimumMillisecondsPerBytePerServer,
int maxOpenConnectionsPerServer, long minimumMillisecondsPerFetchPerServer, int connectionLimit, int connectionTimeoutMilliseconds)
@@ -545,7 +546,13 @@
* @param urlPath is the path part of the url, e.g. "/robots.txt"
* @param userAgent is the value of the userAgent header to use.
* @param from is the value of the from header to use.
- * @param connectionTimeoutMilliseconds is the maximum number of milliseconds to wait on socket connect.
+ * @param proxyHost is the proxy host, or null if none.
+ * @param proxyPort is the proxy port, or -1 if none.
+ * @param proxyAuthDomain is the proxy authentication domain, or null.
+ * @param proxyAuthUsername is the proxy authentication user name, or null.
+ * @param proxyAuthPassword is the proxy authentication password, or null.
+ * @param lastETag is the requested lastETag header value.
+ * @param lastModified is the requested lastModified header value.
* @return the status code: success, static error, or dynamic error.
*/
public int executeFetch(String protocol, int port, String urlPath, String userAgent, String from,
Modified: incubator/lcf/trunk/modules/connectors/sharepoint/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/sharepoint/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/sharepoint/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/sharepoint/build.xml Fri Mar 5 17:12:14 2010
@@ -3,6 +3,7 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
@@ -39,7 +40,7 @@
<target name="classcreate-wsdl">
<mkdir dir="build/wsdljava"/>
- <java classname="org.apache.axis.wsdl.WSDL2Java" fork="true" classpath="lib/axis.jar:lib/commons-logging.jar:lib/commons-discovery.jar:lib/saaj.jar:lib/wsdl4j.jar:lib/jaxrpc.jar:lib/activation.jar:lib/xml-apis.jar:lib/xercesImpl.jar">
+ <java classname="org.apache.axis.wsdl.WSDL2Java" fork="true" classpath="lib/axis.jar:lib/commons-logging.jar:lib/commons-discovery.jar:lib/saaj.jar:lib/wsdl4j.jar:lib/jaxrpc.jar:lib/geronimo-activation_1.1_spec.jar:lib/xml-apis.jar:lib/xercesImpl.jar">
<arg value="--timeout"/>
<arg value="0"/>
<arg value="--noImports"/>
@@ -75,12 +76,19 @@
<target name="compile-wsdls" depends="classcreate-wsdls,precompile-check" if="canBuild">
<mkdir dir="build/wsdlclasses"/>
- <javac srcdir="build/wsdljava" destdir="build/wsdlclasses" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/axis.jar:lib/activation.jar:lib/jaxrpc.jar:lib/saaj.jar" target="1.5" source="1.4"/>
+ <javac srcdir="build/wsdljava" destdir="build/wsdlclasses" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/axis.jar:lib/geronimo-activation_1.1_spec.jar:lib/jaxrpc.jar:lib/saaj.jar" target="1.5" source="1.4"/>
+ </target>
+
+ <target name="doc" depends="precompile-check,compile-wsdls" if="canBuild">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="lib/axis.jar:lib/geronimo-activation_1.1_spec.jar:lib/jaxrpc.jar:lib/saaj.jar:build/wsdlclasses:lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
</target>
<target name="compile-connector" depends="compile-wsdls,precompile-check" if="canBuild">
<mkdir dir="build/connector/classes"/>
- <javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/axis.jar:lib/activation.jar:lib/jaxrpc.jar:lib/saaj.jar:build/wsdlclasses" target="1.5" source="1.4"/>
+ <javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/axis.jar:lib/geronimo-activation_1.1_spec.jar:lib/jaxrpc.jar:lib/saaj.jar:build/wsdlclasses" target="1.5" source="1.4"/>
</target>
<target name="compile-crawler-ui" depends="compile-connector,compile-wsdls,precompile-check" if="canBuild">
@@ -196,6 +204,6 @@
<copy todir="dist/processes" file="org.apache.lcf.sharepoint.wsddpath"/>
</target>
- <target name="all" depends="processes,iar-crawler-ui,iar-wsdd,wsdd"/>
+ <target name="all" depends="processes,iar-crawler-ui,iar-wsdd,wsdd,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/CommonsHTTPSender.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/CommonsHTTPSender.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/CommonsHTTPSender.java (original)
+++ incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/CommonsHTTPSender.java Fri Mar 5 17:12:14 2010
@@ -455,7 +455,6 @@
* a string or an array of strings (if there are more than one Set-Cookie)
*
* @param cookieName
- * @param setCookieName
* @param cookie
* @param msgContext
*/
Modified: incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SPSProxyHelper.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SPSProxyHelper.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SPSProxyHelper.java (original)
+++ incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SPSProxyHelper.java Fri Mar 5 17:12:14 2010
@@ -84,7 +84,7 @@
* Get the acls for a document library.
* @param site
* @param docLib is the library GUID
- * @return
+ * @return array of sids
* @throws Exception
*/
public String[] getACLs(String site, String docLib )
@@ -275,8 +275,9 @@
* NOTE that this function only works for SharePoint 3.0 with the MCPermissions web service installed.
* @param site is the encoded subsite path
* @param file is the encoded file url (not including protocol or server or location, but including encoded subsite, library and folder/file path)
- * @return
- * @throws Exception
+ * @return array of document SIDs
+ * @throws LCFException
+ * @throws ServiceInterruption
*/
public String[] getDocumentACLs(String site, String file)
throws LCFException, ServiceInterruption
@@ -478,8 +479,9 @@
*
* @param site
* @param docLibrary
- * @return
+ * @return an XML document
* @throws LCFException
+ * @throws ServiceInterruption
*/
public XMLDoc getDocuments(String site, String docLibrary)
throws LCFException, ServiceInterruption
@@ -645,10 +647,11 @@
/**
*
- * @param site
+ * @param parentSite
* @param docLibrary
- * @return
- * @throws Exception
+ * @return document library ID
+ * @throws LCFException
+ * @throws ServiceInterruption
*/
public String getDocLibID(String parentSite, String parentSiteDecoded, String docLibrary)
throws ServiceInterruption, LCFException
@@ -835,8 +838,9 @@
*
* @param site
* @param docPath
- * @return
- * @throws Exception
+ * @return an XML document
+ * @throws LCFException
+ * @throws ServiceInterruption
*/
public XMLDoc getVersions( String site, String docPath)
throws ServiceInterruption, LCFException
@@ -1108,7 +1112,7 @@
/**
*
- * @return
+ * @return true if connection OK
* @throws java.net.MalformedURLException
* @throws javax.xml.rpc.ServiceException
* @throws java.rmi.RemoteException
Modified: incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SharePointRepository.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SharePointRepository.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SharePointRepository.java (original)
+++ incubator/lcf/trunk/modules/connectors/sharepoint/connector/org/apache/lcf/crawler/connectors/sharepoint/SharePointRepository.java Fri Mar 5 17:12:14 2010
@@ -2047,10 +2047,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the array to write the unpacked result into.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)
Modified: incubator/lcf/trunk/modules/connectors/webcrawler/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/webcrawler/build.xml?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/webcrawler/build.xml (original)
+++ incubator/lcf/trunk/modules/connectors/webcrawler/build.xml Fri Mar 5 17:12:14 2010
@@ -3,8 +3,16 @@
<target name="clean">
<delete dir="build"/>
<delete dir="dist"/>
+ <delete dir="doc"/>
</target>
-
+
+ <target name="doc">
+ <mkdir dir="doc"/>
+ <javadoc destdir="doc" classpath="lib/servlet-api.jar:lib/jdbcpool-0.99.jar:lib/postgresql.jar:lib/commons-fileupload.jar:lib/serializer.jar:lib/log4j-1.2.jar:lib/commons-logging.jar:lib/commons-httpclient-lcf.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/xml-apis.jar:lib/xalan2.jar:lib/commons-collections.jar:lib/commons-codec.jar:lib/commons-io.jar" source="1.4">
+ <fileset dir="connector" includes="**/*.java"/>
+ </javadoc>
+ </target>
+
<target name="compile-connector">
<mkdir dir="build/connector/classes"/>
<javac srcdir="connector" destdir="build/connector/classes" classpath="lib/log4j-1.2.jar:lib/commons-logging.jar:lib/lcf-core.jar:lib/lcf-agents.jar:lib/lcf-pull-agent.jar:lib/commons-httpclient-lcf.jar:lib/commons-collections.jar:lib/commons-codec.jar" target="1.5" source="1.4"/>
@@ -93,6 +101,6 @@
<copy todir="dist/processes" file="build/jar/lcf-web-connector.jar"/>
</target>
- <target name="all" depends="processes,iar-crawler-ui"/>
+ <target name="all" depends="processes,iar-crawler-ui,doc"/>
</project>
Modified: incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/ThrottledFetcher.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/ThrottledFetcher.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/ThrottledFetcher.java (original)
+++ incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/ThrottledFetcher.java Fri Mar 5 17:12:14 2010
@@ -80,11 +80,13 @@
*@param protocol is the protocol, e.g. "http"
*@param server is the server IP address, e.g. "10.32.65.1"
*@param port is the port to connect to, e.g. 80. Pass -1 if the default port for the protocol is desired.
- *@param credentials is the credentials object to use for the fetch. If null, no credentials are available.
+ *@param authentication is the page credentials object to use for the fetch. If null, no credentials are available.
+ *@param trustStore is the current trust store in effect for the fetch.
*@param binNames is the set of bins, in order, that should be used for throttling this connection.
* Note that the bin names for a given IP address and port MUST be the same for every connection!
* This must be enforced by whatever it is that builds the bins - it must do so given an IP and port.
*@param throttleDescription is the description of all the throttling that should take place.
+ *@param connectionLimit isthe maximum number of connections permitted.
*@return an IThrottledConnection object that can be used to fetch from the port.
*/
public static IThrottledConnection getConnection(String protocol, String server, int port,
Modified: incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/WebcrawlerConnector.java
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/WebcrawlerConnector.java?rev=919506&r1=919505&r2=919506&view=diff
==============================================================================
--- incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/WebcrawlerConnector.java (original)
+++ incubator/lcf/trunk/modules/connectors/webcrawler/connector/org/apache/lcf/crawler/connectors/webcrawler/WebcrawlerConnector.java Fri Mar 5 17:12:14 2010
@@ -1666,7 +1666,9 @@
* (Doing so would destroy the ability of virtually hosted sites to do the right thing,
* since the original host name would be lost.) Thus, we do the conversion to IP address
* right before we actually fetch the document.
- *@param the identifier of the document in which the raw url was found, or null if none.
+ *@param parentIdentifier the identifier of the document in which the raw url was found, or null if none.
+ *@param rawURL the starting, un-normalized, un-canonicalized URL.
+ *@param filter the filter object, used to remove unmatching URLs.
*@return the canonical URL (the document identifier), or null if the url was illegal.
*/
protected String makeDocumentIdentifier(String parentIdentifier, String rawURL, DocumentURLFilter filter)
@@ -3911,10 +3913,10 @@
}
/** Unstuffer for unpacking lists of variable length.
+ *@param output is the array into which the unpacked output is written.
*@param value is the value to unpack.
*@param startPosition is the place to start the unpack.
*@param delimiter is the character to use between values.
- *@param endChar is the character to use to mark the end.
*@return the next position beyond the end of the list.
*/
protected static int unpackList(ArrayList output, String value, int startPosition, char delimiter)