From 985faddba756e892c72ec8b4b73cf4269a676ece Mon Sep 17 00:00:00 2001
From: cramakri <cramakri>
Date: Mon, 11 Mar 2013 12:15:30 +0000
Subject: [PATCH] MINOR : Document configuration parameters that affect the
getDownloadUrlForFileForDataSetWithTimeout method
SVN: 28579
---
.../dss/generic/shared/api/v1/IDssServiceRpcGeneric.java | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/shared/api/v1/IDssServiceRpcGeneric.java b/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/shared/api/v1/IDssServiceRpcGeneric.java
index 8972122755c..4563c1e5302 100644
--- a/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/shared/api/v1/IDssServiceRpcGeneric.java
+++ b/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/shared/api/v1/IDssServiceRpcGeneric.java
@@ -94,7 +94,9 @@ public interface IDssServiceRpcGeneric extends IRpcService
* @param sessionToken The session token
* @param fileOrFolder The file or folder to retrieve
* @param validityDurationInSeconds The number of seconds for which the download URL should be
- * valid.
+ * valid. The validity is clipped to the durations defined in the properties
+ * <i>data-stream-timeout</i> and <i>data-stream-max-timeout</i>, which default
+ * to 5 seconds and 4 hours, respectively.
* @throws IOExceptionUnchecked Thrown if an IOException occurs when listing the files
* @throws IllegalArgumentException Thrown if the dataSetCode or startPath are not valid
* @since 1.7
--
GitLab