X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fpazpar2%2FPz2Bean.java;h=5b45551a1b1aa476e1899b4e901e4768ae4c60e3;hb=d739ecb22a85d8f982add6d429e069edf7e0dde2;hp=651a821bb3885c36be5b6bf29b3dcd6f47e47a9b;hpb=4a136b8b9144cbcf5f8cab0d04de8070e68a12a6;p=mkjsf-moved-to-github.git

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Bean.java b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Bean.java
index 651a821..5b45551 100644
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Bean.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Bean.java
@@ -24,7 +24,9 @@ import com.indexdata.mkjsf.errors.ConfigurationException;
 import com.indexdata.mkjsf.errors.ErrorCentral;
 import com.indexdata.mkjsf.errors.ErrorHelper;
 import com.indexdata.mkjsf.pazpar2.commands.CommandParameter;
+import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;
 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands;
+import com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommand;
 import com.indexdata.mkjsf.pazpar2.data.RecordResponse;
 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;
 import com.indexdata.mkjsf.pazpar2.data.ResponseParser;
@@ -103,22 +105,46 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     pzreq.getRecord().removeParametersInState();
     pzreq.getSearch().removeParametersInState();   
   }
-
     
   public void doSearch(String query) {
     pzreq.getSearch().setParameter(new CommandParameter("query","=",query));     
     doSearch();
   }
 
-  public void doSearch() { 
-    stateMgr.hasPendingStateChange("search",false);
-    pzresp.resetSearchResponses();
-    // resets some record and show command parameters without 
-    // changing state or creating state change feedback
-    pzreq.getRecord().removeParametersInState();        
-    pzreq.getShow().setParameterInState(new CommandParameter("start","=",0));    
-    logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommand("search").getUrlEncodedParameterValue("query"));
-    doCommand("search");    
+  public void doSearch() {
+    if (errors.hasConfigurationErrors()) {
+      logger.error("Ignoring search request due to configuration errors.");
+    } else if (searchClient == null){
+      logger.error("No search client defined. A client must either be pre-configured or selected before searching.");
+      errors.addConfigurationError(new ConfigurationError("No client defined","Client is null","No search client defined. A client must be pre-configured or selected runtime, prior to searching."));
+    } else {
+      stateMgr.hasPendingStateChange("search",false);
+      pzresp.resetSearchResponses();
+      // resets some record and show command parameters without 
+      // changing state or creating state change feedback
+      pzreq.getRecord().removeParametersInState();        
+      pzreq.getShow().setParameterInState(new CommandParameter("start","=",0));    
+      logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommand("search").getUrlEncodedParameterValue("query"));
+      searchClient.setSearchCommand(pzreq.getCommand("search"));
+      doCommand("search");
+    }
+  }
+  
+  public String doRecord() {
+    if (errors.hasConfigurationErrors()) {
+      logger.error("Ignoring record request due to configuration errors.");
+      return "";
+    } else if (!pzreq.getCommand("record").hasParameterValue("id")) {
+      logger.debug("Ignoring record request due to no id parameter.");
+      return "";
+    } else if (pzresp.getSearch().hasApplicationError()) {
+      logger.debug("Ignoring record request due search error.");
+      return "";
+    } else {
+      logger.debug("Executing record command");
+      doCommand("record");
+      return pzresp.getRecord().getActiveClients();
+    }
   }
       
   /**
@@ -128,29 +154,20 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
    */
   public String update () {
     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");
-    return update("show,stat,termlist,bytarget");
-  }
-  
-  public boolean validateUpdateRequest(String commands) {
     if (errors.hasConfigurationErrors()) {
-      logger.error("The command(s) " + commands + " are cancelled due to configuration errors.");
-      return false;
-    } else if (!commands.equals("search") && pzresp.getSearch().hasApplicationError()) {
-      logger.error("The command(s) " + commands + " are cancelled because the latest search command had an error.");
-      return false;
-    } else if (!commandsAreValid(commands)) {
-      logger.debug("The command(s) " + commands + " are cancelled because the were not found to be ready/valid.");
-      return false;
-    } else if (!hasQuery() &&  !(commands.equals("record") && pzreq.getCommand("record").hasParameterValue("recordquery"))) {
-      logger.debug("The command(s) " + commands + " are held off because there's not yet a query.");
-      return false;
+      logger.error("Ignoring show,stat,termlist,bytarget commands due to configuration errors.");
+      return "";
+    } else if (pzresp.getSearch().hasApplicationError()) {
+      logger.error("Ignoring show,stat,termlist,bytarget commands due to problem with most recent search.");
+      return "";
+    } else if (!hasQuery()) {
+      logger.debug("Ignoring show,stat,termlist,bytarget commands because there is not yet a query.");
+      return "";
     } else {
-      return true;
+      return update("show,stat,termlist,bytarget");
     }
-    
-    
   }
