diff artifact-database/src/main/java/de/intevation/artifactdatabase/rest/CreateResource.java @ 88:69c84cf7c5d7

Added javadoc to the REST package of the artifact database (complete). artifacts/trunk@840 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Fri, 26 Mar 2010 15:05:11 +0000
parents b2e0cb83631c
children d348fe1fd822
line wrap: on
line diff
--- a/artifact-database/src/main/java/de/intevation/artifactdatabase/rest/CreateResource.java	Fri Mar 26 11:40:28 2010 +0000
+++ b/artifact-database/src/main/java/de/intevation/artifactdatabase/rest/CreateResource.java	Fri Mar 26 15:05:11 2010 +0000
@@ -18,6 +18,7 @@
 import de.intevation.artifacts.ArtifactNamespaceContext;
 
 /**
+ * Resource to create a new artifact within artifact database.
  * @author <a href="mailto:sascha.teichmann@intevation">Sascha L. Teichmann</a>
  */
 public class CreateResource
@@ -25,12 +26,25 @@
 {
     private static Logger logger = Logger.getLogger(CreateResource.class);
 
+    /**
+     * server URL where to reach the resource.
+     */
     public static final String PATH = "/create";
 
+    /**
+     * XPATH to figure out the name of the factory which should be used
+     * to create the new artifact.
+     */
     public static final String XPATH_FACTORY = "/art:action/art:factory/@name";
 
+    /**
+     * Error message if no factory was given.
+     */
     public static final String NO_FACTORY_MESSAGE = "No factory given";
 
+    /**
+     * Error message if no artifact was created.
+     */
     public static final String NO_ARTIFACT_CREATED = "No artifact created";
 
     protected Representation innerPost(Representation requestRepr)

http://dive4elements.wald.intevation.org