You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by ma...@apache.org on 2019/08/08 20:07:13 UTC
svn commit: r1864732 -
/jackrabbit/branches/2.18/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/JackrabbitValueFactory.java
Author: mattryan
Date: Thu Aug 8 20:07:13 2019
New Revision: 1864732
URL: http://svn.apache.org/viewvc?rev=1864732&view=rev
Log:
JCR-4463: Update JavaDoc for completeBinaryUpload describing method idempotency.
Modified:
jackrabbit/branches/2.18/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/JackrabbitValueFactory.java
Modified: jackrabbit/branches/2.18/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/JackrabbitValueFactory.java
URL: http://svn.apache.org/viewvc/jackrabbit/branches/2.18/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/JackrabbitValueFactory.java?rev=1864732&r1=1864731&r2=1864732&view=diff
==============================================================================
--- jackrabbit/branches/2.18/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/JackrabbitValueFactory.java (original)
+++ jackrabbit/branches/2.18/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/JackrabbitValueFactory.java Thu Aug 8 20:07:13 2019
@@ -171,6 +171,15 @@ public interface JackrabbitValueFactory
* If the {@code uploadToken} is unreadable or invalid,
* an {@link IllegalArgumentException} will be thrown.
*
+ * This method is idempotent. Calling the method more than one time with the
+ * same upload token must not cause an existing binary to be modified; thus
+ * if a prior call with this upload token succeeded in creating the binary,
+ * subsequent calls with the same upload token have no effect on the binary.
+ * This method should always return the binary that was uploaded with this
+ * upload token, even in subsequent calls with the same upload token
+ * (in other words, calling this method twice with the same upload token
+ * results in the same binary being returned both times).
+ *
* @param uploadToken A String identifying the upload transaction.
*
* @return The uploaded {@link Binary}, or {@code null} if the