X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fpazpar2%2FPz2Bean.java;h=29d9280f4b8177296ccfca047aea0c62de7c6f53;hb=056883036f0be0d1bf0a06d0f5842d382239adf9;hp=03bd096471393839aaec80ce52ed4048643ebef5;hpb=038cea23aa13e84430b55dda29fdea9fdf64828d;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 03bd096..29d9280 100644
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Bean.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Bean.java
@@ -24,11 +24,13 @@ 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.data.Pazpar2ResponseData;
-import com.indexdata.mkjsf.pazpar2.data.Pazpar2ResponseParser;
-import com.indexdata.mkjsf.pazpar2.data.Pazpar2Responses;
+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;
+import com.indexdata.mkjsf.pazpar2.data.Responses;
 import com.indexdata.mkjsf.pazpar2.sp.auth.ServiceProxyUser;
 import com.indexdata.mkjsf.pazpar2.state.StateListener;
 import com.indexdata.mkjsf.pazpar2.state.StateManager;
@@ -58,7 +60,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
   @Inject ConfigurationReader configurator;
   @Inject StateManager stateMgr;
   @Inject Pazpar2Commands pzreq;
-  @Inject Pazpar2Responses pzresp;
+  @Inject Responses pzresp;
   @Inject ErrorCentral errors;
   @Inject ServiceProxyUser user;
   
@@ -96,30 +98,53 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
       errors.addConfigurationError(new ConfigurationError("Search Client","Configuration",e.getMessage()));                
     } 
     logger.info(configReader.document());
-    pzresp.reset();    
+    pzresp.resetAllSessionData();    
   }
   
-  public void resetSearchAndResults () {
+  public void resetSearchAndRecordCommands () {
     pzreq.getRecord().removeParametersInState();
-    pzreq.getSearch().removeParametersInState();
-    pzresp.reset();    
+    pzreq.getSearch().removeParametersInState();   
   }
-
     
   public void doSearch(String query) {
     pzreq.getSearch().setParameter(new CommandParameter("query","=",query));     
     doSearch();
   }
 
-  public void doSearch() { 
-    stateMgr.hasPendingStateChange("search",false);
-    pzresp.reset();
-    // 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();
+    }
   }
       
   /**
@@ -129,21 +154,49 @@ 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");
+    if (errors.hasConfigurationErrors()) {
+      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 update("show,stat,termlist,bytarget");
+    }
   }
-   
+     
   /**
    * Refreshes the data objects listed in 'commands' from pazpar2
    * 
    * @param commands
-   * @return Number of activeclients at the time of the 'show' command
+   * @return Number of activeclients at the time of the 'show' command,
+   *         or 'new' if search was just initiated.
    */
   public String update (String commands) {
+    logger.debug("Request to update: " + commands);
     try {
-    if (! errors.hasConfigurationErrors()) {
-      if (commandsAreValid(commands)) {
-        if (hasQuery() || (commands.equals("record") && pzreq.getCommand("record").hasParameterValue("recordquery"))) {
-          handleQueryStateChanges(commands);
+      if (commands.equals("search")) {
+        doSearch();
+        return "new";
+      } else if (commands.equals("record")) {
+        return doRecord();
+      } else if (pzresp.getSearch().isNew()) {
+        // For returning notification of 'search started' quickly to UI
+        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 (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); 
           List<CommandThread> threadList = new ArrayList<CommandThread>();
           StringTokenizer tokens = new StringTokenizer(commands,",");
@@ -162,41 +215,18 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
           }
           for (CommandThread thread : threadList) {
              String commandName = thread.getCommand().getCommandName();
-             CommandResponse response = thread.getCommandResponse();
+             ClientCommandResponse response = (ClientCommandResponse) thread.getCommandResponse();
              responseLogger.debug("Response was: " + response.getResponseString());
-             Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response.getResponseString());
-             if (Pazpar2ResponseParser.docTypes.contains(responseObject.getType())) {
+             ResponseDataObject responseObject = ResponseParser.getParser().getDataObject(response);
+             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();
-          }  
-        } else {
-          logger.debug("Skipped requests for " + commands + " as there's not yet a query."); 
-          pzresp.reset();
-          return "0";
+          return pzresp.getActiveClients();
         }
-      } else {
-        logger.error("Did not attemt to run command(s) due to a validation error.");
-        return "0";
-      }
-    } else {      
-      logger.error("Did not attempt to execute query since there are configuration errors.");
-      return "0";
-    }
+      }  
     } catch (ClassCastException cce) {
       cce.printStackTrace();    
       return "";
@@ -209,17 +239,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.error("Attempt to send record command without the id parameter");
-        return false;
-      }
-    }
-    return true;
-  }
-                                
+                                  
   public String toggleRecord (String recId) {
     if (hasRecord(recId)) {
       pzreq.getRecord().removeParameters();  
@@ -227,7 +247,8 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
       return "";
     } else {
       pzreq.getRecord().setId(recId);
-      return doCommand("record");
+      doCommand("record");
+      return pzresp.getRecord().getActiveClients();
     }
   }
   
@@ -262,28 +283,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.debug("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 + "]");
@@ -327,7 +405,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     if (url!=null && searchClient != null && !url.equals(searchClient.getServiceUrl())) {
       pzreq.getRecord().removeParametersInState();
       pzreq.getSearch().removeParametersInState();
-      pzresp.reset();
+      pzresp.resetAllSessionData();
       user.clear();
       searchClient.setServiceUrl(url);
     }    
@@ -337,6 +415,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());
   }
@@ -414,6 +503,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);
     
   }
@@ -451,7 +541,8 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
   private void setServiceType(String type) {
     if (!serviceType.equals(type)  &&
         !serviceType.equals(SERVICE_TYPE_TBD)) {
-      resetSearchAndResults();
+      resetSearchAndRecordCommands();
+      pzresp.resetAllSessionData();
     }
     serviceType = type;
     if (serviceType.equals(SERVICE_TYPE_PZ2)) {