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