jackrabbit-oak-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ang...@apache.org
Subject svn commit: r1306223 - /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/SessionInfo.java
Date Wed, 28 Mar 2012 09:12:43 GMT
Author: angela
Date: Wed Mar 28 09:12:42 2012
New Revision: 1306223

URL: http://svn.apache.org/viewvc?rev=1306223&view=rev
Log:
OAK-40 : Define session-info like user identification for communication with oak-api (JavaDoc)

Modified:
    jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/SessionInfo.java

Modified: jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/SessionInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/SessionInfo.java?rev=1306223&r1=1306222&r2=1306223&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/SessionInfo.java
(original)
+++ jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/SessionInfo.java
Wed Mar 28 09:12:42 2012
@@ -49,20 +49,21 @@ public interface SessionInfo {
 
     /**
      * Returns the current revision the associated session is operating on.
-     * Upon creation of a given {@code SessionInfo} instance the initial
-     * revision is always set to the head revision. Upon successful commit
-     * of changes the revision is reset to match the latest state.
+     * Unless otherwise specified the revision is set to the current head
+     * revision upon {@code SessionInfo} creation. Later on in the lifecycle
+     * of this {@code SessionInfo} the revision will be reset to match the
+     * latest state after successful commit of modifications or if the associated
+     * session is being refreshed.
      *
-     * TODO: define how the desired initial revision is passed to the oak-api / mk
-     * TODO: define how and when the revision is updated (would a setRevision required? and
who would use it?)
-     * TODO: define default value (head-revision?)
-     *
-     * @return the revision.
+     * @return the revision The current revision.
      */
     String getRevision();
 
     /**
-     * The immutable name of the workspace this instance has been created for.
+     * The immutable name of the workspace this {@code SessionInfo} 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.
      */



Mime
View raw message