Service proxy client and configuration schemes
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / pz2utils4jsf / pazpar2 / Pz2Session.java
index b4323fc..f35523e 100644 (file)
@@ -11,51 +11,64 @@ import javax.inject.Named;
 \r
 import org.apache.log4j.Logger;\r
 \r
-import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException;\r
-import com.indexdata.pz2utils4jsf.config.Pz2Configurator;\r
+import com.indexdata.pz2utils4jsf.config.ConfigurationReader;\r
 import com.indexdata.pz2utils4jsf.controls.ResultsPager;\r
+import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
+import com.indexdata.pz2utils4jsf.errors.ErrorHelper;\r
+import com.indexdata.pz2utils4jsf.errors.ErrorInterface;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget;\r
+import com.indexdata.pz2utils4jsf.pazpar2.data.CommandError;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseData;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseParser;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.RecordResponse;\r
+import com.indexdata.pz2utils4jsf.pazpar2.data.SearchResponse;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.ShowResponse;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.StatResponse;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.TermListsResponse;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.TermResponse;\r
 import com.indexdata.pz2utils4jsf.pazpar2.state.QueryStates;\r
+import com.indexdata.pz2utils4jsf.utils.Utils;\r
 \r
-@Named\r
-@SessionScoped\r
+@Named @SessionScoped  \r
 public class Pz2Session implements Pz2Interface {\r
-  \r
+    \r
+  private static final long serialVersionUID = 3947514708343320514L;\r
   private static Logger logger = Logger.getLogger(Pz2Session.class);\r
   \r
   private Map<String,Pazpar2ResponseData> dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
   private QueryStates queryStates = new QueryStates();\r
+  private ErrorHelper errorHelper = null;\r
   \r
-  private static final long serialVersionUID = 3947514708343320514L;  \r
-  private com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration cfg = null;\r
-  private com.indexdata.masterkey.pazpar2.client.Pazpar2Client client = null;   \r
+  private List<ErrorInterface> configurationErrors = null;\r
+  private SearchClient searchClient = null;   \r
   private TargetFilter targetFilter = null;  \r
   private ResultsPager pager = null; \r
-      \r
+    \r
   public Pz2Session () {\r
-    logger.debug("Instantiating pz2 session object");      \r
+    logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]");      \r
   }\r
     \r
