You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shindig.apache.org by do...@apache.org on 2008/05/05 16:51:33 UTC
svn commit: r653495 - in /incubator/shindig/trunk: BUILD-JAVA java/README
java/gadgets/README java/gadgets/src/main/webapp/WEB-INF/web.xml
java/server/README java/social-api/README
java/social-api/src/main/webapp/WEB-INF/web.xml site/index.html
Author: doll
Date: Mon May 5 07:51:33 2008
New Revision: 653495
URL: http://svn.apache.org/viewvc?rev=653495&view=rev
Log:
Small cleanups related to the build change.
- fixed up some readmes
- changed our site to reflect the new process
- deleted the unnecessary web.xml files
Removed:
incubator/shindig/trunk/java/gadgets/src/main/webapp/WEB-INF/web.xml
incubator/shindig/trunk/java/social-api/src/main/webapp/WEB-INF/web.xml
Modified:
incubator/shindig/trunk/BUILD-JAVA
incubator/shindig/trunk/java/README
incubator/shindig/trunk/java/gadgets/README
incubator/shindig/trunk/java/server/README
incubator/shindig/trunk/java/social-api/README
incubator/shindig/trunk/site/index.html
Modified: incubator/shindig/trunk/BUILD-JAVA
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/BUILD-JAVA?rev=653495&r1=653494&r2=653495&view=diff
==============================================================================
--- incubator/shindig/trunk/BUILD-JAVA (original)
+++ incubator/shindig/trunk/BUILD-JAVA Mon May 5 07:51:33 2008
@@ -1,4 +1,4 @@
-Installing and running the java server
+Installing and running the various java servers
============================================
1) Install Maven 2.0 (see http://maven.apache.org)
@@ -7,16 +7,18 @@
JDK/JRE, and that the maven executable is in your PATH.
3) From the base source directory ( eg cd .. )
- * mvn - Cleans the source tree and then builds all the java classes, packages them into jars
- and installs them in your local repository also adds source jars ( by default ~/.m2/repository on Unix/OSX)
+ * mvn - Cleans the source tree and then builds all the java classes, packages
+ them into jars and installs them in your local repository also adds source
+ jars ( by default ~/.m2/repository on Unix/OSX)
* mvn install - does the above but does not clean first
* mvn -Psocial - builds only the social parts
* mvn -Pgadgets - builds only the gadget parts
-
- You must perform at least a "mvn" to place build all the artifacts and place them in you local
- maven repository.
-
-4) To Run, using a embedded Jetty Webapp container, in the base project directory (eg cd .. )
+
+ You must perform at least a "mvn" to place build all the artifacts and place
+ them in you local maven repository.
+
+4) To Run, using a embedded Jetty Webapp container, in the base project
+ directory (eg cd .. )
* First do a full build as in step 3
* mvn -Prun - to run Jetty with both social and gadgets
* mvn -Prun -DrunType=gadgets - to run Jetty with only the gadgets server
@@ -26,8 +28,11 @@
* cd java/server
* mvn clean install jetty:run -DrunType=<full|gadgets|social> -Djetty.port=<port>
-6) Once running, this url http://localhost:<port>/social/data will accept POST requests
- to update or fetch data. In order to see this code in action follow the README in java/server.
+6) Once running, you can test the gadget rendering server by hitting this url:
+ http://localhost:8080/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
+
+ Or you can take a look at the sample container here:
+ http://localhost:8080/gadgets/files/samplecontainer/samplecontainer.html
---------------------------------------------
@@ -36,36 +41,34 @@
1) Start Eclipse to create a workspace
-2) Set the M2_REPO environment variable
- either
+2) Set the M2_REPO environment variable. You can either run a command
+
+ mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo
- mvn -Declipse.workspace=<path-to-eclipse-workspace> eclipse:add-maven-repo
+ or edit the preference directly
- or
-
- In Eclipse edit the Preferences->Java->Build->Classpath Variables and point create M2_REPO to
- point to ~/.m2/repository (Unix) or whereever you local maven repositroy is
+ In Eclipse edit the Preferences->Java->Build->Classpath Variables and
+ create or change M2_REPO to point to the ~/.m2/repository (Unix) or
+ wherever your local maven repositroy is.
-3) In the project base directory
-
- mvn eclipse:eclipse
+3) In the project base directory run
- if you want all the Source files for all the dependencies do
+ mvn eclipse:eclipse
- mvn eclipse:eclipse -DdownloadSources=true
+ Or, if you want the source files for all of the dependencies you can also add
+ the downloadSources flag
+ mvn eclipse:eclipse -DdownloadSources=true
-4) In Eclipse
+4) In Eclipse import the new project in the File->Import->Existing Project menu.
- Import new project with File->Import->Existing Project
-NB.
-At the moment, you will have to edit the source dependencies to remove nested folders.
-On each project, edit properties, Build Path, Source and remove missing Source folders.
+Note: At the moment, you will have to edit the source dependencies to remove
+nested folders. On each project, edit properties, Build Path, Source and remove
+missing Source folders.
-There is a BUG report MECLIPSE-444 reporting this to maven-eclipse-plugin.
+There is a maven-eclipse-plugin bug tracking this issue in MECLIPSE-444.
-
For more information, see http://incubator.apache.org/projects/shindig.html
Modified: incubator/shindig/trunk/java/README
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/java/README?rev=653495&r1=653494&r2=653495&view=diff
==============================================================================
--- incubator/shindig/trunk/java/README (original)
+++ incubator/shindig/trunk/java/README Mon May 5 07:51:33 2008
@@ -1,11 +1,15 @@
There are four parts to the java gadget servers:
-* java/common The common java code that both the social data server and the gadget rendering server rely on.
+* java/common The common java code that both the social data server and the
+ gadget rendering server rely on.
* java/gadgets This server is used for rendering gadgets.
-* java/social-api This server is used to provide social data for gadgets. Long term, it will implement the OpenSocial RESTful apis.
+* java/social-api This server is used to provide social data for gadgets. Long
+ term, it will implement the OpenSocial RESTful apis.
-* java/server This directory only contains a pom and a web.xml file. It is used to run both the gadget rendering code and the social data code at once. In order to use the samplecontainer you must run this server.
+* java/server This directory only contains a pom and a web.xml file. It is used
+ to run both the gadget rendering code and the social data code at once. In
+ order to use the samplecontainer you must run this server.
For more information, see http://incubator.apache.org/projects/shindig.html
Modified: incubator/shindig/trunk/java/gadgets/README
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/java/gadgets/README?rev=653495&r1=653494&r2=653495&view=diff
==============================================================================
--- incubator/shindig/trunk/java/gadgets/README (original)
+++ incubator/shindig/trunk/java/gadgets/README Mon May 5 07:51:33 2008
@@ -1,12 +1,12 @@
Installing and Running Shindig Gadget Server
============================================
-Please see the BUILD-JAVA readme in the base source directory.
+Please see BUILD-JAVA in the base project directory for information.
-Once the server is running.
-
-Hit the server at http://localhost:<port>/gadgets/ifr?url=<gadget-url>
- Example: http://localhost:<port>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
+Once the server is running, you can hit the server at
+http://localhost:<port>/gadgets/ifr?url=<gadget-url>
+
+Example: http://localhost:<port>/gadgets/ifr?url=http://www.labpixies.com/campaigns/todo/todo.xml
For more information, see http://incubator.apache.org/projects/shindig.html
Modified: incubator/shindig/trunk/java/server/README
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/java/server/README?rev=653495&r1=653494&r2=653495&view=diff
==============================================================================
--- incubator/shindig/trunk/java/server/README (original)
+++ incubator/shindig/trunk/java/server/README Mon May 5 07:51:33 2008
@@ -1,10 +1,10 @@
Installing and running both servers
============================================
-This is an example server setup containing web.xml files to do both
-the gadgets service, the social-api or just one service.
+This is an example server setup containing web.xml files to run
+the gadget rendering and social-api services together or separately.
-Please see BUILD-JAVA is the project base directory.
+Please see BUILD-JAVA in the base project directory for information.
For more information, see http://incubator.apache.org/projects/shindig.html
Modified: incubator/shindig/trunk/java/social-api/README
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/README?rev=653495&r1=653494&r2=653495&view=diff
==============================================================================
--- incubator/shindig/trunk/java/social-api/README (original)
+++ incubator/shindig/trunk/java/social-api/README Mon May 5 07:51:33 2008
@@ -1,10 +1,9 @@
Installing and running the server
============================================
+Please see BUILD-JAVA in the base project directory for information.
-Please see BUILD-JAVA in the base source directory.
-
-Once running, this url http://localhost:<port>/social/data will accept POST requests
+Once running, this url http://localhost:<port>/social/data will accept POST requests
to update or fetch data. In order to see this code in action follow the README in java/server.
@@ -127,8 +126,8 @@
subject to change as it is solely for the purpose of communicating between the
Shindig javascript and the Shindig java classes. Shindig will always be
compatible with itself and will not commit to staying constant for outside
-dependencies. Note: soon, all of this code will change to only support the
-RESTful api wire format. Both the javascript and the java code will be updated
+dependencies. Note: soon, all of this code will change to only support the
+RESTful api wire format. Both the javascript and the java code will be updated
when that happens.
If you wish to use Shindig to support OpenSocial it is highly recommended that
@@ -149,6 +148,6 @@
samplecontainer/Basic*Service files.
You should provide your own implementations of these files to fetch data from a
-database or an existing service, or some other storage mechanism. You can hook in
-your own implementations of these interfaces by providing your own Guice module
+database or an existing service, or some other storage mechanism. You can hook in
+your own implementations of these interfaces by providing your own Guice module
in the web.xml file.
Modified: incubator/shindig/trunk/site/index.html
URL: http://svn.apache.org/viewvc/incubator/shindig/trunk/site/index.html?rev=653495&r1=653494&r2=653495&view=diff
==============================================================================
--- incubator/shindig/trunk/site/index.html (original)
+++ incubator/shindig/trunk/site/index.html Mon May 5 07:51:33 2008
@@ -206,8 +206,8 @@
<ol>
<li> Make sure you have the <a href="#preReqs">prerequisites</a> installed first.</li>
- <li> <code>cd ~/src/shindig/java/</code></li>
- <li> <code>mvn package</code></li>
+ <li> <code>cd ~/src/shindig/</code></li>
+ <li> <code>mvn</code></li>
<li>
Once the build successfully completes, you can install the built WAR
@@ -217,13 +217,14 @@
<p>To run the code and start a Jetty server that will run on at localhost:8080: </p>
<p></p><ul>
- <li><code>cd server</code></li>
- <li><code>mvn jetty:run-war</code></li>
+ <li><code>mvn -Prun</code></li>
</ul><p></p>
<p> To run the Jetty server on a different port, use:</p>
- <p></p><ul><li><code>mvn -Djetty.port=<port> jetty:run</code></li></ul><p></p>
-
+ <ul>
+ <li><code>cd java/server</code></li>
+ <li><code>mvn clean install jetty:run -DrunType=<full|gadgets|social> -Djetty.port=<port></code></li>
+ </ul>
<p>
Once you've either installed the WAR file on your JEE server, or are
running locally using the Jetty server, you can test the Gadget server
@@ -277,9 +278,9 @@
</li><li> Right-click the project, select <code>Maven : Enable Dependency Management</code>
</li><li> Right-click the project, select <code>Maven : Update Source Folders</code>
- </li><li> Optionally, if you would like to be able to browse or step into the code of your dependent
- jars when debugging, you need the source jars. Right-click the project, select
- <code>Maven : Download Sources</code> and Eclipse will automatically know about
+ </li><li> Optionally, if you would like to be able to browse or step into the code of your dependent
+ jars when debugging, you need the source jars. Right-click the project, select
+ <code>Maven : Download Sources</code> and Eclipse will automatically know about
these sources when debugging. You can browse them under <code>Maven Dependencies</code> in your project.
</li>
</li></ol>
@@ -422,7 +423,7 @@
<p>
</p><ul>
<li>To subscribe to the Shindig mailing list, send a blank email to <a href="mailto:shindig-dev-subscribe@incubator.apache.org">shindig-dev-subscribe@incubator.apache.org</a></li>
-<li>The email archives are located at:
+<li>The email archives are located at:
<ul>
<li><a href="http://mail-archives.apache.org/mod_mbox/incubator-shindig-dev/">http://mail-archives.apache.org/mod_mbox/incubator-shindig-dev/</a></li>
<li><a href="http://shindig-dev.markmail.org/">http://shindig-dev.markmail.org/</a></li>