Disentangles update() logic. Adds option for early feedback.
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / Pz2Bean.java
index 1ca0709..d7a9235 100644 (file)
@@ -24,11 +24,12 @@ import com.indexdata.mkjsf.errors.ConfigurationException;
 import com.indexdata.mkjsf.errors.ErrorCentral;\r
 import com.indexdata.mkjsf.errors.ErrorHelper;\r
 import com.indexdata.mkjsf.pazpar2.commands.CommandParameter;\r
+import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;\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.RecordResponse;\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.sp.auth.ServiceProxyUser;\r
 import com.indexdata.mkjsf.pazpar2.state.StateListener;\r
 import com.indexdata.mkjsf.pazpar2.state.StateManager;\r
@@ -58,7 +59,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
   @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
@@ -96,13 +97,12 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
       errors.addConfigurationError(new ConfigurationError("Search Client","Configuration",e.getMessage()));                \r
     } \r
     logger.info(configReader.document());\r
-    pzresp.reset();    \r
+    pzresp.resetAllSessionData();    \r
   }\r
   \r
-  public void resetSearchAndResults () {\r
+  public void resetSearchAndRecordCommands () {\r
     pzreq.getRecord().removeParametersInState();\r
-    pzreq.getSearch().removeParametersInState();\r
-    pzresp.reset();    \r
+    pzreq.getSearch().removeParametersInState();   \r
   }\r
 \r
     \r
@@ -113,13 +113,26 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
 \r
   public void doSearch() { \r
     stateMgr.hasPendingStateChange("search",false);\r
-    pzresp.reset();\r
+    pzresp.resetSearchResponses();\r
     // resets some record and show command parameters without \r
     // changing state or creating state change feedback\r
     pzreq.getRecord().removeParametersInState();        \r
     pzreq.getShow().setParameterInState(new CommandParameter("start","=",0));    \r
     logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommand("search").getUrlEncodedParameterValue("query"));\r
-    doCommand("search");    \r
+    doCommand("search");      \r
+  }\r
+  \r
+  public String doRecord() {\r
+    ResponseDataObject responseObject = doCommand("record");\r
+    if (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("record", recordResponse);\r
+     }\r
+     return pzresp.getRecord().getActiveClients();    \r
   }\r
       \r
   /**\r
@@ -131,6 +144,26 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
     return update("show,stat,termlist,bytarget");\r
   }\r
+  \r
+  public boolean validateUpdateRequest(String commands) {\r
+    if (errors.hasConfigurationErrors()) {\r
+      logger.error("The command(s) " + commands + " are cancelled due to configuration errors.");\r
+      return false;\r
+    } else if (!commands.equals("search") && pzresp.getSearch().hasApplicationError()) {\r
+      logger.error("The command(s) " + commands + " are cancelled because the latest search command had an error.");\r
+      return false;\r
+    } else if (!commandsAreValid(commands)) {\r
+      logger.debug("The command(s) " + commands + " are cancelled because the were not found to be ready/valid.");\r
+      return false;\r
+    } else if (!hasQuery() &&  !(commands.equals("record") && pzreq.getCommand("record").hasParameterValue("recordquery"))) {\r
+      logger.debug("The command(s) " + commands + " are held off because there's not yet a query.");\r
+      return false;\r
+    } else {\r
+      return true;\r
+    }\r
+    \r
+    \r
+  }\r
    \r
   /**\r
    * Refreshes the data objects listed in 'commands' from pazpar2\r
@@ -139,12 +172,27 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
    * @return Number of activeclients at the time of the 'show' command\r
    */\r
   public String update (String commands) {\r
+    logger.info("Request to update: " + commands);\r
     try {\r
-    if (! errors.hasConfigurationErrors()) {\r
-      if (commandsAreValid(commands)) {\r
-        if (hasQuery() || (commands.equals("record") && pzreq.getCommand("record").hasParameterValue("recordquery"))) {\r
-          handleQueryStateChanges(commands);\r
+      if (!validateUpdateRequest(commands)) {\r
+        return "0";\r
+      } else if (commands.equals("search")) {\r
+        doSearch();\r
+        return "";\r
+      } else if (commands.equals("record")) {\r
+        return doRecord();\r
+      } else if (pzresp.getSearch().isNew()) {\r
+        logger.info("New search. Marking it old, then returning 'new' to trigger another round-trip.");\r
+        pzresp.getSearch().setIsNew(false);\r
+        return "new";\r
+      } else {\r
+        handleQueryStateChanges(commands);\r
+        if (pzresp.getSearch().hasApplicationError()) {\r
+          logger.error("The command(s) " + commands + " are cancelled because the latest search command had an error.");\r
+          return "0";\r
+        } else {\r
           logger.debug("Processing request for " + commands); \r
+          \r
           List<CommandThread> threadList = new ArrayList<CommandThread>();\r
           StringTokenizer tokens = new StringTokenizer(commands,",");\r
           while (tokens.hasMoreElements()) {          \r
@@ -162,41 +210,18 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
           }\r
           for (CommandThread thread : threadList) {\r
              String commandName = thread.getCommand().getCommandName();\r
-             HttpResponseWrapper response = thread.getCommandResponse();\r
+             ClientCommandResponse response = (ClientCommandResponse) thread.getCommandResponse();\r
              responseLogger.debug("Response was: " + response.getResponseString());\r
-             Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response.getResponseString());\r
-             if (Pazpar2ResponseParser.docTypes.contains(responseObject.getType())) {\r
+             ResponseDataObject responseObject = ResponseParser.getParser().getDataObject(response);\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
+               logger.info("Unknown doc type [" + responseObject.getType() + "]. Was not cached.");\r
              }\r
           }\r
-          if (commands.equals("record")) {\r
-            return pzresp.getRecord().getActiveClients();\r
-          } else {\r
-            return pzresp.getActiveClients();\r
-          }  \r
-        } else {\r
-          logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
-          pzresp.reset();\r
-          return "0";\r
+          return pzresp.getActiveClients();\r
         }\r
-      } else {\r
-        logger.error("Did not attemt to run command(s) due to a validation error.");\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
+      }  \r
     } catch (ClassCastException cce) {\r
       cce.printStackTrace();    \r
       return "";\r
@@ -213,7 +238,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
   public boolean commandsAreValid(String commands) {\r
     if (commands.equals("record")) {\r
       if (!pzreq.getCommand("record").hasParameterValue("id")) {\r
-        logger.error("Attempt to send record command without the id parameter");\r
+        logger.debug("Skips sending record command due to lacking id parameter");\r
         return false;\r
       }\r
     }\r
@@ -227,7 +252,8 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
       return "";\r
     } else {\r
       pzreq.getRecord().setId(recId);\r
-      return doCommand("record");\r
+      doCommand("record");\r
+      return pzresp.getRecord().getActiveClients();\r
     }\r
   }\r
   \r
@@ -265,25 +291,45 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     \r
   protected void handleQueryStateChanges (String commands) {\r
     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
-      logger.debug("Found pending search change. Doing search before updating " + commands);      \r
+      logger.info("Triggered search: Found pending search change, doing search before updating " + commands);      \r
       doSearch();\r
     } \r
     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").hasParameterValue("id")) {\r
-        update("record");\r
+        doRecord();\r
       } else {         \r
         pzresp.put("record", new RecordResponse());\r
       }\r
     }\r
   }\r
   \r
