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