X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fconfig%2Fpackage-info.java;fp=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fconfig%2Fpackage-info.java;h=30f3f5149dcc2874bf1773e8806815559b65e754;hb=9e1936b84f645007967c5c0067d04b99ba14e89a;hp=60dc2f5dd47b9dcf0926598e5e1ef285c4987f98;hpb=0c500bea459cf05157e0f753755466ce1b46604c;p=mkjsf-moved-to-github.git 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 --- 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 @@ /** - * The library comes with two alternative mechanisms for configuration of an application, but it is - * possible to apply a custom scheme too or not use the configurations at all. - *
The library does require that a configuration scheme is chosen - in beans.xml as described below.
- *But the library does NOT impose any mandatory parameters in order to start up (except for those required for - * bootstrapping the configuration). The library does know of certain parameters, if it encounters them. + * The library comes with two alternative mechanisms for configuration of an application. It is + * possible, however, to apply a custom scheme or not to use configurations at all. + *
The library does require that a configuration scheme is chosen - in beans.xml as described below, but the library + * does NOT impose any mandatory parameters in order to initialize. The library does know of certain parameters, + * if it encounters them. * - *
Following classes can be configured: Pz2Service (controller), Pz2Client, and ServiceProxyClient. Some currently - * acknowledged parameters are TYPE (service type) PAZPAR2_URL, SERVICE_ID, and SERVICE_PROXY_URL
+ *Following classes can be configured: Pz2Service (the controller), Pz2Client, and ServiceProxyClient. Some currently + * acknowledged parameters are TYPE (service type) PAZPAR2_URL, SERVICE_ID (see Pazpar2 documentation for an explanation of + * service id), and SERVICE_PROXY_URL
* *The built-in configuration schemes are:
*For the web.xml configuration scheme (choosing WebXmlConfigReader in beans.xml) - * to pre-define the URL of the Pazpar2 to use and choose Pazpar2 as the selected - * service type, the configuration could be:
+ *Using the web.xml configuration scheme (choosing WebXmlConfigReader in beans.xml) + * you can configure you application to use a locally installed Pazpar2 server like this:
* ** <context-param> @@ -55,6 +55,21 @@ * </context-param> ** + * Likewise you could configure your application to use our hosted Pazpar2 service with these settings: + * + *
+ * <context-param> + * <param-name>SERVICE_PROXY_URL</param-name> + * <param-value>http://mkc.indexdata.com:9009/service-proxy/</param-value> + * </context-param> + * <context-param> + * <description>Service type. Possible values: SP, PZ2, TBD</description> + * <param-name>TYPE</param-name> + * <param-value>SP</param-value> + * </context-param> + *+ * + * *
The Mk2ConfigReader scheme allows the configuration to exist outside of the web application archive. @@ -95,7 +110,10 @@ *
The jsfdemo.properties file might look like this for running against a * local Pazpar2 service:
* - *pz2client.PAZPAR2_URL = http://localhost:8004/
+ * + * service.TYPE = pz2 + * pz2client.PAZPAR2_URL = http://localhost:8004/ + ** *
Some of the other known parameters in this format could be:
*