Fixes some log levels, typos.
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / Pz2Bean.java
index d617f14..6185dae 100644 (file)
@@ -2,17 +2,21 @@ package com.indexdata.mkjsf.pazpar2;
 \r
 import java.io.Serializable;\r
 import java.util.ArrayList;\r
+import java.util.Arrays;\r
+import java.util.HashMap;\r
 import java.util.List;\r
+import java.util.Map;\r
 import java.util.StringTokenizer;\r
 \r
 import javax.annotation.PostConstruct;\r
 import javax.enterprise.context.SessionScoped;\r
-import javax.enterprise.inject.Alternative;\r
 import javax.inject.Inject;\r
 import javax.inject.Named;\r
 \r
 import org.apache.log4j.Logger;\r
 \r
+import com.indexdata.mkjsf.config.Configurable;\r
+import com.indexdata.mkjsf.config.Configuration;\r
 import com.indexdata.mkjsf.config.ConfigurationReader;\r
 import com.indexdata.mkjsf.controls.ResultsPager;\r
 import com.indexdata.mkjsf.errors.ConfigurationError;\r
@@ -21,31 +25,44 @@ import com.indexdata.mkjsf.errors.ErrorCentral;
 import com.indexdata.mkjsf.errors.ErrorHelper;\r
 import com.indexdata.mkjsf.pazpar2.commands.CommandParameter;\r
 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands;\r
-import com.indexdata.mkjsf.pazpar2.data.Pazpar2ResponseData;\r
-import com.indexdata.mkjsf.pazpar2.data.Pazpar2ResponseParser;\r
-import com.indexdata.mkjsf.pazpar2.data.Pazpar2Responses;\r
+import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;\r
+import com.indexdata.mkjsf.pazpar2.data.ResponseParser;\r
+import com.indexdata.mkjsf.pazpar2.data.Responses;\r
 import com.indexdata.mkjsf.pazpar2.data.RecordResponse;\r
+import com.indexdata.mkjsf.pazpar2.sp.auth.ServiceProxyUser;\r
 import com.indexdata.mkjsf.pazpar2.state.StateListener;\r
 import com.indexdata.mkjsf.pazpar2.state.StateManager;\r
 import com.indexdata.mkjsf.utils.Utils;\r
 \r
