Author: mduerig
Date: Mon Mar 17 13:39:36 2014
New Revision: 1578365
URL: http://svn.apache.org/r1578365
Log:
- Remove, clarify TODOs
- Update Javadoc, remove out dated Javadoc
- Use common code style in all API classes
Modified:
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
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexStatsMBean.java
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=1578365&r1=1578364&r2=1578365&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
Mon Mar 17 13:39:36 2014
@@ -46,8 +46,8 @@ public interface ContentRepository {
* {@link ContentSession} instance for accessing repository content
* inside the specified workspace as the authenticated user.
* <p/>
- * TODO: Determine whether ContentSessions should cover a single
- * workspace or the entire repository.
+ * TODO clarify workspace handling once multiple workspaces are
+ * supported. See OAK-118.
* <p/>
* The exact type of access credentials is undefined, as this method
* simply acts as a generic messenger between clients and pluggable
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=1578365&r1=1578364&r2=1578365&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
Mon Mar 17 13:39:36 2014
@@ -20,23 +20,9 @@ import java.io.Closeable;
import javax.annotation.Nonnull;
/**
- * Authentication session for accessing (TODO: a workspace inside) a content
- * repository.
- * <p>
- * - retrieving information from persistent layer (MK) that are accessible to
- * a given JCR session
- *
- * - validate information being written back to the persistent layer. this
includes
- * permission evaluation, node type and name constraints etc.
- *
- * - Provide access to authentication and authorization related information
- *
- * - The implementation of this and all related interfaces are intended to only
- * hold the state of the persistent layer at a given revision without any
- * session-related state modifications.
- * <p>
- * TODO: describe how this interface is intended to handle validation:
- * nt, names, ac, constraints...
+ * Authentication session for accessing a content repository.
+ * A {@code ContentSession} provides access to the actual
+ * content through its {@link #getLatestRoot()} method.
* <p>
* This interface is thread-safe.
*/
@@ -54,11 +40,13 @@ public interface ContentSession extends
AuthInfo getAuthInfo();
/**
- * TODO clarify workspace handling
* 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.
+ * <p>
+ * TODO clarify workspace handling once multiple workspaces are
+ * supported. See OAK-118.
*
* @return name of the workspace this instance has been created for or
* {@code null} if this content session is repository bound.
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexStatsMBean.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexStatsMBean.java?rev=1578365&r1=1578364&r2=1578365&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexStatsMBean.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/api/jmx/IndexStatsMBean.java
Mon Mar 17 13:39:36 2014
@@ -28,16 +28,16 @@ public interface IndexStatsMBean {
String STATUS_DONE = "done";
/**
- * @return The time the indexing job stared at, or <code>""</code> if it is
+ * @return The time the indexing job stared at, or {@code ""} if it is
* not currently running.
*/
- public String getStart();
+ String getStart();
/**
- * @return The time the indexing job finished at, or <code>""</code> if it
+ * @return The time the indexing job finished at, or {@code ""} if it
* is still running.
*/
- public String getDone();
+ String getDone();
/**
* Returns the current status of the indexing job
@@ -45,6 +45,6 @@ public interface IndexStatsMBean {
* @return the current status of the indexing job: {@value #STATUS_INIT},
* {@value #STATUS_RUNNING} or {@value #STATUS_DONE}
*/
- public String getStatus();
+ String getStatus();
}
