abdera-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jmsn...@apache.org
Subject svn commit: r615404 - /incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/
Date Fri, 25 Jan 2008 23:53:20 GMT
Author: jmsnell
Date: Fri Jan 25 15:53:19 2008
New Revision: 615404

URL: http://svn.apache.org/viewvc?rev=615404&view=rev
Log:
javadocs

Modified:
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoriesInfo.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoryInfo.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionAdapter.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionInfo.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Filter.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/FilterChain.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/MediaCollectionAdapter.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Provider.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Target.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Transactional.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceInfo.java
    incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceManager.java

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoriesInfo.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoriesInfo.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoriesInfo.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoriesInfo.java
Fri Jan 25 15:53:19 2008
@@ -19,6 +19,13 @@
 
 import org.apache.abdera.model.Categories;
 
+/**
+ * Metadata interface used by WorkspaceManager and Provider 
+ * implementations to construct Atompub Service Documents.
+ * 
+ * The CategoriesInfo interface provides information used to
+ * construct an app:categories element within an app:collection. 
+ */
 public interface CategoriesInfo 
   extends Iterable<CategoryInfo> {
 

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoryInfo.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoryInfo.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoryInfo.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CategoryInfo.java
Fri Jan 25 15:53:19 2008
@@ -19,6 +19,13 @@
 
 import org.apache.abdera.model.Category;
 
+/**
+ * Metadata interface used by WorkspaceManager and Provider 
+ * implementations to construct Atompub Service Documents.
+ * 
+ * The CategoryInfo interface provides information used to
+ * construct an atom:category element within an app:categories 
+ */
 public interface CategoryInfo {
 
   String getScheme(RequestContext request);

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionAdapter.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionAdapter.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionAdapter.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionAdapter.java
Fri Jan 25 15:53:19 2008
@@ -17,6 +17,13 @@
 */
 package org.apache.abdera.protocol.server;
 
+/**
+ * The CollectionAdapter interface is the component that provides the business
+ * logic of an Atompub server.  The Provider will use it's WorkspaceManager to
+ * determine which CollectionAdapter to dispatch a request to.  Once an adapter
+ * is selected, the Provider will determine what kind of request is being made
+ * and will forward the request on to the appropriate CollectionAdapter method.
+ */
 public interface CollectionAdapter {
 
   ResponseContext postEntry(RequestContext request);
@@ -30,7 +37,12 @@
   ResponseContext getFeed(RequestContext request);
 
   ResponseContext getCategories(RequestContext request);
-  
+
+  /**
+   * Any request that is not covered by the postEntry, deleteEntry, etc
+   * methods will be passed on to the extensionRequest method.  This provides
+   * an Adapter with the ability to support Atompub protocol extensions.
+   */
   ResponseContext extensionRequest(RequestContext request);
   
 }

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionInfo.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionInfo.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionInfo.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/CollectionInfo.java
Fri Jan 25 15:53:19 2008
@@ -19,7 +19,13 @@
 
 import org.apache.abdera.model.Collection;
 
-
+/**
+ * Metadata interface used by WorkspaceManager and Provider 
+ * implementations to construct Atompub Service Documents.
+ * 
+ * The CollectionInfo interface provides information used to
+ * construct an app:collection element 
+ */
 public interface CollectionInfo {
 
   String getHref(RequestContext request);

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Filter.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Filter.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Filter.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Filter.java
Fri Jan 25 15:53:19 2008
@@ -17,6 +17,14 @@
 */
 package org.apache.abdera.protocol.server;
 
+/**
+ * Filters are invoked by AbderaServlet immediately before passing the 
+ * request off to the Provider for processing  The filters use a model
+ * generally identical to that of Servlet Filters, with each filter forwarding
+ * the request on to the next filter in the chain.
+ * @author jasnell
+ *
+ */
 public interface Filter {
   
   ResponseContext filter(RequestContext request, FilterChain chain);

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/FilterChain.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/FilterChain.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/FilterChain.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/FilterChain.java
Fri Jan 25 15:53:19 2008
@@ -20,7 +20,7 @@
 import java.util.Arrays;
 import java.util.Iterator;
 
-public class FilterChain {
+public final class FilterChain {
 
   private final Iterator<Filter> filters;
   private final Provider provider;
@@ -33,7 +33,11 @@
         Arrays.asList(
           provider.getFilters(request)).iterator();
   }
-  
+
+  /**
+   * Invoke the next filter in the chain.  If there are no more filters in 
+   * the chain, pass the request context on to the Provider for processing.
+   */
   public ResponseContext next(RequestContext request) {
     return filters.hasNext() ?
       filters.next().filter(request, this) :

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/MediaCollectionAdapter.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/MediaCollectionAdapter.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/MediaCollectionAdapter.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/MediaCollectionAdapter.java
Fri Jan 25 15:53:19 2008
@@ -17,6 +17,10 @@
 */
 package org.apache.abdera.protocol.server;
 
+/**
+ * Extends CollectionAdapter with methods specific to the handling of 
+ * Atompub Media Link Entries
+ */
 public interface MediaCollectionAdapter 
   extends CollectionAdapter {
 

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Provider.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Provider.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Provider.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Provider.java
Fri Jan 25 15:53:19 2008
@@ -23,7 +23,9 @@
 
 import org.apache.abdera.Abdera;
 
-
+/**
+ * Providers are responsible for processing all requests to the Atompub server.
+ */
 public interface Provider {
   
   void init(Abdera abdera, Map<String,String> properties);
@@ -33,7 +35,7 @@
   String getProperty(String name);
   
   String[] getPropertyNames();
-  
+
   Subject resolveSubject(RequestContext request);
   
   Target resolveTarget(RequestContext request);

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Target.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Target.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Target.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Target.java
Fri Jan 25 15:53:19 2008
@@ -17,6 +17,9 @@
 */
 package org.apache.abdera.protocol.server;
 
+/**
+ * Identifies the target of the request.
+ */
 public interface Target 
   extends Iterable<String> {
 

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Transactional.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Transactional.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Transactional.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/Transactional.java
Fri Jan 25 15:53:19 2008
@@ -19,6 +19,12 @@
 
 import org.apache.abdera.protocol.server.context.ResponseContextException;
 
+/**
+ * CollectionAdapter implementations can implement the Transactional
+ * interface in order to support start/end/compensate behaviors.  Providers 
+ * will invoke the start/end methods before/after calling the appropriate 
+ * CollectionAdapter methods and will call compensate if an error occurs
+ */
 public interface Transactional {
 
   void start(RequestContext request) throws ResponseContextException;

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceInfo.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceInfo.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceInfo.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceInfo.java
Fri Jan 25 15:53:19 2008
@@ -21,6 +21,13 @@
 
 import org.apache.abdera.model.Workspace;
 
+/**
+ * Metadata interface used by WorkspaceManager and Provider 
+ * implementations to construct Atompub Service Documents.
+ * 
+ * The WorkspaceInfo interface provides information used to
+ * construct an app:workspace element 
+ */
 public interface WorkspaceInfo {
 
   String getTitle(RequestContext requsest);

Modified: incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceManager.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceManager.java?rev=615404&r1=615403&r2=615404&view=diff
==============================================================================
--- incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceManager.java
(original)
+++ incubator/abdera/java/branches/server_refactor_all/server/src/main/java/org/apache/abdera/protocol/server/WorkspaceManager.java
Fri Jan 25 15:53:19 2008
@@ -19,7 +19,11 @@
 
 import java.util.Collection;
 
-
+/**
+ * The Workspace Manager is used by a Provider to access metadata used to
+ * construct Atompub service documents and to determine the appropriate
+ * CollectionAdapter to handle a particular request 
+ */
 public interface WorkspaceManager {
     
   CollectionAdapter getCollectionAdapter(RequestContext request);



Mime
View raw message