Documents configuration schemes in more detail

[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / Pz2Client.java

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java
index 3417a47..9e02137 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java
@@ -37,6 +37,21 @@ import com.indexdata.mkjsf.utils.Utils;
  * types of session handling, bootstraps lost sessions, avoids repeating already \r
  * executed queries etc, so it is -- in other words -- still a mediated interaction \r
  * with Pazpar2 that takes place. At least for now.</p>  \r
+ * \r
+ * <h3>Configuration</h3>\r
+ *\r
+ * Configuration name: pz2client.\r
+ *  \r
+ * <p>When configuring the client using the Mk2Config scheme, this is the prefix to\r
+ * use in the .properties file. When using web.xml context parameters for configuration\r
+ * the configuration name has no effect.</p> \r
+ * \r
+ * <p>Pz2Client will acknowledge following configuration parameters:\r
+ * \r
+ * <ul>\r
+ *  <li>(pz2client.)PAZPAR2_URL</li>\r
+ *  <li>(pz2client.)SERVICE_ID</li>\r
+ * </ul> \r
  *  \r
  * @author Niels Erik\r
  *\r
@@ -48,6 +63,10 @@ public class Pz2Client implements SearchClient {
   private transient Pazpar2Client client = null;\r
   private Pazpar2ClientConfiguration cfg = null;\r
   public static final String MODULENAME = "pz2client";\r
+  \r
+  /**\r
+   * PAZPAR2_URL=none, PROXY_MODE=1, SERIALIZE_REQUESTS=false, STREAMBUFF_SIZE=4096, PARSE_RESPONSES=true\r
+   */\r
   public static Map<String,String> DEFAULTS = new HashMap<String,String>();\r
   Configuration config = null;  \r
   \r