-  protected String doCommand(String commandName) {             \r
-    logger.debug(pzreq.getCommand(commandName).getEncodedQueryString() + ": Results for "+ pzreq.getCommand("search").getEncodedQueryString());\r
-    return update(commandName);\r
+  /**\r
+   * Validates the request then executes the command and parses the response.\r
+   * If the parsed response is of a known type it will be cached in 'pzresp'\r
+   * \r
+   * @param commandName The command to be executed\r
+   * @return An XML response parsed to form a response data object\r
+   */\r
+  protected ResponseDataObject doCommand(String commandName) {\r
+    ResponseDataObject responseObject = null; \r
+    if (validateUpdateRequest(commandName)) {\r
+      logger.debug(pzreq.getCommand(commandName).getEncodedQueryString() + ": Results for "+ pzreq.getCommand("search").getEncodedQueryString());\r
+      Pazpar2Command command = pzreq.getCommand(commandName);\r
+      long start = System.currentTimeMillis();\r
+      HttpResponseWrapper commandResponse = searchClient.executeCommand(command);\r
+      long end = System.currentTimeMillis();\r
+      logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );\r
+      responseLogger.debug("Response was: " + commandResponse.getResponseString());\r
+      responseObject = ResponseParser.getParser().getDataObject((ClientCommandResponse)commandResponse);\r
+      if (ResponseParser.docTypes.contains(responseObject.getType())) {\r
+        pzresp.put(commandName, responseObject);\r
+      }      \r
+    }\r
+    return responseObject;\r
   }\r
-  \r
+    \r
   @Override\r
   public void stateUpdated(String commandName) {\r
     logger.debug("State change reported for [" + commandName + "]");\r
@@ -327,7 +373,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     if (url!=null && searchClient != null && !url.equals(searchClient.getServiceUrl())) {\r
       pzreq.getRecord().removeParametersInState();\r
       pzreq.getSearch().removeParametersInState();\r
-      pzresp.reset();\r
+      pzresp.resetAllSessionData();\r
       user.clear();\r
       searchClient.setServiceUrl(url);\r
     }    \r
@@ -451,7 +497,8 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
   private void setServiceType(String type) {\r
     if (!serviceType.equals(type)  &&\r
         !serviceType.equals(SERVICE_TYPE_TBD)) {\r
-      resetSearchAndResults();\r
+      resetSearchAndRecordCommands();\r
+      pzresp.resetAllSessionData();\r
     }\r
     serviceType = type;\r
     if (serviceType.equals(SERVICE_TYPE_PZ2)) {\r