X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fpazpar2%2FPz2Bean.java;h=8e3a14dfe7333c5015ac780553f7759fbf4e62c9;hb=5745961a862c1f07e9abcb084f43c205f01631be;hp=6185dae456837067237f0cad876d612894a033e3;hpb=276aaa580bd666864bd64031e6553074fab7bf65;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 6185dae..8e3a14d 100644
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Bean.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Bean.java
@@ -1,6 +1,8 @@
 package com.indexdata.mkjsf.pazpar2;
 
 import java.io.Serializable;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashMap;
@@ -10,8 +12,11 @@ import java.util.StringTokenizer;
 
 import javax.annotation.PostConstruct;
 import javax.enterprise.context.SessionScoped;
+import javax.enterprise.inject.Produces;
+import javax.faces.context.FacesContext;
 import javax.inject.Inject;
 import javax.inject.Named;
+import javax.inject.Qualifier;
 
 import org.apache.log4j.Logger;
 
@@ -23,13 +28,11 @@ import com.indexdata.mkjsf.errors.ConfigurationError;
 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.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.data.RecordResponse;
-import com.indexdata.mkjsf.pazpar2.sp.auth.ServiceProxyUser;
 import com.indexdata.mkjsf.pazpar2.state.StateListener;
 import com.indexdata.mkjsf.pazpar2.state.StateManager;
 import com.indexdata.mkjsf.utils.Utils;
@@ -49,18 +52,17 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
 
 
   private static final long serialVersionUID = 3440277287081557861L;
-  private static Logger logger = Logger.getLogger(Pz2Bean.class);
-  private static Logger responseLogger = Logger.getLogger("com.indexdata.mkjsf.pazpar2.responses");   
+  private static Logger logger = Logger.getLogger(Pz2Bean.class);     
   protected Pz2Client pz2Client = null;
   protected ServiceProxyClient spClient = null;
   protected SearchClient searchClient = null;  
     
   @Inject ConfigurationReader configurator;
-  @Inject StateManager stateMgr;
-  @Inject Pazpar2Commands pzreq;
-  @Inject Responses pzresp;
-  @Inject ErrorCentral errors;
-  @Inject ServiceProxyUser user;
+  
+  private StateManager stateMgr = null;
+  private Pazpar2Commands pzreq = null;
+  private Responses pzresp = null;
+  private ErrorCentral errors = null;  
   
   protected ResultsPager pager = null; 
   
@@ -70,9 +72,21 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     logger.info("Instantiating pz2 bean [" + Utils.objectId(this) + "]");    
   }
   
+  public static Pz2Bean get() {
+    FacesContext context = FacesContext.getCurrentInstance();
+    return (Pz2Bean) context.getApplication().evaluateExpressionGet(context, "#{pz2}", Object.class); 
+  }
+  
   @PostConstruct
-  public void postConstruct() {    
-    logger.debug("Pz2Bean post-construct: Configurator is " + configurator);
+  public void postConstruct() {
+    logger.info("Pz2Bean PostConstruct of " + this);
+    stateMgr = new StateManager();
+    pzreq = new Pazpar2Commands();
+    pzresp = new Responses();    
+    errors = new ErrorCentral(); 
+    pzresp.setErrorHelper(errors.getHelper());
+    
+    logger.debug("Pz2Bean PostConstruct: Configurator is " + configurator);
     logger.debug(Utils.objectId(this) + " will instantiate a Pz2Client next.");
     pz2Client = new Pz2Client();
     configureClient(pz2Client,configurator);
@@ -85,7 +99,35 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
       e.printStackTrace();
     }    
     stateMgr.addStateListener(this);    
-  }  
+  }
+  
+  @Qualifier
+  @Target({java.lang.annotation.ElementType.TYPE,
+           java.lang.annotation.ElementType.METHOD,
+           java.lang.annotation.ElementType.PARAMETER,
+           java.lang.annotation.ElementType.FIELD})
+  @Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
+  public  @interface Preferred{}
+  
+  @Produces @Preferred @SessionScoped @Named("pzresp") public Responses getPzresp () {
+    logger.trace("Producing pzresp");
+    return pzresp;
+  }
+  
+  @Produces @Preferred @SessionScoped @Named("pzreq") public Pazpar2Commands getPzreq () {
+    logger.trace("Producing pzreq");
+    return pzreq;
+  }
+  
+  @Produces @Preferred @SessionScoped @Named("errors") public ErrorCentral getErrors() {
+    logger.trace("Producing errors");
+    return errors;
+  }
+  
+  @Produces @Preferred @SessionScoped @Named("stateMgr") public StateManager getStateMgr() {
+    logger.trace("Producing stateMgr");
+    return stateMgr;
+  }
   
   public void configureClient(SearchClient client, ConfigurationReader configReader) {
     logger.debug(Utils.objectId(this) + " will configure search client for the session");
@@ -96,30 +138,12 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
       errors.addConfigurationError(new ConfigurationError("Search Client","Configuration",e.getMessage()));                
     } 
     logger.info(configReader.document());
