svn commit: r1328945 - in /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api: AuthInfo.java CommitFailedException.java ContentRepository.java ContentSession.java

[md...@apache.org]

Author: mduerig
Date: Sun Apr 22 19:35:18 2012
New Revision: 1328945

URL: http://svn.apache.org/viewvc?rev=1328945&view=rev
Log:
OAK-18: Define Oak API 
update Javadoc to reflect new interface names

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/AuthInfo.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/CommitFailedException.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentRepository.java
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentSession.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/AuthInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/AuthInfo.java?rev=1328945&r1=1328944&r2=1328945&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/AuthInfo.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/AuthInfo.java Sun Apr 22 19:35:18 2012
@@ -18,7 +18,7 @@ package org.apache.jackrabbit.oak.api;
 
 /**
  * {@code AuthInfo} instances provide access to information related
- * to authentication and authorization of a given connection.
+ * to authentication and authorization of a given content session.
  * {@code AuthInfo} instances are guaranteed to be immutable.
  */
 public interface AuthInfo {

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/CommitFailedException.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/CommitFailedException.java?rev=1328945&r1=1328944&r2=1328945&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/CommitFailedException.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/CommitFailedException.java Sun Apr 22 19:35:18 2012
@@ -17,7 +17,7 @@
 package org.apache.jackrabbit.oak.api;
 
 /**
- * Main exception thrown by methods defined on the {@code Connection} interface
+ * Main exception thrown by methods defined on the {@code ContentSession} interface
  * indicating that committing a given set of changes failed.
  *
  * TODO: define mechanism to inform the oak-jcr level about the specific type of exception

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentRepository.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentRepository.java?rev=1328945&r1=1328944&r2=1328945&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentRepository.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentRepository.java Sun Apr 22 19:35:18 2012
@@ -20,7 +20,7 @@ import javax.jcr.NoSuchWorkspaceExceptio
 import javax.security.auth.login.LoginException;
 
 /**
- * Oak content repository. The repository may local or remote, or a cluster
+ * Oak content repository. The repository may be local or remote, or a cluster
  * of any size. These deployment details are all hidden behind this interface.
  * <p>
  * All access to the repository happens through authenticated

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentSession.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentSession.java?rev=1328945&r1=1328944&r2=1328945&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentSession.java (original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/ContentSession.java Sun Apr 22 19:35:18 2012
@@ -46,7 +46,7 @@ public interface ContentSession extends 
 
     /**
      * This methods provides access to information related to authentication
-     * and authorization of this connection. Multiple calls to this method
+     * and authorization of this content session. Multiple calls to this method
      * may return different instances which are guaranteed to be equal wrt.
      * to {@link Object#equals(Object)}.
      *
@@ -55,18 +55,18 @@ public interface ContentSession extends 
     AuthInfo getAuthInfo();
 
     /**
-     * The immutable name of the workspace this {@code Connection} instance has
+     * The name of the workspace this {@code ContentSession} instance has
      * been created for. If no workspace name has been specified during
      * repository login this method will return the name of the default
      * workspace.
      *
      * @return name of the workspace this instance has been created for or
-     * {@code null} if this connection is repository bound.
+     * {@code null} if this content session is repository bound.
      */
     String getWorkspaceName();
 
     /**
-     * Refresh this connection to the latest revision of the underlying Microkernel.
+     * Refresh this content session to the latest revision of the underlying Microkernel.
      */
     void refresh();