Adds Javadoc on configuration

[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / config / package-info.java

diff --git a/src/main/java/com/indexdata/mkjsf/config/package-info.java b/src/main/java/com/indexdata/mkjsf/config/package-info.java
index 60dc2f5..30f3f51 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/config/package-info.java
+++ b/src/main/java/com/indexdata/mkjsf/config/package-info.java
@@ -1,18 +1,19 @@
 /**\r
- * The library comes with two alternative mechanisms for configuration of an application, but it is\r
- * possible to apply a custom scheme too or not use the configurations at all.\r
- * <p>The library does require that a configuration scheme is chosen - in beans.xml as described below.</p>\r
- * <p>But the library does NOT impose any mandatory parameters in order to start up (except for those required for \r
- * bootstrapping the configuration). The library <i>does</i> know of certain parameters, if it encounters them.\r
+ * The library comes with two alternative mechanisms for configuration of an application. It is\r
+ * possible, however, to apply a custom scheme or not to use configurations at all.\r
+ * <p>The library does require that a configuration scheme is chosen - in beans.xml as described below, but the library \r
+ * does NOT impose any mandatory parameters in order to initialize. The library <i>does</i> know of certain parameters, \r
+ * if it encounters them.\r
  *\r
- * <p>Following classes can be configured: Pz2Service (controller), Pz2Client, and ServiceProxyClient. Some currently \r
- * acknowledged parameters are TYPE (service type) PAZPAR2_URL, SERVICE_ID, and SERVICE_PROXY_URL</p>\r
+ * <p>Following classes can be configured: Pz2Service (the controller), Pz2Client, and ServiceProxyClient. Some currently \r
+ * acknowledged parameters are TYPE (service type) PAZPAR2_URL, SERVICE_ID (see Pazpar2 documentation for an explanation of \r
+ * service id), and SERVICE_PROXY_URL</p>\r
  * \r
  * <h3>Selecting a configuration scheme</h3>\r
  * \r
  * <p>The built-in configuration schemes are:</p>\r
  * <ol>\r
- *  <li>Configuration by context parameters in web.xml, this is the simple though less flexible choice</li>\r
+ *  <li>Configuration by context parameters in web.xml, this is the simple albeit less flexible choice</li>\r
  *  <li>The configuration scheme Index Data uses for other MasterKey applications, Mk2Config, this is the more versatile option</li>\r
  * </ol> \r
  * \r
@@ -39,9 +40,8 @@
  * \r
  * <h3>Configuring the service using web.xml only</h3>\r
  * \r
- * <p>For the web.xml configuration scheme (choosing WebXmlConfigReader in beans.xml)\r
- * to pre-define the URL of the Pazpar2 to use and choose Pazpar2 as the selected\r
- * service type, the configuration could be:</p>\r
+ * <p>Using the web.xml configuration scheme (choosing WebXmlConfigReader in beans.xml)\r
+ * you can configure you application to use a locally installed Pazpar2 server like this:</p>\r
  * \r
  * <pre>\r
  *  &lt;context-param&gt;\r
@@ -55,6 +55,21 @@
  *  &lt;/context-param&gt;\r
  * </pre>\r
  * \r
+ * Likewise you could configure your application to use our hosted Pazpar2 service with these settings:\r
+ *\r
+ * <pre>\r
+ *  &lt;context-param&gt;\r
+ *   &lt;param-name&gt;SERVICE_PROXY_URL&lt;/param-name&gt;\r
+ *   &lt;param-value&gt;http://mkc.indexdata.com:9009/service-proxy/&lt;/param-value&gt;\r
+ *  &lt;/context-param&gt;\r
+ *  &lt;context-param&gt;\r
+ *   &lt;description&gt;Service type. Possible values: SP, PZ2, TBD&lt;/description&gt;\r
+ *   &lt;param-name&gt;TYPE&lt;/param-name&gt;\r
+ *   &lt;param-value&gt;SP&lt;/param-value&gt;  \r
+ *  &lt;/context-param&gt;\r
+ * </pre>\r
+ * \r
+ * \r
  * <h3>Configuring the service using 'Mk2Config' scheme</h3>\r
  * \r
  * <p>The Mk2ConfigReader scheme allows the configuration to exist outside of the web application archive. \r
@@ -95,7 +110,10 @@
  * <p>The jsfdemo.properties file might look like this for running against a \r
  * local Pazpar2 service:</p>\r
  * \r
- * <code>pz2client.PAZPAR2_URL = http://localhost:8004/</code>\r
+ * <pre>\r
+ * service.TYPE = pz2\r
+ * pz2client.PAZPAR2_URL = http://localhost:8004/\r
+ * </pre>\r
  * \r
  * <p>Some of the other known parameters in this format could be:</p>\r
  * \r