src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Session.java

   1 package com.indexdata.pz2utils4jsf.pazpar2;\r
   2 \r
   3 import java.util.ArrayList;\r
   4 import java.util.List;\r
   5 import java.util.Map;\r
   6 import java.util.StringTokenizer;\r
   7 import java.util.concurrent.ConcurrentHashMap;\r
   8 \r
   9 import javax.enterprise.context.SessionScoped;\r
  10 import javax.inject.Named;\r
  11 \r
  12 import org.apache.log4j.Logger;\r
  13 \r
  14 import com.indexdata.pz2utils4jsf.config.Pz2Configurator;\r
  15 import com.indexdata.pz2utils4jsf.controls.ResultsPager;\r
  16 import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
  17 import com.indexdata.pz2utils4jsf.errors.ErrorHelper;\r
  18 import com.indexdata.pz2utils4jsf.errors.ErrorInterface;\r
  19 import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget;\r
  20 import com.indexdata.pz2utils4jsf.pazpar2.data.CommandError;\r
  21 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseData;\r
  22 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseParser;\r
  23 import com.indexdata.pz2utils4jsf.pazpar2.data.RecordResponse;\r
  24 import com.indexdata.pz2utils4jsf.pazpar2.data.SearchResponse;\r
  25 import com.indexdata.pz2utils4jsf.pazpar2.data.ShowResponse;\r
  26 import com.indexdata.pz2utils4jsf.pazpar2.data.StatResponse;\r
  27 import com.indexdata.pz2utils4jsf.pazpar2.data.TermListsResponse;\r
  28 import com.indexdata.pz2utils4jsf.pazpar2.data.TermResponse;\r
  29 import com.indexdata.pz2utils4jsf.pazpar2.state.QueryStates;\r
  30 import com.indexdata.pz2utils4jsf.utils.Utils;\r
  31 \r
  32 @Named @SessionScoped  \r
  33 public class Pz2Session implements Pz2Interface {\r
  34     \r
  35   private static final long serialVersionUID = 3947514708343320514L;\r
  36   private static Logger logger = Logger.getLogger(Pz2Session.class);\r
  37   \r
  38   private Map<String,Pazpar2ResponseData> dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
  39   private QueryStates queryStates = new QueryStates();\r
  40   private ErrorHelper errorHelper = null;\r
  41   \r
  42   private List<ErrorInterface> configurationErrors = null;\r
  43   private SearchClient searchClient = null;   \r
  44   private TargetFilter targetFilter = null;  \r
  45   private ResultsPager pager = null; \r
  46     \r
  47   public Pz2Session () {\r
  48     logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]");      \r
  49   }\r
  50     \r
  51   public void init(SearchClient searchClient, Pz2Configurator configurator) {\r
  52     configurationErrors = new ArrayList<ErrorInterface>();\r
  53     errorHelper = new ErrorHelper(configurator);    \r
  54     logger.debug(Utils.objectId(this) + " will configure search client for the session");\r
  55     try {\r
  56       searchClient.configure(configurator);\r
  57       \r
  58       // The cloning is a hack: \r
  59       // At the time of writing this search client is injected using Weld. \r
  60       // However, the client is used for asynchronously sending off requests\r
  61       // to the server AND propagation of context to threads is not supported.\r
  62       // Trying so will throw a WELD-001303 error. To avoid that, a context\r
  63       // free client is spawned from the context dependent one. \r
  64       this.searchClient = searchClient.cloneMe();\r
  65       \r
  66     } catch (ConfigurationException e) {\r
  67       logger.info("Found " + configurationErrors.size() + " configuration errors");    \r
  68     }        \r
  69     resetDataObjects();\r
  70   }\r
  71     \r
  72   public void doSearch(String query) {\r
  73     setCommandParameter("search",new CommandParameter("query","=",query));     \r
  74     doSearch();\r
  75   }\r
  76 \r
  77   public void doSearch() { \r
  78     queryStates.hasPendingStateChange("search",false);\r
  79     resetDataObjects();\r
  80     setCommandParameter("show",new CommandParameter("start","=",0));    \r
  81     logger.debug(Utils.objectId(this) + " is searching using "+getCommand("search").getParameter("query").getEncodedQueryString());\r
  82     doCommand("search");    \r
  83   }\r
  84       \r
  85   /**\r
  86    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
  87    * \r
  88    * @return Number of activeclients at the time of the 'show' command.\r
  89    */\r
  90   public String update () {\r
  91     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
  92     return update("show,stat,termlist,bytarget");\r
  93   }\r
  94    \r
  95   /**\r
  96    * Refreshes the data objects listed in 'commands' from pazpar2\r
  97    * \r
  98    * @param commands\r
  99    * @return Number of activeclients at the time of the 'show' command\r
 100    */\r
 101   public String update (String commands) {\r
 102     if (! hasConfigurationErrors()) {\r
 103       if (hasQuery()) {\r
 104         handleQueryStateChanges(commands);\r
 105         logger.debug("Processing request for " + commands); \r
 106         List<CommandThread> threadList = new ArrayList<CommandThread>();\r
 107         StringTokenizer tokens = new StringTokenizer(commands,",");\r
 108         while (tokens.hasMoreElements()) {\r
 109           threadList.add(new CommandThread(getCommand(tokens.nextToken()),searchClient));            \r
 110         }\r
 111         for (CommandThread thread : threadList) {\r
 112           thread.start();\r
 113         }\r
 114         for (CommandThread thread : threadList) {\r
 115           try {\r
 116             thread.join();\r
 117           } catch (InterruptedException e) {\r
 118             e.printStackTrace();\r
 119           }\r
 120         }\r
 121         for (CommandThread thread : threadList) {\r
 122            String commandName = thread.getCommand().getName();\r
 123            String response = thread.getResponse();\r
 124            logger.debug("Response was: " + response);\r
 125            Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);\r
 126            dataObjects.put(commandName, responseObject);        \r
 127         }\r
 128         return getActiveClients();\r
 129       } else {\r
 130         logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
 131         resetDataObjects();\r
 132         return "0";\r
 133       }\r
 134     } else {\r
 135       logger.error("Did not attempt to execute query since there are configuration errors.");\r
 136       return "0";\r
 137     }\r
 138     \r
 139   }\r
 140         \r
 141   public void setQuery (String query) {\r
 142     logger.debug("Creating new command parameter for " + query);\r
 143     setCommandParameter("search",new CommandParameter("query","=",query));\r
 144   }\r
 145   \r
 146   public String getQuery () {\r
 147     return getCommandParameterValueSimple("search","query",null);\r
 148   }\r
 149   \r
 150   public void setFacet (String facetKey, String term) {           \r
 151     if (term != null && term.length()>0) {\r
 152       queryStates.getCurrentState().setCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
 153       doSearch();\r
 154     }            \r
 155   }\r
 156   \r
 157   public void setFacetOnQuery (String facetKey, String term) {\r
 158     String facetExpression = facetKey + "=" + term;    \r
 159     if (term != null && term.length()>0) {\r
 160       setCommandParameter("search",new CommandParameter("query","=", getQuery() + " and " + facetExpression));\r
 161       doSearch();        \r
 162     }            \r
 163   }\r
 164       \r
 165   public void removeFacet(String facetKey, String term) {\r
 166     queryStates.getCurrentState().removeCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
 167     doSearch();\r
 168   }\r
 169   \r
 170   public void setTargetFilter (String targetId, String targetName) {    \r
 171     if (hasTargetFilter(new TargetFilter(targetId,targetName))) {\r
 172       logger.debug("Already using target filter " + this.targetFilter.getFilterExpression());\r
 173     } else {      \r
 174       this.targetFilter = new TargetFilter(targetId,targetName);\r
 175       setCommandParameter("search",new CommandParameter("filter","=",this.targetFilter.getFilterExpression()));      \r
 176       doSearch();\r
 177     }    \r
 178   }\r
 179 \r
 180   public TargetFilter getTargetFilter () {\r
 181     return targetFilter;\r
 182   }\r
 183     \r
 184   public void removeTargetFilter () {\r
 185     logger.debug("Removing target filter " + targetFilter.getFilterExpression());\r
 186     this.targetFilter = null;\r
 187     removeCommandParameter("search","filter");         \r
 188     doSearch();\r
 189   }\r
 190   \r
 191   public boolean hasTargetFilter() {\r
 192     return targetFilter != null;    \r
 193   }\r
 194         \r
 195   public void setSort (String sortOption) {\r
 196     logger.debug("Setting sort option: " + sortOption);\r
 197     setCommandParameter("show",new CommandParameter("sort","=",sortOption));\r
 198     update("show");\r
 199   }\r
 200   \r
 201   public String getSort () {\r
 202     return getCommandParameterValue("show","sort","relevance");\r
 203   }\r
 204     \r
 205   public void setPageSize (int perPageOption) {\r
 206     if (getPageSize()!=perPageOption) {\r
 207      logger.debug("Setting perpage option to " + perPageOption + " and resetting start page.");\r
 208      setCommandParameter("show",new CommandParameter("num","=",perPageOption));\r
 209      setCommandParameter("show",new CommandParameter("start","=",0));\r
 210      update("show");\r
 211     } else {\r
 212       logger.debug("Not updating page size, already is " + perPageOption);\r
 213     }\r
 214   }\r
 215   \r
 216   public int getPageSize () {\r
 217     return getCommandParameterValue("show","num",20);\r
 218   }\r
 219   \r
 220   public void setStart (int start) {\r
 221     logger.debug("Setting start num to " + start);\r
 222     setCommandParameter("show", new CommandParameter("start","=",start));  \r
 223     update("show");\r
 224   }\r
 225   \r
 226   public int getStart() {\r
 227     return getCommandParameterValue("show","start",0);\r
 228   }\r
 229         \r
 230   public String toggleRecord (String recId) {\r
 231     if (hasRecord(recId)) {\r
 232       removeCommand("record");  \r
 233       dataObjects.put("record", new RecordResponse());\r
 234       return "";\r
 235     } else {\r
 236       return updateRecord(recId);\r
 237     }\r
 238   }\r
 239   \r
 240   private String updateRecord(String recId) {    \r
 241     setCommandParameter("record",new CommandParameter("id","=",recId));    \r
 242     return doCommand("record");    \r
 243   }\r
 244   \r
 245   public boolean hasRecord (String recId) {\r
 246     return getCommand("record").hasParameters() && getRecord().getRecId().equals(recId);\r
 247   }\r
 248       \r
 249   public ShowResponse getShow () {\r
 250     return ((ShowResponse) dataObjects.get("show"));\r
 251   }\r
 252   \r
 253   public StatResponse getStat () {\r
 254     return ((StatResponse) dataObjects.get("stat"));\r
 255   }\r
 256   \r
 257   public RecordResponse getRecord() {\r
 258     return ((RecordResponse) dataObjects.get("record"));\r
 259   }\r
 260   \r
 261   public TermListsResponse getTermLists () {\r
 262     return ((TermListsResponse) dataObjects.get("termlist"));\r
 263   }\r
 264   \r
 265   public List<TermResponse> getFacetTerms (String facet, int count) {\r
 266     return (getTermLists().getTermList(facet).getTerms(count));\r
 267   }\r
 268     \r
 269   public List<TermResponse> getFacetTerms (String facet) {\r
 270     return (getTermLists().getTermList(facet).getTerms());\r
 271   }\r
 272   \r
 273   public ByTarget getByTarget() {\r
 274     return ((ByTarget) dataObjects.get("bytarget"));\r
 275   }\r
 276   \r
 277   \r
 278   public String getCurrentStateKey () {    \r
 279     return queryStates.getCurrentStateKey();\r
 280   }\r
 281       \r
 282   public void setCurrentStateKey(String key) {       \r
 283     queryStates.setCurrentStateKey(key);\r
 284   }\r
 285   \r
 286   public boolean hasConfigurationErrors () {\r
 287       return (configurationErrors.size()>0);      \r
 288   }\r
 289   \r
 290   public boolean hasCommandErrors () {\r
 291     if (dataObjects.get("search").hasApplicationError()) {\r
 292       logger.info("Error detected in search");\r
 293       return true;\r
 294     }\r
 295     for (String name : dataObjects.keySet()) {\r
 296       if (dataObjects.get(name).hasApplicationError()) {\r
 297         logger.info("Error detected in " + name);\r
 298         return true;\r
 299       }\r
 300     }    \r
 301     return false;    \r
 302   }\r
 303   \r
 304   /**\r
 305    * Returns true if application error found in any response data objects \r
 306    */\r
 307   public boolean hasErrors () {\r
 308     return hasConfigurationErrors() || hasCommandErrors();\r
 309   }\r
 310 \r
 311   public List<ErrorInterface> getConfigurationErrors() {    \r
 312     return configurationErrors;\r
 313   }\r
 314   \r
 315   /**\r
 316    * Returns a search command error, if any, otherwise the first\r
 317    * error found for an arbitrary command, if any, otherwise\r
 318    * an empty dummy error. \r
 319    */    \r
 320   public ErrorInterface getCommandError() {\r
 321     CommandError error = new CommandError();    \r
 322     if (dataObjects.get("search").hasApplicationError()) {\r
 323       error = dataObjects.get("search").getApplicationError();                        \r
 324     } else {\r
 325       for (String name : dataObjects.keySet()) {     \r
 326         if (dataObjects.get(name).hasApplicationError()) {     \r
 327           error = dataObjects.get(name).getApplicationError(); \r
 328           break;\r
 329         } \r
 330       }\r
 331     }\r
 332     error.setErrorHelper(errorHelper);\r
 333     return error;         \r
 334   }\r
 335 \r
 336     \r
 337   private boolean hasTargetFilter(TargetFilter targetFilter) {\r
 338     return hasTargetFilter() && targetFilter.equals(this.targetFilter);\r
 339   }\r
 340   \r
 341   private boolean hasQuery() {\r
 342     return !(getCommand("search").getParameter("query") == null);\r
 343   }\r
 344     \r
 345   public boolean hasRecords () {\r
 346     return getStat().getRecords() > 0            \r
 347            && getShow().getHits() != null \r
 348            && getShow().getHits().size()>0;\r
 349   }\r
 350     \r
 351   public ResultsPager getPager () {\r
 352     if (pager == null) {\r
 353       pager = new ResultsPager(this);      \r
 354     } \r
 355     return pager;      \r
 356   }\r
 357   \r
 358   public ResultsPager setPager (int pageRange) {\r
 359     pager =  new ResultsPager(this,pageRange);\r
 360     return pager;\r
 361   }\r
 362   \r
 363   protected ErrorHelper getTroubleshooter() {\r
 364     return errorHelper;\r
 365   }\r
 366   \r
 367   private void handleQueryStateChanges (String commands) {\r
 368     if (queryStates.hasPendingStateChange("search")) { \r
 369       logger.debug("Found pending search change. Doing search before updating " + commands);\r
 370       doSearch();\r
 371     } \r
 372     if (queryStates.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 373       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 374       queryStates.hasPendingStateChange("record",false);\r
 375       if (getCommand("record").hasParameters()) {\r
 376         updateRecord(getCommand("record").getParameter("id").getSimpleValue());\r
 377       } else {\r
 378         removeCommand("record");  \r
 379         dataObjects.put("record", new RecordResponse());\r
 380       }\r
 381     }    \r
 382   }\r
 383 \r
 384   private String getActiveClients() {    \r
 385     if (getShow()!=null) {\r
 386       logger.debug("Active clients: "+getShow().getActiveClients());\r
 387       return getShow().getActiveClients();\r
 388     } else {\r
 389       return "";\r
 390     }\r
 391   }\r
 392 \r
 393   private Pazpar2Command getCommand(String name) {\r
 394     return queryStates.getCurrentState().getCommand(name);\r
 395   }\r
 396   \r
 397   private void setCommandParameter(String commandName, CommandParameter parameter) {\r
 398     logger.debug("Setting parameter for " + commandName + ": " + parameter);\r
 399     queryStates.getCurrentState().setCommandParameter(commandName, parameter, queryStates);    \r
 400   }\r
 401   \r
 402   \r
 403   private void removeCommandParameter(String commandName, String parameterName) {\r
 404     queryStates.getCurrentState().removeCommandParameter(commandName,parameterName,queryStates);    \r
 405   }\r
 406   \r
 407   private void removeCommand (String commandName) {\r
 408     queryStates.getCurrentState().removeCommand(commandName, queryStates);\r
 409   }\r
 410     \r
 411   private String getCommandParameterValue (String commandName, String parameterName, String defaultValue) {    \r
 412     Pazpar2Command command = getCommand(commandName);\r
 413     if (command != null) {\r
 414       CommandParameter parameter = command.getParameter(parameterName);\r
 415       if (parameter != null) {\r
 416         return parameter.getValueWithExpressions();\r
 417       }\r
 418     }\r
 419     return defaultValue;    \r
 420   }\r
 421   \r
 422   private String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) {    \r
 423     Pazpar2Command command = getCommand(commandName);\r
 424     if (command != null) {\r
 425       CommandParameter parameter = command.getParameter(parameterName);\r
 426       if (parameter != null) {\r
 427         return parameter.getSimpleValue();\r
 428       }\r
 429     }\r
 430     return defaultValue;    \r
 431   }\r
 432 \r
 433   \r
 434   private int getCommandParameterValue (String commandName, String parameterName, int defaultValue) {\r
 435     Pazpar2Command command = getCommand(commandName);\r
 436     if (command != null) {\r
 437       CommandParameter parameter = command.getParameter(parameterName);\r
 438       if (parameter != null) {\r
 439         return Integer.parseInt(parameter.getSimpleValue());\r
 440       }\r
 441     }\r
 442     return defaultValue;    \r
 443   }\r
 444 \r
 445   private String doCommand(String commandName) {      \r
 446     Pazpar2Command command = getCommand(commandName);    \r
 447     logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString());\r
 448     return update(commandName);      \r
 449   }\r
 450   \r
 451   private void resetDataObjects() {\r
 452     logger.debug("Resetting show,stat,termlist,bytarget,search response objects.");\r
 453     dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
 454     dataObjects.put("show", new ShowResponse());\r
 455     dataObjects.put("stat", new StatResponse());\r
 456     dataObjects.put("termlist", new TermListsResponse());\r
 457     dataObjects.put("bytarget", new ByTarget());\r
 458     dataObjects.put("record", new RecordResponse());\r
 459     dataObjects.put("search", new SearchResponse());\r
 460   }\r
 461   \r
 462 }\r