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 2012/02/11 08:47:51 UTC
svn commit: r1243011 - in /incubator/lcf/trunk: framework/
framework/example-multiprocess-common/ framework/scripts/
site/src/documentation/content/xdocs/en_US/
Author: kwright
Date: Sat Feb 11 07:47:51 2012
New Revision: 1243011
URL: http://svn.apache.org/viewvc?rev=1243011&view=rev
Log:
More changes related to CONNECTORS-327. Standardize name of directory where jars are put, and move scripts to the root level of their prospective areas. Also fix the how-to-build documentation.
Modified:
incubator/lcf/trunk/framework/build.xml
incubator/lcf/trunk/framework/example-multiprocess-common/initialize.bat
incubator/lcf/trunk/framework/example-multiprocess-common/initialize.sh
incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.bat
incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.sh
incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.bat
incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.sh
incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.bat
incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.sh
incubator/lcf/trunk/framework/scripts/executecommand.bat
incubator/lcf/trunk/framework/scripts/executecommand.sh
incubator/lcf/trunk/framework/scripts/setclasspath.bat
incubator/lcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml
Modified: incubator/lcf/trunk/framework/build.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/build.xml?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/build.xml (original)
+++ incubator/lcf/trunk/framework/build.xml Sat Feb 11 07:47:51 2012
@@ -566,8 +566,8 @@
</target>
<target name="multi-processes" depends="jar-core,jar-agents,jar-pull-agent">
- <mkdir dir="dist/multiprocess-example/processes/jar"/>
- <copy todir="dist/multiprocess-example/processes/jar">
+ <mkdir dir="dist/multiprocess-example/processes/lib"/>
+ <copy todir="dist/multiprocess-example/processes/lib">
<fileset dir="../build/jar">
<include name="json.jar"/>
</fileset>
@@ -600,16 +600,15 @@
<include name="mcf-pull-agent.jar"/>
</fileset>
</copy>
- <mkdir dir="dist/multiprocess-example/processes/script"/>
- <copy todir="dist/multiprocess-example/processes/script">
+ <copy todir="dist/multiprocess-example/processes">
<fileset dir="scripts"/>
</copy>
<mkdir dir="dist/multiprocess-example/syncharea"/>
</target>
<target name="multi-processes-proprietary" depends="jar-core,jar-agents,jar-pull-agent">
- <mkdir dir="dist/multiprocess-example-proprietary/processes/jar"/>
- <copy todir="dist/multiprocess-example-proprietary/processes/jar">
+ <mkdir dir="dist/multiprocess-example-proprietary/processes/lib"/>
+ <copy todir="dist/multiprocess-example-proprietary/processes/lib">
<fileset dir="../build/jar">
<include name="json.jar"/>
</fileset>
@@ -647,8 +646,7 @@
<include name="mcf-pull-agent.jar"/>
</fileset>
</copy>
- <mkdir dir="dist/multiprocess-example-proprietary/processes/script"/>
- <copy todir="dist/multiprocess-example-proprietary/processes/script">
+ <copy todir="dist/multiprocess-example-proprietary/processes">
<fileset dir="scripts"/>
</copy>
<mkdir dir="dist/multiprocess-example-proprietary/syncharea"/>
Modified: incubator/lcf/trunk/framework/example-multiprocess-common/initialize.bat
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/example-multiprocess-common/initialize.bat?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/example-multiprocess-common/initialize.bat (original)
+++ incubator/lcf/trunk/framework/example-multiprocess-common/initialize.bat Sat Feb 11 07:47:51 2012
@@ -20,7 +20,7 @@ if not exist ".\properties.xml" goto nol
rem set MCF_HOME
set MCF_HOME=%CD%
rem invoke the RegisterAll command
-cmd /c "processes\script\executecommand.bat org.apache.manifoldcf.crawler.InitializeAndRegister"
+cmd /c "processes\executecommand.bat org.apache.manifoldcf.crawler.InitializeAndRegister"
goto done
:nojavahome
echo Environment variable JAVA_HOME is not set properly.
Modified: incubator/lcf/trunk/framework/example-multiprocess-common/initialize.sh
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/example-multiprocess-common/initialize.sh?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/example-multiprocess-common/initialize.sh (original)
+++ incubator/lcf/trunk/framework/example-multiprocess-common/initialize.sh Sat Feb 11 07:47:51 2012
@@ -20,7 +20,7 @@ if [ -e "$JAVA_HOME"/bin/java ] ; then
if [ -f ./properties.xml ] ; then
# Set the MCF_HOME variable
export MCF_HOME=$PWD
- processes/script/executecommand.sh org.apache.manifoldcf.crawler.InitializeAndRegister
+ processes/executecommand.sh org.apache.manifoldcf.crawler.InitializeAndRegister
exit $?
else
Modified: incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.bat
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.bat?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.bat (original)
+++ incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.bat Sat Feb 11 07:47:51 2012
@@ -19,8 +19,8 @@ if not exist "%JAVA_HOME%\bin\java.exe"
if not exist ".\properties.xml" goto nolcfhome
rem set MCF_HOME
set MCF_HOME=%CD%
-rem invoke the AgentRun command
-cmd /c "processes\script\executecommand.bat org.apache.manifoldcf.core.LockClean"
+rem invoke the LockClean command
+cmd /c "processes\executecommand.bat org.apache.manifoldcf.core.LockClean"
goto done
:nojavahome
echo Environment variable JAVA_HOME is not set properly.
Modified: incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.sh
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.sh?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.sh (original)
+++ incubator/lcf/trunk/framework/example-multiprocess-common/lock-clean.sh Sat Feb 11 07:47:51 2012
@@ -20,7 +20,7 @@ if [ -e "$JAVA_HOME"/bin/java ] ; then
if [ -f ./properties.xml ] ; then
# Set the MCF_HOME variable
export MCF_HOME=$PWD
- processes/script/executecommand.sh org.apache.manifoldcf.core.LockClean
+ processes/executecommand.sh org.apache.manifoldcf.core.LockClean
exit $?
else
Modified: incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.bat
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.bat?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.bat (original)
+++ incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.bat Sat Feb 11 07:47:51 2012
@@ -20,7 +20,7 @@ if not exist ".\properties.xml" goto nol
rem set MCF_HOME
set MCF_HOME=%CD%
rem invoke the AgentRun command
-cmd /c "processes\script\executecommand.bat org.apache.manifoldcf.agents.AgentRun"
+cmd /c "processes\executecommand.bat org.apache.manifoldcf.agents.AgentRun"
goto done
:nojavahome
echo Environment variable JAVA_HOME is not set properly.
Modified: incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.sh
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.sh?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.sh (original)
+++ incubator/lcf/trunk/framework/example-multiprocess-common/start-agents.sh Sat Feb 11 07:47:51 2012
@@ -20,7 +20,7 @@ if [ -e "$JAVA_HOME"/bin/java ] ; then
if [ -f ./properties.xml ] ; then
# Set the MCF_HOME variable
export MCF_HOME=$PWD
- processes/script/executecommand.sh org.apache.manifoldcf.agents.AgentRun
+ processes/executecommand.sh org.apache.manifoldcf.agents.AgentRun
exit $?
else
Modified: incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.bat
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.bat?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.bat (original)
+++ incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.bat Sat Feb 11 07:47:51 2012
@@ -19,8 +19,8 @@ if not exist "%JAVA_HOME%\bin\java.exe"
if not exist ".\properties.xml" goto nolcfhome
rem set MCF_HOME
set MCF_HOME=%CD%
-rem invoke the AgentRun command
-cmd /c "processes\script\executecommand.bat org.apache.manifoldcf.agents.AgentStop"
+rem invoke the AgentStop command
+cmd /c "processes\executecommand.bat org.apache.manifoldcf.agents.AgentStop"
goto done
:nojavahome
echo Environment variable JAVA_HOME is not set properly.
Modified: incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.sh
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.sh?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.sh (original)
+++ incubator/lcf/trunk/framework/example-multiprocess-common/stop-agents.sh Sat Feb 11 07:47:51 2012
@@ -20,7 +20,7 @@ if [ -e "$JAVA_HOME"/bin/java ] ; then
if [ -f ./properties.xml ] ; then
# Set the MCF_HOME variable
export MCF_HOME=$PWD
- processes/script/executecommand.sh org.apache.manifoldcf.agents.AgentStop
+ processes/executecommand.sh org.apache.manifoldcf.agents.AgentStop
exit $?
else
Modified: incubator/lcf/trunk/framework/scripts/executecommand.bat
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/scripts/executecommand.bat?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/scripts/executecommand.bat (original)
+++ incubator/lcf/trunk/framework/scripts/executecommand.bat Sat Feb 11 07:47:51 2012
@@ -21,10 +21,10 @@ rem save existing path here
set OLDDIR=%CD%
cd "%MCF_HOME%\processes"
set CLASSPATH=.
-for %%f in (jar/*) do call script\setclasspath.bat %%f
-for /f "delims=" %%a in ('type %MCF_HOME%\processes\script\options.env') do set JAVAOPTIONS=%%a
+for %%f in (lib/*) do call setclasspath.bat %%f
+for /f "delims=" %%a in ('type %MCF_HOME%\processes\options.env') do set JAVAOPTIONS=%%a
set JAVADEFINES=
-for %%g in (define/*) do call script\setdefine.bat %%g
+for %%g in (define/*) do call setdefine.bat %%g
rem restore old path here
cd "%OLDDIR%"
"%JAVA_HOME%\bin\java" "-Dorg.apache.manifoldcf.configfile=%MCF_HOME%\properties.xml" %JAVAOPTIONS% %JAVADEFINES% -classpath "%CLASSPATH%" %*
Modified: incubator/lcf/trunk/framework/scripts/executecommand.sh
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/scripts/executecommand.sh?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/scripts/executecommand.sh (original)
+++ incubator/lcf/trunk/framework/scripts/executecommand.sh Sat Feb 11 07:47:51 2012
@@ -27,11 +27,11 @@ if [ -e "$JAVA_HOME"/bin/java ] ; then
# Build the classpath
CLASSPATH=""
- for filename in $(ls -1 "$MCF_HOME"/processes/jar) ; do
+ for filename in $(ls -1 "$MCF_HOME"/processes/lib) ; do
if [ -n "$CLASSPATH" ] ; then
- CLASSPATH="$CLASSPATH""$PATHSEP""$MCF_HOME"/processes/jar/"$filename"
+ CLASSPATH="$CLASSPATH""$PATHSEP""$MCF_HOME"/processes/lib/"$filename"
else
- CLASSPATH="$MCF_HOME"/processes/jar/"$filename"
+ CLASSPATH="$MCF_HOME"/processes/lib/"$filename"
fi
done
Modified: incubator/lcf/trunk/framework/scripts/setclasspath.bat
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/framework/scripts/setclasspath.bat?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/framework/scripts/setclasspath.bat (original)
+++ incubator/lcf/trunk/framework/scripts/setclasspath.bat Sat Feb 11 07:47:51 2012
@@ -13,4 +13,4 @@ rem WITHOUT WARRANTIES OR CONDITIONS OF
rem See the License for the specific language governing permissions and
rem limitations under the License.
-set CLASSPATH=%CLASSPATH%;%MCF_HOME%\processes\jar\%1
+set CLASSPATH=%CLASSPATH%;%MCF_HOME%\processes\lib\%1
Modified: incubator/lcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml
URL: http://svn.apache.org/viewvc/incubator/lcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml?rev=1243011&r1=1243010&r2=1243011&view=diff
==============================================================================
--- incubator/lcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml (original)
+++ incubator/lcf/trunk/site/src/documentation/content/xdocs/en_US/how-to-build-and-deploy.xml Sat Feb 11 07:47:51 2012
@@ -137,7 +137,7 @@
<tr><td><em>lock-clean[.sh|.bat]</em></td><td>script to clean up dirty locks (run only when all webapps and processes are stopped)</td></tr>
</table>
<p></p>
- <p>The basic multiprocess command scripts will be placed in the <em>processes/script</em> subdirectory. The script for executing commands is <em>processes/script/executecommand[.sh|.bat]</em>.
+ <p>The basic multiprocess command scripts will be placed in the <em>processes</em> subdirectory. The script for executing commands is <em>processes/executecommand[.sh|.bat]</em>.
This script requires two environment variables to be set before execution: JAVA_HOME, and MCF_HOME, which should point to ManifoldCF's home execution directory, where the <em>properties.xml</em> file is found.)</p>
<section>
<title>Building and testing the Alfresco connector</title>
@@ -407,7 +407,7 @@ cd dist/example
<li>Change directory to <em>dist/multiprocess-example</em>.</li>
<li>Deploy the war files from <em>web/war</em> to your application server.</li>
<li>Set the starting environment variables for your app server to include any -D commands found in <em>web/define</em>. The -D commands should be of the form, "-D<file name>=<file contents>". You will also need a "-Dorg.apache.manifoldcf.configfile=<properties file>" define option, or the equivalent, in the application server's JVM startup in order for ManifoldCF to be able to locate its configuration file.</li>
- <li>Use the <em>processes/script/executecommand[.bat|.sh]</em> command from execute the appropriate commands from the next section below, being sure to first set the JAVA_HOME and MCF_HOME environment variables properly.</li>
+ <li>Use the <em>processes/executecommand[.bat|.sh]</em> command from execute the appropriate commands from the next section below, being sure to first set the JAVA_HOME and MCF_HOME environment variables properly.</li>
<li>Start any supporting processes that result from your build. (Some connectors such as Documentum and FileNet have auxiliary processes you need to run to make these connectors functional.)</li>
<li>Start your application server.</li>
<li>Start the ManifoldCF agents process.</li>
@@ -607,8 +607,10 @@ cd dist/example
<tr><td>org.apache.manifoldcf.authorities.SynchronizeAuthorities</td><td>None</td><td>Un-register all registered authority connector classes that can't be found</td></tr>
</table>
<p></p>
- <p>Remember that you need to include all the jars under <em>dist/processes/jar</em> in the classpath whenever you run one of these commands! You also must include the corresponding -D switches if present, as described earlier. But, luckily, there are scripts which do all of this available. These can be found in <em>dist/processes/script/executecommand[.sh,.bat]</em>.
- The scripts require some environment variables to be set, such as <em>MCF_HOME</em> and <em>JAVA_HOME</em>, and expect the configuration file to be found at <em>MCF_HOME/properties.xml</em>.</p>
+ <p>Remember that you need to include all the jars under <em>dist/multiprocess-example/processes/lib</em> in the classpath whenever you run one of these commands!
+ But, luckily, there are scripts which do this for you. These can be found in <em>dist/multiprocess-example/processes/executecommand[.sh,.bat]</em>.
+ The scripts require some environment variables to be set, such as <em>MCF_HOME</em> and <em>JAVA_HOME</em>, and expect the configuration file to be
+ found at <em>MCF_HOME/properties.xml</em>.</p>
<p></p>
</section>
<section>
@@ -627,9 +629,6 @@ cd dist/example
<p></p>
<p>For each of the application servers involved with ManifoldCF, you must set the following define, so that the ManifoldCF web applications can locate the configuration file:</p>
<p>-Dorg.apache.manifoldcf.configfile=<configuration file path></p>
- <p>Under <em>dist/multiprocess-example/web/define</em>, if it exists at all, you may also see files that are not war files. These files are meant to be used as command-line -D switches for the application server process.
- The switches may or may not be identical for the two web applications, but they will never conflict. You may need to alter environment variables or your application server startup scripts in order to
- provide these switches. Luckily, no existing connectors require these at this time.</p>
<p></p>
</section>
<section>
@@ -645,13 +644,20 @@ cd dist/example
<p></p>
<table>
<tr><th>Connector</th><th>Process</th><th>Main class</th><th>Script name (relative to <em>dist</em>)</th></tr>
- <tr><td>Documentum</td><td>documentum-server-process</td><td>org.apache.manifoldcf.crawler.server.DCTM.DCTM</td><td>documentum-server-process/script/run[.sh|.bat]</td></tr>
- <tr><td>Documentum</td><td>documentum-registry-process</td><td>org.apache.manifoldcf.crawler.registry.DCTM.DCTM</td><td>documentum-registry-process/script/run[.sh|.bat]</td></tr>
- <tr><td>FileNet</td><td>filenet-server-process</td><td>org.apache.manifoldcf.crawler.server.filenet.Filenet</td><td>filenet-server-process/script/run[.sh|.bat]</td></tr>
- <tr><td>FileNet</td><td>filenet-registry-process</td><td>org.apache.manifoldcf.crawler.registry.filenet.Filenet</td><td>filenet-registry-process/script/run[.sh|.bat]</td></tr>
+ <tr><td>Documentum</td><td>documentum-server-process</td><td>org.apache.manifoldcf.crawler.server.DCTM.DCTM</td><td>documentum-server-process/run[.sh|.bat]</td></tr>
+ <tr><td>Documentum</td><td>documentum-registry-process</td><td>org.apache.manifoldcf.crawler.registry.DCTM.DCTM</td><td>documentum-registry-process/run[.sh|.bat]</td></tr>
+ <tr><td>FileNet</td><td>filenet-server-process</td><td>org.apache.manifoldcf.crawler.server.filenet.Filenet</td><td>filenet-server-process/run[.sh|.bat]</td></tr>
+ <tr><td>FileNet</td><td>filenet-registry-process</td><td>org.apache.manifoldcf.crawler.registry.filenet.Filenet</td><td>filenet-registry-process/run[.sh|.bat]</td></tr>
</table>
- <p>The registry process in all cases must be started before the corresponding server process, or the server process will report an error. (It will, however, retry after some period of time.) The scripts all require an MCF_HOME environment variable pointing to the place where properties.xml is found, as well as a JAVA_HOME environment variable pointing the JDK. The server scripts also require other environment variables as well, consistent with the needs of the DFC or the FileNet API respectively. For example, DFC requires the DOCUMENTUM environment variable to be set, while the FileNet server script requires the WASP_HOME environment variable.</p>
- <p>It is important to understand that the scripts work by building a classpath out of all jars that get copied into the <em>jar</em> directory underneath each process during the ant build. These jars come in part from the <em>dfc</em> or <em>filenet-api</em> directories underneath the documentum or filenet connector directories. For the server startup scripts to work properly, therefore, these directories should have <strong>all</strong> of the jars needed to allow the api code to function, and the ant build scripts will take care of the rest.</p>
+ <p>The registry process in all cases must be started before the corresponding server process, or the server process will report an error. (It will, however, retry after some period of time.)
+ The scripts all require an MCF_HOME environment variable pointing to the place where properties.xml is found, as well as a JAVA_HOME environment variable pointing the JDK.
+ The server scripts also require other environment variables as well, consistent with the needs of the DFC or the FileNet API respectively. For example, DFC requires the
+ DOCUMENTUM environment variable to be set, while the FileNet server script requires the WASP_HOME environment variable.</p>
+ <p>It is important to understand that the scripts work by building a classpath out of all jars that get copied into the <em>lib</em> and <em>lib-proprietary</em> directory underneath
+ each process during the ant build. The <em>lib-proprietary</em> jars cannot be distributed in the binary version of ManifoldCF, so if you use this option you will still need to
+ copy them there yourself for the processes to run. If you build ManifoldCF yourself, these jars are copied from the <em>lib-proprietary</em> directories underneath the documentum
+ or filenet connector directories. For the server startup scripts to work properly, the <em>lib-proprietary</em> directories should have <strong>all</strong> of the jars needed to
+ allow the api code to function.</p>
<p></p>
</section>
</section>