-@Named("pz2") @SessionScoped @Alternative\r
-public class Pz2Bean implements Pz2Interface, StateListener, Serializable {\r
+@Named("pz2") @SessionScoped\r
+public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Serializable {\r
+\r
+  private static final String MODULE_NAME = "service";\r
+  private static String SERVICE_TYPE_TBD = "TBD", SERVICE_TYPE_PZ2 = "PZ2", SERVICE_TYPE_SP = "SP";\r
+  private static final List<String> serviceTypes = \r
+                Arrays.asList(SERVICE_TYPE_PZ2,SERVICE_TYPE_SP,SERVICE_TYPE_TBD);\r
+  private String serviceType = SERVICE_TYPE_TBD;\r
+  private List<String> serviceProxyUrls = new ArrayList<String>();\r
+  public static final String SERVICE_PROXY_URL_LIST = "SERVICE_PROXY_URL_LIST";\r
+  private List<String> pazpar2Urls = new ArrayList<String>();\r
+  public static final String PAZPAR2_URL_LIST = "PAZPAR2_URL_LIST";\r
+\r
 \r
   private static final long serialVersionUID = 3440277287081557861L;\r
   private static Logger logger = Logger.getLogger(Pz2Bean.class);\r
-  private static Logger responseLogger = Logger.getLogger("com.indexdata.mkjsf.pazpar2.responses");\r
-  \r
-  protected SearchClient searchClient = null;\r
-  \r
+  private static Logger responseLogger = Logger.getLogger("com.indexdata.mkjsf.pazpar2.responses");   \r
+  protected Pz2Client pz2Client = null;\r
+  protected ServiceProxyClient spClient = null;\r
+  protected SearchClient searchClient = null;  \r
+    \r
   @Inject ConfigurationReader configurator;\r
   @Inject StateManager stateMgr;\r
   @Inject Pazpar2Commands pzreq;\r
-  @Inject Pazpar2Responses pzresp;\r
+  @Inject Responses pzresp;\r
   @Inject ErrorCentral errors;\r
+  @Inject ServiceProxyUser user;\r
   \r
   protected ResultsPager pager = null; \r
-\r
   \r
   protected ErrorHelper errorHelper = null;\r
               \r
@@ -55,19 +72,25 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
   \r
   @PostConstruct\r
   public void postConstruct() {    \r
-    logger.debug("in start of Pz2Bean post-construct configurator is " + configurator);\r
+    logger.debug("Pz2Bean post-construct: Configurator is " + configurator);\r
     logger.debug(Utils.objectId(this) + " will instantiate a Pz2Client next.");\r
-    searchClient = new Pz2Client();\r
-    logger.info("Using [" + Utils.objectId(searchClient) + "] configured by [" \r
-                          + Utils.objectId(configurator) + "]" );    \r
-    configureClient(searchClient,configurator);    \r
+    pz2Client = new Pz2Client();\r
+    configureClient(pz2Client,configurator);\r
+    spClient = new ServiceProxyClient();\r
+    configureClient(spClient,configurator);\r
+    try {\r
+      this.configure(configurator);\r
+    } catch (ConfigurationException e) {\r
+      logger.error("There was a problem configuring the Pz2Bean (\"pz2\")");\r
+      e.printStackTrace();\r
+    }    \r
     stateMgr.addStateListener(this);    \r
   }  \r
   \r
-  public void configureClient(SearchClient searchClient, ConfigurationReader configReader) {\r
+  public void configureClient(SearchClient client, ConfigurationReader configReader) {\r
     logger.debug(Utils.objectId(this) + " will configure search client for the session");\r
     try {\r
-      searchClient.configure(configReader);            \r
+      client.configure(configReader);            \r
     } catch (ConfigurationException e) {\r
       logger.debug("Pz2Bean adding configuration error");\r
       errors.addConfigurationError(new ConfigurationError("Search Client","Configuration",e.getMessage()));                \r
@@ -75,6 +98,12 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
     logger.info(configReader.document());\r
     pzresp.reset();    \r
   }\r
+  \r
+  public void resetSearchAndResults () {\r
+    pzreq.getRecord().removeParametersInState();\r
+    pzreq.getSearch().removeParametersInState();\r
+    pzresp.reset();    \r
+  }\r
 \r
     \r
   public void doSearch(String query) {\r
@@ -110,9 +139,10 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
    * @return Number of activeclients at the time of the 'show' command\r
    */\r
   public String update (String commands) {\r
+    try {\r
     if (! errors.hasConfigurationErrors()) {\r
       if (commandsAreValid(commands)) {\r
-        if (hasQuery()) {\r
+        if (hasQuery() || (commands.equals("record") && pzreq.getCommand("record").hasParameterValue("recordquery"))) {\r
           handleQueryStateChanges(commands);\r
           logger.debug("Processing request for " + commands); \r
           List<CommandThread> threadList = new ArrayList<CommandThread>();\r
@@ -131,14 +161,25 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
             }\r
           }\r
           for (CommandThread thread : threadList) {\r
-             String commandName = thread.getCommand().getName();\r
-             String response = thread.getResponse();\r
-             responseLogger.debug("Response was: " + response);\r
-             Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);\r
-             pzresp.put(commandName, responseObject);        \r
+             String commandName = thread.getCommand().getCommandName();\r
+             HttpResponseWrapper response = thread.getCommandResponse();\r
+             responseLogger.debug("Response was: " + response.getResponseString());\r
+             ResponseDataObject responseObject = ResponseParser.getParser().getDataObject(response.getResponseString());\r
+             if (ResponseParser.docTypes.contains(responseObject.getType())) {\r
+               pzresp.put(commandName, responseObject);\r
+             } else {\r
+               if (commandName.equals("record") && \r
+                   (pzreq.getRecord().hasParameterValue("offset") ||\r
+                    pzreq.getRecord().hasParameterValue("checksum"))) {\r
+                 RecordResponse recordResponse = new RecordResponse();\r
+                 recordResponse.setType("record");\r
+                 recordResponse.setXml(responseObject.getXml());\r
+                 recordResponse.setAttribute("activeclients", "0");\r
+                 pzresp.put(commandName, recordResponse);\r
+               }\r
+             }\r
           }\r
           if (commands.equals("record")) {\r
-            logger.debug("Record: Active clients: "+pzresp.getRecord().getActiveClients());\r
             return pzresp.getRecord().getActiveClients();\r
           } else {\r
             return pzresp.getActiveClients();\r
@@ -149,20 +190,30 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
           return "0";\r
         }\r
       } else {\r
-        logger.error("Did not attemt to run command(s) due to a validation error.");\r
+        logger.debug("Did not attempt to run command(s) that were not ready.");\r
         return "0";\r
       }\r
     } else {      \r
       logger.error("Did not attempt to execute query since there are configuration errors.");\r
       return "0";\r
     }\r
+    } catch (ClassCastException cce) {\r
+      cce.printStackTrace();    \r
+      return "";\r
+    } catch (NullPointerException npe) {\r
+      npe.printStackTrace();\r
+      return "";\r
+    } catch (Exception e) {\r
+      e.printStackTrace();\r
+      return "";\r
+    }\r
     \r
   }\r
   \r
   public boolean commandsAreValid(String commands) {\r
     if (commands.equals("record")) {\r
-      if (!pzreq.getCommand("record").hasParameterSet("id")) {\r
-        logger.error("Attempt to send record command without the id parameter");\r
+      if (!pzreq.getCommand("record").hasParameterValue("id")) {\r
+        logger.debug("Attempt to send record command without the id parameter");\r
         return false;\r
       }\r
     }\r
@@ -194,7 +245,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
   }\r
       \r
   protected boolean hasQuery() {        \r
-    return pzreq.getCommand("search").hasParameterSet("query"); \r
+    return pzreq.getCommand("search").hasParameterValue("query"); \r
   }\r
     \r
     \r
@@ -220,7 +271,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
     if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
       stateMgr.hasPendingStateChange("record",false);\r
-      if (pzreq.getCommand("record").hasParameterSet("id")) {\r
+      if (pzreq.getCommand("record").hasParameterValue("id")) {\r
         update("record");\r
       } else {         \r
         pzresp.put("record", new RecordResponse());\r
@@ -242,9 +293,91 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
     } \r
   }\r
   \r
+  public void setServiceProxyUrl(String url) {\r
+    searchClient = spClient;\r
+    setServiceType(SERVICE_TYPE_SP);\r
+    setServiceUrl(url);\r
+  }\r
+  \r
+  public String getServiceProxyUrl () {\r
+    if (isServiceProxyService()) {\r
+      return spClient.getServiceUrl();\r
+    } else {\r
+      return "";\r
+    }\r
+  }\r
+  \r
+  public void setPazpar2Url(String url) {\r
+    searchClient = pz2Client;\r
+    setServiceType(SERVICE_TYPE_PZ2);\r
+    setServiceUrl(url);\r
+  }\r
+  \r
+  public String getPazpar2Url() {\r
+    if (isPazpar2Service()) {\r
+      return pz2Client.getServiceUrl();\r
+    } else {\r
+      return "";\r
+    }\r
+  }\r
+\r
+  \r
+  @Override\r
+  public void setServiceUrl(String url) {\r
+    if (url!=null && searchClient != null && !url.equals(searchClient.getServiceUrl())) {\r
+      pzreq.getRecord().removeParametersInState();\r
+      pzreq.getSearch().removeParametersInState();\r
+      pzresp.reset();\r
+      user.clear();\r
+      searchClient.setServiceUrl(url);\r
+    }    \r
+  }\r
+  \r
+  public String getServiceUrl() {\r
+    return (searchClient!=null ? searchClient.getServiceUrl() : "");\r
+  }\r
+  \r
+  public boolean getServiceUrlIsDefined() {\r
+    return (searchClient != null && searchClient.hasServiceUrl());\r
+  }\r
+  \r
+  public List<String> getServiceProxyUrls() {\r
+    List<String> urls = new ArrayList<String>();\r
+    urls.add("");\r
+    urls.addAll(serviceProxyUrls);\r
+    return urls;\r
+  }\r
+  \r
+  public List<String> getPazpar2Urls () {\r
+    List<String> urls = new ArrayList<String>();\r
+    urls.add("");\r
+    urls.addAll(pazpar2Urls);\r
+    return urls;\r
+  }\r
+  \r
+  public String getServiceType () {\r
+    return serviceType;\r
+  }\r
+  \r
+  public boolean isPazpar2Service () {\r
+    return serviceType.equals(SERVICE_TYPE_PZ2);\r
+  }\r
+  \r
+  public boolean isServiceProxyService() {\r
+    return serviceType.equals(SERVICE_TYPE_SP);\r
+  }\r
+  \r
+  public boolean serviceIsToBeDecided () {\r
+    return serviceType.equals(SERVICE_TYPE_TBD);\r
+  }\r
+  \r
+  public ServiceProxyClient getSpClient () {\r
+    return spClient;\r
+  }  \r
+  \r
   @Override\r
   public boolean getAuthenticationRequired () {\r
-    return searchClient.isAuthenticatingClient();\r
+    return spClient.isAuthenticatingClient();\r
   }\r
 \r
   @Override\r
@@ -261,5 +394,76 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
   public String getWatchActiveclientsRecord () {\r
     return ":pz2watch:activeclientsForm:activeclientsFieldRecord";\r
   }\r
+\r
+  @Override\r
+  public void configure(ConfigurationReader reader)\r
+      throws ConfigurationException {\r
+    Configuration config = reader.getConfiguration(this);\r
+    if (config == null) {\r
+      serviceType = SERVICE_TYPE_TBD;\r
+    } else {\r
+      String service = config.get("TYPE");\r
+      if (service == null || service.length()==0) {\r
+        serviceType = SERVICE_TYPE_TBD;\r
+      } else if (serviceTypes.contains(service.toUpperCase())) {        \r
+        setServiceType(service.toUpperCase());\r
+      } else {\r
+        logger.error("Unknown serviceType type in configuration [" + service + "], can be one of " + serviceTypes);\r
+        serviceType = SERVICE_TYPE_TBD;\r
+      }\r
+      serviceProxyUrls = config.getMultiProperty(SERVICE_PROXY_URL_LIST,",");\r
+      pazpar2Urls = config.getMultiProperty(PAZPAR2_URL_LIST, ",");\r
+    }\r
+    logger.info("Service Type is configured to " + serviceType);\r
+    \r
+  }\r
+\r
+  @Override\r
+  public Map<String, String> getDefaults() {\r
+    return new HashMap<String,String>();\r
+  }\r
+\r
+  @Override\r
+  public String getModuleName() {\r
+    return MODULE_NAME;\r
+  }\r
+\r
+  @Override\r
+  public List<String> documentConfiguration() {\r
+    return new ArrayList<String>();\r
+  }\r
+\r
+  @Override\r
+  public void setServiceTypePZ2() {\r
+    setServiceType(SERVICE_TYPE_PZ2);    \r
+  }\r
+\r
+  @Override\r
+  public void setServiceTypeSP() {\r
+    setServiceType(SERVICE_TYPE_SP);        \r
+  }\r
+\r
+  @Override\r
+  public void setServiceTypeTBD() {\r
+    setServiceType(SERVICE_TYPE_TBD);    \r
+  }\r
+  \r
+  private void setServiceType(String type) {\r
+    if (!serviceType.equals(type)  &&\r
+        !serviceType.equals(SERVICE_TYPE_TBD)) {\r
+      resetSearchAndResults();\r
+    }\r
+    serviceType = type;\r
+    if (serviceType.equals(SERVICE_TYPE_PZ2)) {\r
+      searchClient = pz2Client;\r
+      logger.info("Setting a Pazpar2 client to serve requests.");\r
+    } else if (serviceType.equals(SERVICE_TYPE_SP)) {\r
+      searchClient = spClient;\r
+      logger.info("Setting a Service Proxy client to serve requests.");\r
+    } else {\r
+      logger.info("Clearing search client. No client defined to serve requests at this point.");\r
+      searchClient = null;\r
+    }\r
+  }\r
   \r
 }\r