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 SingleTargetFilter singleTargetFilter = 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     removeCommand("record");\r
  82     setCommandParameter("show",new CommandParameter("start","=",0));    \r
  83     logger.debug(Utils.objectId(this) + " is searching using "+getCommand("search").getParameter("query").getEncodedQueryString());\r
  84     doCommand("search");    \r
  85   }\r
  86       \r
  87   /**\r
  88    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
  89    * \r
  90    * @return Number of activeclients at the time of the 'show' command.\r
  91    */\r
  92   public String update () {\r
  93     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
  94     return update("show,stat,termlist,bytarget");\r
  95   }\r
  96    \r
  97   /**\r
  98    * Refreshes the data objects listed in 'commands' from pazpar2\r
  99    * \r
 100    * @param commands\r
 101    * @return Number of activeclients at the time of the 'show' command\r
 102    */\r
 103   public String update (String commands) {\r
 104     if (! hasConfigurationErrors()) {\r
 105       if (hasQuery()) {\r
 106         handleQueryStateChanges(commands);\r
 107         logger.debug("Processing request for " + commands); \r
 108         List<CommandThread> threadList = new ArrayList<CommandThread>();\r
 109         StringTokenizer tokens = new StringTokenizer(commands,",");\r
 110         while (tokens.hasMoreElements()) {\r
 111           threadList.add(new CommandThread(getCommand(tokens.nextToken()),searchClient));            \r
 112         }\r
 113         for (CommandThread thread : threadList) {\r
 114           thread.start();\r
 115         }\r
 116         for (CommandThread thread : threadList) {\r
 117           try {\r
 118             thread.join();\r
 119           } catch (InterruptedException e) {\r
 120             e.printStackTrace();\r
 121           }\r
 122         }\r
 123         for (CommandThread thread : threadList) {\r
 124            String commandName = thread.getCommand().getName();\r
 125            String response = thread.getResponse();\r
 126            logger.debug("Response was: " + response);\r
 127            Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);\r
 128            dataObjects.put(commandName, responseObject);        \r
 129         }\r
 130         if (commands.equals("record")) {\r
 131           logger.debug("Record: Active clients: "+getRecord().getActiveClients());\r
 132           return getRecord().getActiveClients();\r
 133         } else {\r
 134           return getActiveClients();\r
 135         }  \r
 136       } else {\r
 137         logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
 138         resetDataObjects();\r
 139         return "0";\r
 140       }\r
 141     } else {\r
 142       logger.error("Did not attempt to execute query since there are configuration errors.");\r
 143       return "0";\r
 144     }\r
 145     \r
 146   }\r
 147         \r
 148   public void setQuery (String query) {\r
 149     logger.debug("Creating new command parameter for " + query);\r
 150     setCommandParameter("search",new CommandParameter("query","=",query));\r
 151   }\r
 152   \r
 153   public String getQuery () {\r
 154     return getCommandParameterValueSimple("search","query",null);\r
 155   }\r
 156   \r
 157   public void setFacet (String facetKey, String term) {           \r
 158     if (term != null && term.length()>0) {\r
 159       queryStates.getCurrentState().setCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
 160       doSearch();\r
 161     }            \r
 162   }\r
 163   \r
 164   public void setFacetOnQuery (String facetKey, String term) {\r
 165     String facetExpression = facetKey + "=" + term;    \r
 166     if (term != null && term.length()>0) {\r
 167       setCommandParameter("search",new CommandParameter("query","=", getQuery() + " and " + facetExpression));\r
 168       doSearch();        \r
 169     }            \r
 170   }\r
 171       \r
 172   public void removeFacet(String facetKey, String term) {\r
 173     queryStates.getCurrentState().removeCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
 174     doSearch();\r
 175   }\r
 176   \r
 177   public void setSingleTargetFilter (String targetId, String targetName) {    \r
 178     if (hasSingleTargetFilter(new SingleTargetFilter(targetId,targetName))) {\r
 179       logger.debug("Already using target filter " + this.singleTargetFilter.getFilterExpression());\r
 180     } else {      \r
 181       this.singleTargetFilter = new SingleTargetFilter(targetId,targetName);\r
 182       setCommandParameter("search",new CommandParameter("filter","=",this.singleTargetFilter.getFilterExpression()));      \r
 183       doSearch();\r
 184     }    \r
 185   }\r
 186 \r
 187   public SingleTargetFilter getSingleTargetFilter () {\r
 188     return singleTargetFilter;\r
 189   }\r
 190     \r
 191   public void removeSingleTargetFilter () {\r
 192     logger.debug("Removing target filter " + singleTargetFilter.getFilterExpression());\r
 193     this.singleTargetFilter = null;\r
 194     removeCommandParameter("search","filter");         \r
 195     doSearch();\r
 196   }\r
 197   \r
 198   public boolean hasSingleTargetFilter() {\r
 199     return singleTargetFilter != null;    \r
 200   }\r
 201         \r
 202   public void setSort (String sortOption) {\r
 203     logger.debug("Setting sort option: " + sortOption);\r
 204     setCommandParameter("show",new CommandParameter("sort","=",sortOption));\r
 205     update("show");\r
 206   }\r
 207   \r
 208   public String getSort () {\r
 209     return getCommandParameterValue("show","sort","relevance");\r
 210   }\r
 211     \r
 212   public void setPageSize (int perPageOption) {\r
 213     if (getPageSize()!=perPageOption) {\r
 214      logger.debug("Setting perpage option to " + perPageOption + " and resetting start page.");\r
 215      setCommandParameter("show",new CommandParameter("num","=",perPageOption));\r
 216      setCommandParameter("show",new CommandParameter("start","=",0));\r
 217      update("show");\r
 218     } else {\r
 219       logger.debug("Not updating page size, already is " + perPageOption);\r
 220     }\r
 221   }\r
 222   \r
 223   public int getPageSize () {\r
 224     return getCommandParameterValue("show","num",20);\r
 225   }\r
 226   \r
 227   public void setStart (int start) {\r
 228     logger.debug("Setting start num to " + start);\r
 229     setCommandParameter("show", new CommandParameter("start","=",start));  \r
 230     update("show");\r
 231   }\r
 232   \r
 233   public int getStart() {\r
 234     return getCommandParameterValue("show","start",0);\r
 235   }\r
 236           \r
 237   public String toggleRecord (String recId) {\r
 238     if (hasRecord(recId)) {\r
 239       removeCommand("record");  \r
 240       dataObjects.put("record", new RecordResponse());\r
 241       return "";\r
 242     } else {\r
 243       setRecordId(recId);\r
 244       return doCommand("record");\r
 245     }\r
 246   }\r
 247   \r
 248   @Override\r
 249   public void setRecordId(String recId) {\r
 250     setCommandParameter("record",new CommandParameter("id","=",recId));\r
 251   }\r
 252   \r
 253   @Override\r
 254   public String getRecordId () {\r
 255     return getCommandParameterValue("record","recid","");\r
 256   }\r
 257   \r
 258   @Override\r
 259   public boolean hasRecord (String recId) {\r
 260     return getCommand("record").hasParameters() && getRecord().getRecId().equals(recId);\r
 261   }\r
 262       \r
 263   public ShowResponse getShow () {\r
 264     return ((ShowResponse) dataObjects.get("show"));\r
 265   }\r
 266   \r
 267   public StatResponse getStat () {\r
 268     return ((StatResponse) dataObjects.get("stat"));\r
 269   }\r
 270   \r
 271   public RecordResponse getRecord() {\r
 272     return ((RecordResponse) dataObjects.get("record"));\r
 273   }\r
 274   \r
 275   public TermListsResponse getTermLists () {\r
 276     return ((TermListsResponse) dataObjects.get("termlist"));\r
 277   }\r
 278   \r
 279   public List<TermResponse> getFacetTerms (String facet, int count) {\r
 280     return (getTermLists().getTermList(facet).getTerms(count));\r
 281   }\r
 282     \r
 283   public List<TermResponse> getFacetTerms (String facet) {\r
 284     return (getTermLists().getTermList(facet).getTerms());\r
 285   }\r
 286   \r
 287   public ByTarget getByTarget() {\r
 288     return ((ByTarget) dataObjects.get("bytarget"));\r
 289   }\r
 290   \r
 291   \r
 292   public String getCurrentStateKey () {    \r
 293     return queryStates.getCurrentStateKey();\r
 294   }\r
 295       \r
 296   public void setCurrentStateKey(String key) {       \r
 297     queryStates.setCurrentStateKey(key);\r
 298   }\r
 299   \r
 300   public boolean hasConfigurationErrors () {\r
 301       return (configurationErrors.size()>0);      \r
 302   }\r
 303   \r
 304   public boolean hasCommandErrors () {\r
 305     if (dataObjects.get("search").hasApplicationError()) {\r
 306       logger.info("Error detected in search");\r
 307       return true;\r
 308     }\r
 309     for (String name : dataObjects.keySet()) {\r
 310       if (dataObjects.get(name).hasApplicationError()) {\r
 311         logger.info("Error detected in " + name);\r
 312         return true;\r
 313       }\r
 314     }    \r
 315     return false;    \r
 316   }\r
 317   \r
 318   /**\r
 319    * Returns true if application error found in any response data objects \r
 320    */\r
 321   public boolean hasErrors () {\r
 322     return hasConfigurationErrors() || hasCommandErrors();\r
 323   }\r
 324 \r
 325   public List<ErrorInterface> getConfigurationErrors() {    \r
 326     return configurationErrors;\r
 327   }\r
 328   \r
 329   /**\r
 330    * Returns a search command error, if any, otherwise the first\r
 331    * error found for an arbitrary command, if any, otherwise\r
 332    * an empty dummy error. \r
 333    */    \r
 334   public ErrorInterface getCommandError() {\r
 335     CommandError error = new CommandError();    \r
 336     if (dataObjects.get("search").hasApplicationError()) {\r
 337       error = dataObjects.get("search").getApplicationError();                        \r
 338     } else {\r
 339       for (String name : dataObjects.keySet()) {     \r
 340         if (dataObjects.get(name).hasApplicationError()) {     \r
 341           error = dataObjects.get(name).getApplicationError(); \r
 342           break;\r
 343         } \r
 344       }\r
 345     }\r
 346     error.setErrorHelper(errorHelper);\r
 347     return error;         \r
 348   }\r
 349 \r
 350     \r
 351   protected boolean hasSingleTargetFilter(SingleTargetFilter targetFilter) {\r
 352     return hasSingleTargetFilter() && targetFilter.equals(this.singleTargetFilter);\r
 353   }\r
 354   \r
 355   protected boolean hasQuery() {\r
 356     return !(getCommand("search").getParameter("query") == null);\r
 357   }\r
 358     \r
 359   public boolean hasRecords () {\r
 360     return getStat().getRecords() > 0            \r
 361            && getShow().getHits() != null \r
 362            && getShow().getHits().size()>0;\r
 363   }\r
 364     \r
 365   public ResultsPager getPager () {\r
 366     if (pager == null) {\r
 367       pager = new ResultsPager(this);      \r
 368     } \r
 369     return pager;      \r
 370   }\r
 371   \r
 372   public ResultsPager setPager (int pageRange) {\r
 373     pager =  new ResultsPager(this,pageRange);\r
 374     return pager;\r
 375   }\r
 376   \r
 377   protected ErrorHelper getTroubleshooter() {\r
 378     return errorHelper;\r
 379   }\r
 380   \r
 381   protected void handleQueryStateChanges (String commands) {\r
 382     if (queryStates.hasPendingStateChange("search")) { \r
 383       logger.debug("Found pending search change. Doing search before updating " + commands);      \r
 384       doSearch();\r
 385     } \r
 386     if (queryStates.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 387       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 388       queryStates.hasPendingStateChange("record",false);\r
 389       if (getCommand("record").hasParameters()) {\r
 390         update("record");\r
 391       } else {\r
 392         removeCommand("record");  \r
 393         dataObjects.put("record", new RecordResponse());\r
 394       }\r
 395     }    \r
 396   }\r
 397 \r
 398   protected String getActiveClients() {    \r
 399     if (getShow()!=null) {\r
 400       logger.debug("Active clients: "+getShow().getActiveClients());\r
 401       return getShow().getActiveClients();\r
 402     } else {\r
 403       return "";\r
 404     }\r
 405   }\r
 406 \r
 407   protected Pazpar2Command getCommand(String name) {\r
 408     return queryStates.getCurrentState().getCommand(name);\r
 409   }\r
 410   \r
 411   protected void setCommandParameter(String commandName, CommandParameter parameter) {\r
 412     logger.debug("Setting parameter for " + commandName + ": " + parameter);\r
 413     queryStates.getCurrentState().setCommandParameter(commandName, parameter, queryStates);    \r
 414   }\r
 415   \r
 416   \r
 417   protected void removeCommandParameter(String commandName, String parameterName) {\r
 418     queryStates.getCurrentState().removeCommandParameter(commandName,parameterName,queryStates);    \r
 419   }\r
 420   \r
 421   protected void removeCommand (String commandName) {\r
 422     queryStates.getCurrentState().removeCommand(commandName, queryStates);\r
 423   }\r
 424     \r
 425   protected String getCommandParameterValue (String commandName, String parameterName, String defaultValue) {    \r
 426     Pazpar2Command command = getCommand(commandName);\r
 427     if (command != null) {\r
 428       CommandParameter parameter = command.getParameter(parameterName);\r
 429       if (parameter != null) {\r
 430         return parameter.getValueWithExpressions();\r
 431       }\r
 432     }\r
 433     return defaultValue;    \r
 434   }\r
 435   \r
 436   protected String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) {    \r
 437     Pazpar2Command command = getCommand(commandName);\r
 438     if (command != null) {\r
 439       CommandParameter parameter = command.getParameter(parameterName);\r
 440       if (parameter != null) {\r
 441         return parameter.getSimpleValue();\r
 442       }\r
 443     }\r
 444     return defaultValue;    \r
 445   }\r
 446 \r
 447   \r
 448   protected int getCommandParameterValue (String commandName, String parameterName, int defaultValue) {\r
 449     Pazpar2Command command = getCommand(commandName);\r
 450     if (command != null) {\r
 451       CommandParameter parameter = command.getParameter(parameterName);\r
 452       if (parameter != null) {\r
 453         return Integer.parseInt(parameter.getSimpleValue());\r
 454       }\r
 455     }\r
 456     return defaultValue;    \r
 457   }\r
 458 \r
 459   protected String doCommand(String commandName) {     \r
 460     Pazpar2Command command = getCommand(commandName);    \r
 461     logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString());\r
 462     return update(commandName);\r
 463   }\r
 464   \r
 465   protected void resetDataObjects() {\r
 466     logger.debug("Resetting show,stat,termlist,bytarget,search response objects.");\r
 467     dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
 468     dataObjects.put("show", new ShowResponse());\r
 469     dataObjects.put("stat", new StatResponse());\r
 470     dataObjects.put("termlist", new TermListsResponse());\r
 471     dataObjects.put("bytarget", new ByTarget());\r
 472     dataObjects.put("record", new RecordResponse());\r
 473     dataObjects.put("search", new SearchResponse());\r
 474   }\r
 475 \r
 476   @Override\r
 477   public void setFilter(String filterExpression) {\r
 478     logger.debug("Setting filter to " + filterExpression);\r
 479     setCommandParameter("search",new CommandParameter("filter","=",filterExpression));    \r
 480   }\r
 481   \r
 482   public String getFilter() {\r
 483     return getCommandParameterValueSimple("search", "filter", "");\r
 484   }\r
 485   \r
 486   public boolean hasFilter () {\r
 487     return getFilter().length()>0;\r
 488   }\r
 489   \r
 490 }\r