-  public void init(Pz2Configurator pz2conf) {\r
-    if (client==null) {\r
-    logger.debug("Initiating a session holding object ");\r
+  public void init(SearchClient searchClient, ConfigurationReader configReader) {\r
+    configurationErrors = new ArrayList<ErrorInterface>();\r
+    errorHelper = new ErrorHelper(configReader);    \r
+    logger.debug(Utils.objectId(this) + " will configure search client for the session");\r
     try {\r
-      cfg = new com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration(pz2conf.getConfig());\r
-      client = new com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric(cfg);\r
-      resetDataObjects();\r
-    } catch (ProxyErrorException e) {\r
-      e.printStackTrace();\r
-    }        \r
-    } else {\r
-      logger.error("??? attempt to initiate session but already has a client");\r
-    }\r
+      searchClient.configure(configReader);            \r
+      // At the time of writing this search client is injected using Weld. \r
+      // However, the client is used for asynchronously sending off requests\r
+      // to the server AND propagation of context to threads is currently \r
+      // not supported. Trying to do so throws a WELD-001303 error. \r
+      // To avoid that, a context free client is cloned from the context \r
+      // dependent one. \r
+      // If propagation to threads gets supported, the cloning can go. \r
+      this.searchClient = searchClient.cloneMe();\r
+      \r
+    } catch (ConfigurationException e) {\r
+      // TODO: set errors\r
+      logger.info("Found " + configurationErrors.size() + " configuration errors");    \r
+    } \r
+    logger.info(configReader.document());\r
+    resetDataObjects();\r
   }\r
     \r
   public void doSearch(String query) {\r
@@ -67,7 +80,7 @@ public class Pz2Session implements Pz2Interface {
     queryStates.hasPendingStateChange("search",false);\r
     resetDataObjects();\r
     setCommandParameter("show",new CommandParameter("start","=",0));    \r
-    logger.info("Searching using "+getCommand("search").getParameter("query").getEncodedQueryString());\r
+    logger.debug(Utils.objectId(this) + " is searching using "+getCommand("search").getParameter("query").getEncodedQueryString());\r
     doCommand("search");    \r
   }\r
       \r
@@ -77,10 +90,10 @@ public class Pz2Session implements Pz2Interface {
    * @return Number of activeclients at the time of the 'show' command.\r
    */\r
   public String update () {\r
-    logger.info("Updating show,stat,termlist, and bytarget data from pazpar2");\r
+    logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
     return update("show,stat,termlist,bytarget");\r
   }\r
\r
+   \r
   /**\r
    * Refreshes the data objects listed in 'commands' from pazpar2\r
    * \r
@@ -88,33 +101,40 @@ public class Pz2Session implements Pz2Interface {
    * @return Number of activeclients at the time of the 'show' command\r
    */\r
   public String update (String commands) {\r
-    if (hasQuery()) {\r
-      handleQueryStateChanges(commands);\r
-      logger.debug("Processing request for " + commands); \r
-      List<CommandThread> threadList = new ArrayList<CommandThread>();\r
-      StringTokenizer tokens = new StringTokenizer(commands,",");\r
-      while (tokens.hasMoreElements()) {\r
-        threadList.add(new CommandThread(getCommand(tokens.nextToken()),client));            \r
-      }\r
-      for (CommandThread thread : threadList) {\r
-        thread.start();\r
-      }\r
-      for (CommandThread thread : threadList) {\r
-        try {\r
-          thread.join();\r
-        } catch (InterruptedException e) {\r
-          e.printStackTrace();\r
+    if (! hasConfigurationErrors()) {\r
+      if (hasQuery()) {\r
+        handleQueryStateChanges(commands);\r
+        logger.debug("Processing request for " + commands); \r
+        List<CommandThread> threadList = new ArrayList<CommandThread>();\r
+        StringTokenizer tokens = new StringTokenizer(commands,",");\r
+        while (tokens.hasMoreElements()) {\r
+          threadList.add(new CommandThread(getCommand(tokens.nextToken()),searchClient));            \r
         }\r
-      }\r
-      for (CommandThread thread : threadList) {\r
-        if (!thread.getCommand().getName().equals("search")) {\r
-          dataObjects.put(thread.getCommand().getName(), new Pazpar2ResponseParser().getObject(thread.getResponse()));\r
+        for (CommandThread thread : threadList) {\r
+          thread.start();\r
+        }\r
+        for (CommandThread thread : threadList) {\r
+          try {\r
+            thread.join();\r
+          } catch (InterruptedException e) {\r
+            e.printStackTrace();\r
+          }\r
         }\r
+        for (CommandThread thread : threadList) {\r
+           String commandName = thread.getCommand().getName();\r
+           String response = thread.getResponse();\r
+           logger.debug("Response was: " + response);\r
+           Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);\r
+           dataObjects.put(commandName, responseObject);        \r
+        }\r
+        return getActiveClients();\r
+      } else {\r
+        logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
+        resetDataObjects();\r
+        return "0";\r
       }\r
-      return getActiveClients();\r
     } else {\r
-      logger.info("Skipped requests for " + commands + " as there's not yet a query."); \r
-      resetDataObjects();\r
+      logger.error("Did not attempt to execute query since there are configuration errors.");\r
       return "0";\r
     }\r
     \r
@@ -261,10 +281,60 @@ public class Pz2Session implements Pz2Interface {
     return queryStates.getCurrentStateKey();\r
   }\r
       \r
-  public void setCurrentStateKey(String key) {\r
-    logger.debug("************** request to set state key to: [" + key + "]");    \r
+  public void setCurrentStateKey(String key) {       \r
     queryStates.setCurrentStateKey(key);\r
   }\r
+  \r
+  public boolean hasConfigurationErrors () {\r
+      return (configurationErrors.size()>0);      \r
+  }\r
+  \r
+  public boolean hasCommandErrors () {\r
+    if (dataObjects.get("search").hasApplicationError()) {\r
+      logger.info("Error detected in search");\r
+      return true;\r
+    }\r
+    for (String name : dataObjects.keySet()) {\r
+      if (dataObjects.get(name).hasApplicationError()) {\r
+        logger.info("Error detected in " + name);\r
+        return true;\r
+      }\r
+    }    \r
+    return false;    \r
+  }\r
+  \r
+  /**\r
+   * Returns true if application error found in any response data objects \r
+   */\r
+  public boolean hasErrors () {\r
+    return hasConfigurationErrors() || hasCommandErrors();\r
+  }\r
+\r
+  public List<ErrorInterface> getConfigurationErrors() {    \r
+    return configurationErrors;\r
+  }\r
+  \r
+  /**\r
+   * Returns a search command error, if any, otherwise the first\r
+   * error found for an arbitrary command, if any, otherwise\r
+   * an empty dummy error. \r
+   */    \r
+  public ErrorInterface getCommandError() {\r
+    CommandError error = new CommandError();    \r
+    if (dataObjects.get("search").hasApplicationError()) {\r
+      error = dataObjects.get("search").getApplicationError();                        \r
+    } else {\r
+      for (String name : dataObjects.keySet()) {     \r
+        if (dataObjects.get(name).hasApplicationError()) {     \r
+          error = dataObjects.get(name).getApplicationError(); \r
+          break;\r
+        } \r
+      }\r
+    }\r
+    error.setErrorHelper(errorHelper);\r
+    return error;         \r
+  }\r
+\r
     \r
   private boolean hasTargetFilter(TargetFilter targetFilter) {\r
     return hasTargetFilter() && targetFilter.equals(this.targetFilter);\r
@@ -292,6 +362,10 @@ public class Pz2Session implements Pz2Interface {
     return pager;\r
   }\r
   \r
+  protected ErrorHelper getTroubleshooter() {\r
+    return errorHelper;\r
+  }\r
+  \r
   private void handleQueryStateChanges (String commands) {\r
     if (queryStates.hasPendingStateChange("search")) { \r
       logger.debug("Found pending search change. Doing search before updating " + commands);\r
@@ -309,9 +383,9 @@ public class Pz2Session implements Pz2Interface {
     }    \r
   }\r
 \r
-  private String getActiveClients() {\r
-    logger.debug("Active clients: "+getShow().getActiveClients());\r
+  private String getActiveClients() {    \r
     if (getShow()!=null) {\r
+      logger.debug("Active clients: "+getShow().getActiveClients());\r
       return getShow().getActiveClients();\r
     } else {\r
       return "";\r
@@ -370,20 +444,21 @@ public class Pz2Session implements Pz2Interface {
     return defaultValue;    \r
   }\r
 \r
-  private String doCommand(String commandName) {\r
+  private String doCommand(String commandName) {      \r
     Pazpar2Command command = getCommand(commandName);    \r
     logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString());\r
-    return update(commandName);\r
+    return update(commandName);      \r
   }\r
   \r
   private void resetDataObjects() {\r
-    logger.debug("Resetting show,stat,termlist,bytarget response objects.");\r
+    logger.debug("Resetting show,stat,termlist,bytarget,search response objects.");\r
     dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
     dataObjects.put("show", new ShowResponse());\r
     dataObjects.put("stat", new StatResponse());\r
     dataObjects.put("termlist", new TermListsResponse());\r
     dataObjects.put("bytarget", new ByTarget());\r
     dataObjects.put("record", new RecordResponse());\r
+    dataObjects.put("search", new SearchResponse());\r
   }\r
-\r
+  \r
 }\r