-   
+     
   /**
    * Refreshes the data objects listed in 'commands' from pazpar2
    * 
@@ -158,13 +175,24 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
    * @return Number of activeclients at the time of the 'show' command
    */
   public String update (String commands) {
-    logger.info("Request to update: " + commands);
+    logger.debug("Request to update: " + commands);
     try {
-      if (! validateUpdateRequest(commands)) {
-        return "0";
+      if (commands.equals("search")) {
+        doSearch();
+        return "";
+      } else if (commands.equals("record")) {
+        return doRecord();
+      } else if (pzresp.getSearch().isNew()) {
+        logger.info("New search. Marking it old, then returning 'new' to trigger another round-trip.");
+        pzresp.getSearch().setIsNew(false);
+        return "new";
       } else {
         handleQueryStateChanges(commands);
-        if (! validateUpdateRequest(commands)) {          
+        if (pzresp.getSearch().hasApplicationError()) {
+          logger.error("The command(s) " + commands + " cancelled because the latest search command had an error.");
+          return "0";
+        } else if (errors.hasConfigurationErrors()) {
+          logger.error("The command(s) " + commands + " cancelled due to configuration errors.");
           return "0";
         } else {
           logger.debug("Processing request for " + commands); 
@@ -191,22 +219,10 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
              if (ResponseParser.docTypes.contains(responseObject.getType())) {
                pzresp.put(commandName, responseObject);
              } else {
-               if (commandName.equals("record") && 
-                   (pzreq.getRecord().hasParameterValue("offset") ||
-                    pzreq.getRecord().hasParameterValue("checksum"))) {
-                 RecordResponse recordResponse = new RecordResponse();
-                 recordResponse.setType("record");
-                 recordResponse.setXml(responseObject.getXml());
-                 recordResponse.setAttribute("activeclients", "0");
-                 pzresp.put(commandName, recordResponse);
-               }
+               logger.info("Unknown doc type [" + responseObject.getType() + "]. Was not cached.");
              }
           }
-          if (commands.equals("record")) {
-            return pzresp.getRecord().getActiveClients();
-          } else {
-            return pzresp.getActiveClients();
-          }
+          return pzresp.getActiveClients();
         }
       }  
     } catch (ClassCastException cce) {
@@ -221,17 +237,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     }
     
   }
-  
-  public boolean commandsAreValid(String commands) {
-    if (commands.equals("record")) {
-      if (!pzreq.getCommand("record").hasParameterValue("id")) {
-        logger.debug("Skips sending record command due to lacking id parameter");
-        return false;
-      }
-    }
-    return true;
-  }
-                                
+                                  
   public String toggleRecord (String recId) {
     if (hasRecord(recId)) {
       pzreq.getRecord().removeParameters();  
@@ -239,7 +245,8 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
       return "";
     } else {
       pzreq.getRecord().setId(recId);
-      return doCommand("record");
+      doCommand("record");
+      return pzresp.getRecord().getActiveClients();
     }
   }
   
@@ -274,28 +281,85 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     pager =  new ResultsPager(pzresp,pageRange,pzreq);
     return pager;
   }
