Author: doll
Date: Mon Apr 21 07:04:01 2008
New Revision: 650149
URL: http://svn.apache.org/viewvc?rev=650149&view=rev
Log:
Did my best to update all of the READMEs with the new instructions for building
and running the various java servers.
Added:
incubator/shindig/trunk/java/README
incubator/shindig/trunk/java/server/README
incubator/shindig/trunk/java/social-api/README
- copied, changed from r650124,
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/README
Removed:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/README
Modified:
incubator/shindig/trunk/README
incubator/shindig/trunk/java/gadgets/README
incubator/shindig/trunk/javascript/README
incubator/shindig/trunk/site/index.html
Modified: incubator/shindig/trunk/README
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/README?rev=650149&r1=650148&r2=650149&view=diff
==============================================================================
--- incubator/shindig/trunk/README (original)
+++ incubator/shindig/trunk/README Mon Apr 21 07:04:01 2008
@@ -1,13 +1,12 @@
Welcome to Apache Shindig!
-* Read java/gadgets/README for instructions on how to start up your own
- Shindig Gadget Server.
+* Read java/README for instructions on using the java gadget servers.
+
+* Read php/gadgets/README for instructions on how to run a php gadget server
+ instead of a java gadget server.
* Read javascript/README for instructions for using the Shindig Gadget
Container JavaScript to enable your page to render Gadgets using
gmodules.com or a server started up as described above.
-
-* Read php/gadgets/README for instructions on how to run a php gadget server
- instead of a java gadget server
For more information, see http://incubator.apache.org/projects/shindig.html
Added: incubator/shindig/trunk/java/README
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/README?rev=650149&view=auto
==============================================================================
--- incubator/shindig/trunk/java/README (added)
+++ incubator/shindig/trunk/java/README Mon Apr 21 07:04:01 2008
@@ -0,0 +1,11 @@
+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/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/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=650149&r1=650148&r2=650149&view=diff
==============================================================================
--- incubator/shindig/trunk/java/gadgets/README (original)
+++ incubator/shindig/trunk/java/gadgets/README Mon Apr 21 07:04:01 2008
@@ -6,33 +6,19 @@
2) Make sure the JAVA_HOME environment variable is set to the location of your
JDK/JRE, and that the maven executable is in your PATH.
+3) From java/...
+ * mvn package - Builds all of the java classes including the Gadget Server
and runs
+ tests. Useful also when you need first to obtain an export sources-jar,
+ e.g. for remote debugging with Eclipse.
+
3) From java/gadgets/...
- * mvn package - Builds Gadget Server and runs tests. Useful also when you
need first to obtain and
- export sources-jar, e.g. for remote debugging with Eclipse.
* mvn jetty:run - Builds Gadget Server (no tests), installs Servlet at
localhost:8080.
- To run on a different port, use: mvn -Djetty.port=<port> jetty:run
- * mvn jetty:run-war - If you want to use the sample container or use any of
- the sample files you need to run in this mode. Also, mvn
jetty:run-exploded can work.
+ * mvn jetty:run-war - If you want to use any of the sample files you need
to run
+ in this mode. Also, mvn jetty:run-exploded can work.
4) Hit 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
-
-
-Running your own data in the OpenSocial Servlet
-===============================================
-
-1) By default the opensocial samplecontainer is run, reading initial data from
the sample files.
-
-2) Get some debugging. As a minumum, Eclipse with the usual instructions for
external debugging with
- maven will do. Get also some way to type javascript inside a gadget. For
instance you
- can try the gadget coderunner.xml from
http://opensocial-resources.googlecode.com/
-
-3) Learn how to inject separate services por People, Activities and Data. The
injection is done
- via Guice. Check the file DefaultGuiceModule.java in the src/ hierarchy.
Check the code
- in the social/samplecontainer/ and social/opensocial/. Try to write a
BasicPeopleService
- or a BasicActivitiesService.
-
-4) Inject your services by importing them into the GuiceModule.
+ 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
Added: incubator/shindig/trunk/java/server/README
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/server/README?rev=650149&view=auto
==============================================================================
--- incubator/shindig/trunk/java/server/README (added)
+++ incubator/shindig/trunk/java/server/README Mon Apr 21 07:04:01 2008
@@ -0,0 +1,24 @@
+Installing and running both servers
+============================================
+
+In order to use the samplecontainer you will need to have both the gadget
+rendering server and the social data server running under the same url path.
+The easiest way to do this is to build the java/server package:
+
+1) Install Maven 2.0 (see http://maven.apache.org)
+
+2) Make sure the JAVA_HOME environment variable is set to the location of your
+ JDK/JRE, and that the maven executable is in your PATH.
+
+3) From java/...
+ * mvn package - Builds all of the java classes and runs tests. Useful also
when you
+ need first to obtain an export sources-jar, e.g. for remote debugging with
Eclipse.
+
+3) From java/server/...
+ * mvn jetty:run-war - Builds both servers and installs servlet at
localhost:8080.
+ - To run on a different port, use: mvn -Djetty.port=<port> jetty:run-war
+
+4) Hit server at
http://localhost:<port>/gadgets/files/samplecontainer/samplecontainer.html
+
+
+For more information, see http://incubator.apache.org/projects/shindig.html
Copied: incubator/shindig/trunk/java/social-api/README (from r650124,
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/README)
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/README?p2=incubator/shindig/trunk/java/social-api/README&p1=incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/README&r1=650124&r2=650149&rev=650149&view=diff
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/README
(original)
+++ incubator/shindig/trunk/java/social-api/README Mon Apr 21 07:04:01 2008
@@ -1,13 +1,40 @@
-Using the GadgetDataServlet and integrating with Shindig's OpenSocial code
+Installing and running the server
+============================================
+
+1) Install Maven 2.0 (see http://maven.apache.org)
+
+2) Make sure the JAVA_HOME environment variable is set to the location of your
+ JDK/JRE, and that the maven executable is in your PATH.
+
+3) From java/...
+ * mvn package - Builds all of the java classes including the social data
server and runs
+ tests. Useful also when you need first to obtain an export sources-jar,
+ e.g. for remote debugging with Eclipse.
+
+3) From java/social-api/...
+ * mvn jetty:run - Builds social data server (no tests), installs servlet at
localhost:8080.
+ - To run on a different port, use: mvn -Djetty.port=<port> jetty:run
+
+4) 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.
+
+
+For more information, see http://incubator.apache.org/projects/shindig.html
+
+
+
+Explanation of the current setup of the OpenSocial server code
===========================================================================
+From within java/social-api/src/main/java/org/apache/shindig/social/...
+
=== Directories:
*.java - classes necessary for handling all json data requests made from
javascript. These calls can be the OpenSocial spec defined ones
(handled by the opensocial directory) or any custom calls that the
javascript needs the server to handle (see the
samplecontainer/StateFileDataHandler for an example)
- opensocial/* - provides the OpenSocialDataHandler and all dependant
OpenSocial
+ opensocial/* - provides the OpenSocialDataHandler and all dependent
OpenSocial
related classes
samplecontainer/* - provides the SampleContainer implementation that Shindig
uses by default. If you are creating your own container it is best to
@@ -19,7 +46,7 @@
=== Main servlet: GadgetDataServlet
-This servlet handles all requests to the socialdata url. These
+This servlet handles all requests to the social/data url. These
requests are expected to post two items of information, "st" which should map
to
a gadget token and "request" which should be stringified json.
@@ -54,7 +81,7 @@
json details:
--------- Note: This is all subject to change! More information below. --------
+-------- Note: This will eventually switch to the RESTful apis. More
information below. --------
FETCH_PEOPLE
incoming json:
@@ -111,9 +138,11 @@
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.
+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 reccomended that
+If you wish to use Shindig to support OpenSocial it is highly recommended that
you implement the Service interfaces. This will isolate you from json wire
format changes.
@@ -131,4 +160,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.
\ No newline at end of file
+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.
\ No newline at end of file
Modified: incubator/shindig/trunk/javascript/README
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/javascript/README?rev=650149&r1=650148&r2=650149&view=diff
==============================================================================
--- incubator/shindig/trunk/javascript/README (original)
+++ incubator/shindig/trunk/javascript/README Mon Apr 21 07:04:01 2008
@@ -2,7 +2,7 @@
=========================================
1) Try out the samples.
- A) Set up your own Shindig Gadget Server. See its README for details.
+ A) Set up your own Shindig Gadget Server. See java/README for details.
B) Assuming your server is running on http://yourserver:yourport/gadgets/...
you can hit these html files in your favorite browser to see your local
@@ -71,7 +71,7 @@
and supporting UserPrefs storage.
4) Run the opensocial sample container
- A) Set up your own Shindig Gadget Server. See its README for details. (If
you
+ A) Set up your own Shindig Gadget Server. See java/README for details. (If
you
are using the java based server make sure you run with mvn jetty:run-war)
B) Hit the sample container at
@@ -80,7 +80,7 @@
C) See the sample container help document for more details on how it works:
http://yourserver:yourport/gadgets/files/samplecontainer/getting-started.html
- D) Get, and try to run, coderunner.xml and compliancetest.xml from the
project
+ D) Get, and try to run, coderunner.xml and compliancetests.xml from the
project
http://opensocial-resources.googlecode.com/
Modified: incubator/shindig/trunk/site/index.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/site/index.html?rev=650149&r1=650148&r2=650149&view=diff
==============================================================================
--- incubator/shindig/trunk/site/index.html (original)
+++ incubator/shindig/trunk/site/index.html Mon Apr 21 07:04:01 2008
@@ -144,7 +144,7 @@
</li><li><b>OpenSocial Container JavaScript</b> -- JavaScript environment
that sits on top of the Gadget Container JavaScript and provides OpenSocial
specific functionality (profiles, friends, activities, datastore).</li>
- <li><b>OpenSocial Gateway Server</b> (does not yet exist in the
repository) -- an implementation of the server interface to container-specific
+ <li><b>OpenSocial Data Server</b> -- an implementation of the server
interface to container-specific
information, including the OpenSocial REST APIs, with clear extension points
so others can connect it to their own backends.</li> </ul> <p></p>
</div>
@@ -206,17 +206,18 @@
<ol>
<li> Make sure you have the <a href="#preReqs">prerequisites</a> installed
first.</li>
- <li> <code>cd ~/src/shindig/java/\gadgets</code></li>
+ <li> <code>cd ~/src/shindig/java/</code></li>
<li> <code>mvn package</code></li>
<li>
Once the build successfully completes, you can install the built WAR
-file (gadgets.war) located in the /target subdirectory onto your JEE
+files located in the /target subdirectory onto your JEE
server.</li>
</ol>
- <p>To build the code (with no tests) and start a Jetty server that will run
on at localhost:8080: </p>
+ <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>
</ul><p></p>
@@ -268,7 +269,7 @@
</li><li> File -> New -> Java Project
<ol><li> Select 'Create project from existing source' and navigate to:<br>
- ~/src/shindig/java/gadgets
+ ~/src/shindig/java
</li><li> Click Finish
</li><li> If you see a dialog for "Open Associated Perspective", click Ok.
Don't worry about the errors after loading as they will be fixed in the next
step.
@@ -290,7 +291,7 @@
</p><h4><font size="3"><a name="Running_inside_Eclipse"> Running inside
Eclipse </a></font></h4>
<p>
- To debug the server in Eclipse, follow the last two steps <a
href="http://www.google.com/url?sa=D&q=http%3A%2F%2Fcwiki.apache.org%2FWICKET%2Fmaven-jetty-plugin.html";
target="_top">here</a> (takes a few
+ To debug the server in Eclipse, follow the last two steps <a
href="http://cwiki.apache.org/WICKET/maven-jetty-plugin.html";
target="_top">here</a> (takes a few
minutes to set up):
</p><p>
</p><ul><li> "Using eclipse external tools"
@@ -314,10 +315,11 @@
</li></ol>
<p>To see the cajoled code (Firefox only), right-click inside the iframe and
do "This Frame -> View Frame Source"</p>
- <h3><a name="Additonal_reading"> Additonal reading </a></h3>
- Read <a
href="http://svn.apache.org/repos/asf/incubator/shindig/trunk/java/gadgets/README";>java/gadgets/README</a>
for original instructions on
-how to start up your own Shindig Gadget Server.
+ <h3><a name="Additonal_reading"> Additional reading </a></h3>
+ Read <a
href="http://svn.apache.org/repos/asf/incubator/shindig/trunk/java/README";>java/README</a>
for original instructions on how to start up any of the java shindig servers.
<p>
+ Read <a
href="http://svn.apache.org/repos/asf/incubator/shindig/trunk/php/README";>php/README</a>
for original instructions on how to start up the php shindig server.
+ <p>
Read <a
href="http://svn.apache.org/repos/asf/incubator/shindig/trunk/javascript/README";>javascript/README</a>
for instructions for using the
Shindig Gadget
Container JavaScript to enable your page to render Gadgets using