-    pzresp.reset();    
+    pzresp.getSp().resetAuthAndBeyond(true);    
   }
   
-  public void resetSearchAndResults () {
+  public void resetSearchAndRecordCommands () {
     pzreq.getRecord().removeParametersInState();
-    pzreq.getSearch().removeParametersInState();
-    pzresp.reset();    
-  }
-
-    
-  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");    
+    pzreq.getSearch().removeParametersInState();   
   }
       
   /**
@@ -129,26 +153,55 @@ 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")) {
+        pzreq.getSearch().run();
+        return "new";
+      } else if (commands.equals("record")) {
+        pzreq.getRecord().run();
+        return pzresp.getRecord().getActiveClients();
+      } 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,",");
           while (tokens.hasMoreElements()) {          
-            threadList.add(new CommandThread(pzreq.getCommand(tokens.nextToken()),searchClient));            
+            threadList.add(new CommandThread(pzreq.getCommand(tokens.nextToken()),searchClient,Pz2Bean.get().getPzresp()));            
           }
           for (CommandThread thread : threadList) {
             thread.start();
@@ -160,43 +213,9 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
               e.printStackTrace();
             }
           }
-          for (CommandThread thread : threadList) {
-             String commandName = thread.getCommand().getCommandName();
-             HttpResponseWrapper response = thread.getCommandResponse();
-             responseLogger.debug("Response was: " + response.getResponseString());
-             ResponseDataObject responseObject = ResponseParser.getParser().getDataObject(response.getResponseString());
-             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);
-               }
-             }
-          }
-          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.debug("Did not attempt to run command(s) that were not ready.");
-        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 +228,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("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 +236,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 +272,53 @@ 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);      
-      doSearch();
+      logger.info("Triggered search: Found pending search change [" + pzreq.getCommand("search").toString() + "], doing search before updating " + commands);      
+      pzreq.getSearch().run();
     } 
     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");
-      } else {         
-        pzresp.put("record", new RecordResponse());
-      }
+      pzreq.getRecord().run();
     }
   }
   
-  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) {
+    Pazpar2Command command = pzreq.getCommand(commandName);
+    if (command.spOnly() && isPazpar2Service()) {
+      logger.warn("Skipping " + commandName + " - SP-only command, not supported by Pazpar2");
+      return new ResponseDataObject();
+    } else {
+      logger.info("Request "+commandName + ". Search command is: "+ pzreq.getCommand("search").toString());      
+      long start = System.currentTimeMillis();
+      ResponseDataObject responseObject = command.run();      
+      long end = System.currentTimeMillis();
+      logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );
+      return responseObject;
+    }
   }
-  
+    
   @Override
   public void stateUpdated(String commandName) {
     logger.debug("State change reported for [" + commandName + "]");
@@ -327,8 +362,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();
-      user.clear();
+      pzresp.getSp().resetAuthAndBeyond(true);      
       searchClient.setServiceUrl(url);
     }    
   }
@@ -337,6 +371,17 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     return (searchClient!=null ? searchClient.getServiceUrl() : "");
   }
   
+  public void setServiceId () {
+    pzreq.getRecord().removeParametersInState();
+    pzreq.getSearch().removeParametersInState();
+    pzresp.resetSearchAndBeyond();
+    pz2Client.setServiceId(pzreq.getInit().getService());
+  }
+  
+  public String getServiceId () {
+    return pzreq.getInit().getService();
+  }
+  
   public boolean getServiceUrlIsDefined() {
     return (searchClient != null && searchClient.hasServiceUrl());
   }
@@ -414,6 +459,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 +497,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.getSp().resetAuthAndBeyond(true);
     }
     serviceType = type;
     if (serviceType.equals(SERVICE_TYPE_PZ2)) {
@@ -466,4 +513,8 @@ public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Seria
     }
   }
   
+  public SearchClient getSearchClient() {
+    return searchClient;
+  }
+  
 }