-    
+   
+  /**
+   * This methods main purpose is to support browser history.
+   *  
+   * When the browsers back or forward buttons are pressed, a  
+   * re-search /might/ be required - namely if the query changes.
+   * So, as the UI requests updates of the page (show,facets,
+   * etc) this method checks if a search must be executed
+   * before those updates are performed.
+   *  
+   * @see {@link com.indexdata.mkjsf.pazpar2.state.StateManager#setCurrentStateKey} 
+   * @param commands
+   */
   protected void handleQueryStateChanges (String commands) {
     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { 
-      logger.info("Triggered search: Found pending search change, doing search before updating " + commands);      
+      logger.info("Triggered search: Found pending search change [" + pzreq.getCommand("search").toString() + "], doing search before updating " + commands);      
       doSearch();
     } 
     if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        
       logger.debug("Found pending record ID change. Doing record before updating " + commands);
       stateMgr.hasPendingStateChange("record",false);
       if (pzreq.getCommand("record").hasParameterValue("id")) {
-        update("record");
+        doRecord();
       } else {         
         pzresp.put("record", new RecordResponse());
       }
     }
   }
   
-  protected String doCommand(String commandName) {             
-    logger.debug(pzreq.getCommand(commandName).getEncodedQueryString() + ": Results for "+ pzreq.getCommand("search").getEncodedQueryString());
-    return update(commandName);
+  /**
+   * Executes the command and parses the response to create data objects.
+   * If the parsed response is of a known type it will be cached in 'pzresp'
+   * 
+   * @param commandName The command to be executed
+   * @return An XML response parsed to form a response data object
+   */
+  protected ResponseDataObject doCommand(String commandName) {
+    if (pzreq.getCommand(commandName).spOnly() && isPazpar2Service()) {
+      logger.warn("Skipping " + commandName + " - SP-only command, un-supported by Pazpar2");
+      return new ResponseDataObject();
+    } else {
+      ResponseDataObject responseObject = null;     
+      logger.info("Request "+commandName + ": "+ pzreq.getCommand("search").toString());
+      Pazpar2Command command = pzreq.getCommand(commandName);
+      long start = System.currentTimeMillis();
+      HttpResponseWrapper commandResponse = searchClient.executeCommand(command);
+      long end = System.currentTimeMillis();
+      logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );
+      responseLogger.debug("Response was: " + commandResponse.getResponseString());
+      if (commandResponse.getContentType().contains("xml")) {
+        responseObject = ResponseParser.getParser().getDataObject((ClientCommandResponse)commandResponse);
+        if (ResponseParser.docTypes.contains(responseObject.getType())) {
+          logger.debug("Storing " + responseObject.getType() + " in pzresp. ");
+          pzresp.put(commandName, responseObject);
+        } else {
+          if (commandName.equals("record")) {
+            logger.debug("Command was 'record' but response not '<record>' - assuming raw record response.");
+            ResponseDataObject recordResponse = new RecordResponse(); 
+            recordResponse.setType("record");
+            recordResponse.setXml(responseObject.getXml());          
+            recordResponse.setAttribute("activeclients", "0");
+            pzresp.put("record", recordResponse); 
+          }        
+        }
+      } else if (commandResponse.isBinary()) {
+        responseObject = new RecordResponse(); 
+        responseObject.setType(commandName);
+        logger.info("Binary response");
+        responseObject.setAttribute("activeclients", "0");
+        responseObject.setXml("<record>binary response</record>");
+        responseObject.setBinary(commandResponse.getBytes());
+        pzresp.put("record", responseObject);
+      } else {
+        logger.error("Response was not found to be XML or binary. The response was not handled.");
+      }
+      return responseObject;
+    }
   }
-  
+    
   @Override
   public void stateUpdated(String commandName) {
     logger.debug("State change reported for [" + commandName + "]");
@@ -349,6 +413,17 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     return (searchClient!=null ? searchClient.getServiceUrl() : "");
   }
   
+  public void setServiceId () {
+    pzreq.getRecord().removeParametersInState();
+    pzreq.getSearch().removeParametersInState();
+    pzresp.resetSearchResponses();
+    pz2Client.setServiceId(pzreq.getInit().getService());
+  }
+  
+  public String getServiceId () {
+    return pzreq.getInit().getService();
+  }
+  
   public boolean getServiceUrlIsDefined() {
     return (searchClient != null && searchClient.hasServiceUrl());
   }
@@ -426,6 +501,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
       serviceProxyUrls = config.getMultiProperty(SERVICE_PROXY_URL_LIST,",");
       pazpar2Urls = config.getMultiProperty(PAZPAR2_URL_LIST, ",");
     }
+    logger.info(reader.document());
     logger.info("Service Type is configured to " + serviceType);
     
   }