Return-Path: Delivered-To: apmail-incubator-abdera-commits-archive@locus.apache.org Received: (qmail 82968 invoked from network); 1 Mar 2008 02:27:33 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 1 Mar 2008 02:27:33 -0000 Received: (qmail 69414 invoked by uid 500); 1 Mar 2008 02:27:28 -0000 Delivered-To: apmail-incubator-abdera-commits-archive@incubator.apache.org Received: (qmail 69391 invoked by uid 500); 1 Mar 2008 02:27:28 -0000 Mailing-List: contact abdera-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: abdera-dev@incubator.apache.org Delivered-To: mailing list abdera-commits@incubator.apache.org Received: (qmail 69381 invoked by uid 99); 1 Mar 2008 02:27:28 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 29 Feb 2008 18:27:28 -0800 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 01 Mar 2008 02:26:49 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 2D7C01A9832; Fri, 29 Feb 2008 18:27:09 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r632537 - in /incubator/abdera/java/trunk/adapters: couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/ filesystem/src/main/java/org/apache/abdera/protocol/server/adapters/filesystem/ hibernate/src/main/java/org/apache... Date: Sat, 01 Mar 2008 02:27:08 -0000 To: abdera-commits@incubator.apache.org From: jmsnell@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20080301022709.2D7C01A9832@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: jmsnell Date: Fri Feb 29 18:27:07 2008 New Revision: 632537 URL: http://svn.apache.org/viewvc?rev=632537&view=rev Log: Some basic javadoc comments Modified: incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/CouchDbAdapter.java incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/JsonObjectResponseContext.java incubator/abdera/java/trunk/adapters/filesystem/src/main/java/org/apache/abdera/protocol/server/adapters/filesystem/FilesystemAdapter.java incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/AtomEntryResultTransformer.java incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/HibernateCollectionAdapter.java incubator/abdera/java/trunk/adapters/jcr/src/main/java/org/apache/abdera/protocol/server/adapters/jcr/JcrCollectionAdapter.java incubator/abdera/java/trunk/adapters/jdbc/src/main/java/org/apache/abdera/protocol/server/adapters/ibatis/IBatisCollectionAdapter.java Modified: incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/CouchDbAdapter.java URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/CouchDbAdapter.java?rev=632537&r1=632536&r2=632537&view=diff ============================================================================== --- incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/CouchDbAdapter.java (original) +++ incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/CouchDbAdapter.java Fri Feb 29 18:27:07 2008 @@ -47,6 +47,19 @@ import com.fourspaces.couchdb.Session; import com.fourspaces.couchdb.ViewResults; +/** + * The CouchDB Adapter uses a CouchDB database as the backend storage for + * an Atompub Collection. As an extension of the ManagedCollectionAdapter + * class, the Adapter is intended to be used with implementations of the + * ManagedProvider and are configured using /abdera/adapter/*.properties + * files. By default, the CouchDbAdapter assumes that CouchDB is running + * on localhost on port 5984. The host name and port can be changed by + * setting the couchdb.host and couchdb.port values in the Adapter instance + * *.properties file. + * + * The Adapter uses the Abdera Atom-to-JSON converter to store Collection + * entries as JSON documents in a CouchDB database. + */ public class CouchDbAdapter extends ManagedCollectionAdapter { @@ -92,10 +105,10 @@ try { db = session.getDatabase(name); } catch (Exception e) { - // error if the db is not found, ignore it, we're going to create it - } - if (db == null) + // error if the db is not found, ignore the error, + // we're going to create it db = session.createDatabase(name); + } return db; } Modified: incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/JsonObjectResponseContext.java URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/JsonObjectResponseContext.java?rev=632537&r1=632536&r2=632537&view=diff ============================================================================== --- incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/JsonObjectResponseContext.java (original) +++ incubator/abdera/java/trunk/adapters/couchdb/src/main/java/org/apache/abdera/protocol/server/adapters/couchdb/JsonObjectResponseContext.java Fri Feb 29 18:27:07 2008 @@ -36,6 +36,10 @@ import com.fourspaces.couchdb.Document; +/** + * ResponseContext implementation that serializes a JSON Document from a + * CouchDB database as an Atom document using the Abdera StreamWriter. + */ public class JsonObjectResponseContext extends StreamWriterResponseContext { Modified: incubator/abdera/java/trunk/adapters/filesystem/src/main/java/org/apache/abdera/protocol/server/adapters/filesystem/FilesystemAdapter.java URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/adapters/filesystem/src/main/java/org/apache/abdera/protocol/server/adapters/filesystem/FilesystemAdapter.java?rev=632537&r1=632536&r2=632537&view=diff ============================================================================== --- incubator/abdera/java/trunk/adapters/filesystem/src/main/java/org/apache/abdera/protocol/server/adapters/filesystem/FilesystemAdapter.java (original) +++ incubator/abdera/java/trunk/adapters/filesystem/src/main/java/org/apache/abdera/protocol/server/adapters/filesystem/FilesystemAdapter.java Fri Feb 29 18:27:07 2008 @@ -43,7 +43,12 @@ import org.apache.abdera.protocol.server.provider.managed.ManagedCollectionAdapter; /** - * Simple Filesystem Adapter + * Simple Filesystem Adapter that uses a local directory to store Atompub + * collection entries. As an extension of the ManagedCollectionAdapter + * class, the Adapter is intended to be used with implementations of the + * ManagedProvider and are configured using /abdera/adapter/*.properties + * files. The *.properties file MUST specify the fs.root property to specify + * the root directory used by the Adapter. */ public class FilesystemAdapter extends ManagedCollectionAdapter { Modified: incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/AtomEntryResultTransformer.java URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/AtomEntryResultTransformer.java?rev=632537&r1=632536&r2=632537&view=diff ============================================================================== --- incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/AtomEntryResultTransformer.java (original) +++ incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/AtomEntryResultTransformer.java Fri Feb 29 18:27:07 2008 @@ -18,6 +18,9 @@ import org.apache.commons.logging.LogFactory; import org.hibernate.transform.ResultTransformer; +/** + * Converts Hibernate results into an Atom document using the Abdera Java Object Serializer + */ public class AtomEntryResultTransformer implements ResultTransformer { private static Log logger = LogFactory.getLog(AtomEntryResultTransformer.class); Modified: incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/HibernateCollectionAdapter.java URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/HibernateCollectionAdapter.java?rev=632537&r1=632536&r2=632537&view=diff ============================================================================== --- incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/HibernateCollectionAdapter.java (original) +++ incubator/abdera/java/trunk/adapters/hibernate/src/main/java/org/apache/abdera/protocol/server/adapters/hibernate/HibernateCollectionAdapter.java Fri Feb 29 18:27:07 2008 @@ -28,6 +28,12 @@ import org.hibernate.cfg.Configuration; import org.hibernate.cfg.Environment; +/** + * An adapter implementation that uses Hibernate and a backend database to store + * Atompub collection entries. As an extension of the BasicAdapter, the adapter + * is intended to be used with the BasicProvider and is configured using an + * /abdera/adapter/*.properties file. + */ public class HibernateCollectionAdapter extends BasicAdapter { private static Log logger = LogFactory.getLog(HibernateCollectionAdapter.class); Modified: incubator/abdera/java/trunk/adapters/jcr/src/main/java/org/apache/abdera/protocol/server/adapters/jcr/JcrCollectionAdapter.java URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/adapters/jcr/src/main/java/org/apache/abdera/protocol/server/adapters/jcr/JcrCollectionAdapter.java?rev=632537&r1=632536&r2=632537&view=diff ============================================================================== --- incubator/abdera/java/trunk/adapters/jcr/src/main/java/org/apache/abdera/protocol/server/adapters/jcr/JcrCollectionAdapter.java (original) +++ incubator/abdera/java/trunk/adapters/jcr/src/main/java/org/apache/abdera/protocol/server/adapters/jcr/JcrCollectionAdapter.java Fri Feb 29 18:27:07 2008 @@ -36,7 +36,12 @@ import org.apache.commons.logging.LogFactory; import org.apache.jackrabbit.api.JackrabbitNodeTypeManager; -public class JcrCollectionAdapter extends AbstractEntityCollectionAdapter { +/** + * Adapter implementation that uses a JCR Repository to store Atompub collection + * entries. The adapter is intended to be used with the DefaultProvider implementation. + */ +public class JcrCollectionAdapter + extends AbstractEntityCollectionAdapter { private final static Log log = LogFactory.getLog(JcrCollectionAdapter.class); Modified: incubator/abdera/java/trunk/adapters/jdbc/src/main/java/org/apache/abdera/protocol/server/adapters/ibatis/IBatisCollectionAdapter.java URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/adapters/jdbc/src/main/java/org/apache/abdera/protocol/server/adapters/ibatis/IBatisCollectionAdapter.java?rev=632537&r1=632536&r2=632537&view=diff ============================================================================== --- incubator/abdera/java/trunk/adapters/jdbc/src/main/java/org/apache/abdera/protocol/server/adapters/ibatis/IBatisCollectionAdapter.java (original) +++ incubator/abdera/java/trunk/adapters/jdbc/src/main/java/org/apache/abdera/protocol/server/adapters/ibatis/IBatisCollectionAdapter.java Fri Feb 29 18:27:07 2008 @@ -49,6 +49,11 @@ import com.ibatis.sqlmap.client.SqlMapClient; import com.ibatis.sqlmap.client.SqlMapClientBuilder; +/** + * Adapter that uses IBatis and a database to store Atompub collection entries. + * As an extension to BasicAdapter, the adapter is intended to be used with + * BasicProvider and is configured using /abdera/adapter/*.properties files. + */ public class IBatisCollectionAdapter extends BasicAdapter {