add javadoc to servlet to specify deployment requirements

opencadc · Dec 18, 2023 · dcc9d6e · dcc9d6e
1 parent 97c9311
commit dcc9d6e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/...os-server/src/main/java/org/opencadc/vospace/server/transfers/TransferDetailsServlet.java b/...os-server/src/main/java/org/opencadc/vospace/server/transfers/TransferDetailsServlet.java
@@ -105,6 +105,15 @@
 import org.opencadc.vospace.transfer.TransferReader;
 import org.opencadc.vospace.transfer.TransferWriter;
 
+/**
+ * Servlet to support output of a transfer result from 
+ * /transfers/{jobID}/results/transferDetails. Implementation
+ * detail/requirement: This servlet MUST be deployed as a 
+ * sibling of the /nodes endpoint and MUST be named /xfer 
+ * in the servlet mapping.
+ * 
+ * @author pdowler
+ */
 public class TransferDetailsServlet extends HttpServlet {
 
     private static final long serialVersionUID = 2022026164700L;