Author: ieb
Date: Wed Jul 23 05:50:31 2008
New Revision: 679081
URL: http://svn.apache.org/viewvc?rev=679081&view=rev
Log:
Added limited package documentation.
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/config/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/container/package.html
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/service/package.html
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/config/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/config/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/config/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/config/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>Core configuration</h1>
+<p>This package contains core configuration classes for Guice to
+construct the Social API component. Implementors may want to override
+modules in this package</p>
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/model/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,17 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>Core Social Model</h1>
+<p>Default implementations of the Social Model. Implementors my want
+to extend these classes, however the rest of the code should not bind
+directly to these classes, but should bind to the interfaces in
+o.a.s.social.opensocial.model, if this is observed, then implementors
+will also be free to provide their own implementations of the the model
+interfaces.</p>
+
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/oauth/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>The Core Social OAuth package</h1>
+<p>Provides implementations of the OAuth infrastructure for the
+Social component.</p>
+
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/core/util/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>Core Utilities package</h1>
+<p>Utilities used by core packages.</p>
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/model/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,12 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>The Social Model API package</h1>
+<p>Model interfaces that are used throughout the Social Component to transfer
the model. Implementors may implement these interfaces to contain their model
objects.
+</p>
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/oauth/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,14 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>The Social OAuth API package</h1>
+<p>OAth interfaces that are used throughout the Social Component to
+manage OAuth assertions. Although these interfaces are exposed in the
+opensocial layer, its unlikely that implementors will provide their own
+implementations.</p>
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/service/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>The Social Service API package</h1>
+<p>Service classes and interfaces that bind to the HTTP transport
+and provide routing and handling of the REST requests. Containers may
+extend the DataServiceServlet and other classes.</p>
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/opensocial/spi/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,15 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>The Social Service Provider Interface package</h1>
+<p>Interface and supporting classes that specify the service
+provider interface between Shindig and the deployed SNS infrastructure.
+Implementors will almost certainly want to implement their own versions
+of these services and override the @ImplementedBy Guice annotations by
+providing their own Guice module.</p>
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,29 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>The Social API package</h1>
+<p>Shared API classes and interfaces used by both the back end (spi)
+and front end (service).</p>
+<p>The Social Jar consists of a core set of packages that contain
+the lower level implementation of the component (o.a.s.social.core), and
+a set interface layers (o.a.s.social.opensocial) that represent areas of
+the component that are more outward facing. In addition there is a
+sample package which contains sample implementations of the service and
+spi.</p>
+<h2>Opensocial</h2>
+<p>This package contains classes that are outward facing, there are
+4 main areas.
+<ul>
+ <li><b>model</b> the model interfaces underlying the Opensocial
+ implementation</li>
+ <li><b>oath</b> the OAuth interfaces used inside the Opensocial
+ implementation</li>
+ <li><b>service</b> the HTTP facing service interface</li>
+ <li><b>spi</b> the Service Provider Interfaces</li>
+</ul>
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/container/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/container/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/container/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/container/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>Sample Container package</h1>
+<p>Support classes for a simple sample container.</p>
+</body>
+</html>
\ No newline at end of file
Added:
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/service/package.html
URL:
http://svn.apache.org/viewvc/incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/service/package.html?rev=679081&view=auto
==============================================================================
---
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/service/package.html
(added)
+++
incubator/shindig/trunk/java/social-api/src/main/java/org/apache/shindig/social/sample/service/package.html
Wed Jul 23 05:50:31 2008
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Social Package</title>
+</head>
+<body>
+<h1>Sample SPI implementation</h1>
+<p>A Sample implementation of the SPI, using a JSON DB
+implementation. This container is used for end to end testing of the
+Social API</p>
+</body>
+</html>
\ No newline at end of file
