More precise timeout semantics in Javadoc, deprecate SyncSession default ctor

4 files changed, 23 insertions, 10 deletions

diff --git a/documentapi/src/main/java/com/yahoo/documentapi/SyncParameters.java b/documentapi/src/main/java/com/yahoo/documentapi/SyncParameters.java
index a7bbf1243ae..66af8061f7c 100755
--- a/documentapi/src/main/java/com/yahoo/documentapi/SyncParameters.java
+++ b/documentapi/src/main/java/com/yahoo/documentapi/SyncParameters.java
@@ -13,6 +13,11 @@ import java.util.Optional;
 public class SyncParameters extends Parameters {
     private final TemporalAmount defaultTimeout;
 
+    /**
+     * @deprecated Use {@link Builder} instead.
+     */
+    @Deprecated
+    // TODO Vespa 7: Make private
     public SyncParameters() {
         this(null);
     }
diff --git a/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java b/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java
index e04fb7a4e07..330bf0dbf33 100755
--- a/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java
+++ b/documentapi/src/main/java/com/yahoo/documentapi/SyncSession.java
@@ -67,9 +67,8 @@ public interface SyncSession extends Session {
      * @param timeout Timeout. If timeout is null, an unspecified default will be used.
      * @return The known document having this id, or null if there is no
      *         document having this id.
-     * @throws UnsupportedOperationException Thrown if this access does not
-     *                                       support retrieving.
-     * @throws RuntimeException If operation times out.
+     * @throws UnsupportedOperationException Thrown if this access does not support retrieving.
+     * @throws DocumentAccessException with error code {@link com.yahoo.messagebus.ErrorCode#TIMEOUT} on timeout.
      */
     // TODO Vespa 7: Remove default implementation. Consider removing get() overloads without timeout.
     default Document get(DocumentId id, TemporalAmount timeout) {
@@ -85,9 +84,8 @@ public interface SyncSession extends Session {
      * @param timeout Timeout. If timeout is null, an unspecified default will be used.
      * @return The known document having this id, or null if there is no
      *         document having this id.
-     * @throws UnsupportedOperationException Thrown if this access does not
-     *                                       support retrieving.
-     * * @throws RuntimeException If operation times out.
+     * @throws UnsupportedOperationException Thrown if this access does not support retrieving.
+     * @throws DocumentAccessException with error code {@link com.yahoo.messagebus.ErrorCode#TIMEOUT} on timeout.
      */
     // TODO Vespa 7: Remove default implementation. Consider removing get() overloads without timeout.
     default Document get(DocumentId id, String fieldSet, DocumentProtocol.Priority priority,
diff --git a/documentapi/src/main/java/com/yahoo/documentapi/local/LocalAsyncSession.java b/documentapi/src/main/java/com/yahoo/documentapi/local/LocalAsyncSession.java
index 7348271653d..d365407f407 100644
--- a/documentapi/src/main/java/com/yahoo/documentapi/local/LocalAsyncSession.java
+++ b/documentapi/src/main/java/com/yahoo/documentapi/local/LocalAsyncSession.java
@@ -3,11 +3,21 @@ package com.yahoo.documentapi.local;
 
 import com.yahoo.document.Document;
 import com.yahoo.document.DocumentId;
-import com.yahoo.document.DocumentOperation;
 import com.yahoo.document.DocumentPut;
 import com.yahoo.document.DocumentRemove;
 import com.yahoo.document.DocumentUpdate;
-import com.yahoo.documentapi.*;
+import com.yahoo.documentapi.AsyncParameters;
+import com.yahoo.documentapi.AsyncSession;
+import com.yahoo.documentapi.DocumentIdResponse;
+import com.yahoo.documentapi.DocumentResponse;
+import com.yahoo.documentapi.DocumentUpdateResponse;
+import com.yahoo.documentapi.RemoveResponse;
+import com.yahoo.documentapi.Response;
+import com.yahoo.documentapi.ResponseHandler;
+import com.yahoo.documentapi.Result;
+import com.yahoo.documentapi.SyncParameters;
+import com.yahoo.documentapi.SyncSession;
+import com.yahoo.documentapi.UpdateResponse;
 import com.yahoo.documentapi.messagebus.protocol.DocumentProtocol;
 
 import java.util.LinkedList;
@@ -35,7 +45,7 @@ public class LocalAsyncSession implements AsyncSession {
         this.access = access;
         this.handler = params.getResponseHandler();
         random.setSeed(System.currentTimeMillis());
-        syncSession = access.createSyncSession(new SyncParameters());
+        syncSession = access.createSyncSession(new SyncParameters.Builder().build());
     }
 
     @Override
diff --git a/documentapi/src/test/java/com/yahoo/documentapi/messagebus/test/Destination.java b/documentapi/src/test/java/com/yahoo/documentapi/messagebus/test/Destination.java
index b2d03a9188d..c18bfc7597a 100644
--- a/documentapi/src/test/java/com/yahoo/documentapi/messagebus/test/Destination.java
+++ b/documentapi/src/test/java/com/yahoo/documentapi/messagebus/test/Destination.java
@@ -32,7 +32,7 @@ public class Destination implements MessageHandler {
         DocumentAccessParams params = new DocumentAccessParams();
         params.setDocumentManagerConfigId(documentManagerConfigId);
         access = new LocalDocumentAccess(params);
-        local = access.createSyncSession(new SyncParameters());
+        local = access.createSyncSession(new SyncParameters.Builder().build());
         bus = new RPCMessageBus(Arrays.asList((Protocol)new DocumentProtocol(access.getDocumentTypeManager())),
                                 new RPCNetworkParams()
                                         .setIdentity(new Identity("test/destination"))