src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Bean.java

   1 package com.indexdata.mkjsf.pazpar2;\r
   2 \r
   3 import java.io.Serializable;\r
   4 import java.util.ArrayList;\r
   5 import java.util.Arrays;\r
   6 import java.util.HashMap;\r
   7 import java.util.List;\r
   8 import java.util.Map;\r
   9 import java.util.StringTokenizer;\r
  10 \r
  11 import javax.annotation.PostConstruct;\r
  12 import javax.enterprise.context.SessionScoped;\r
  13 import javax.inject.Inject;\r
  14 import javax.inject.Named;\r
  15 \r
  16 import org.apache.log4j.Logger;\r
  17 \r
  18 import com.indexdata.mkjsf.config.Configurable;\r
  19 import com.indexdata.mkjsf.config.Configuration;\r
  20 import com.indexdata.mkjsf.config.ConfigurationReader;\r
  21 import com.indexdata.mkjsf.controls.ResultsPager;\r
  22 import com.indexdata.mkjsf.errors.ConfigurationError;\r
  23 import com.indexdata.mkjsf.errors.ConfigurationException;\r
  24 import com.indexdata.mkjsf.errors.ErrorCentral;\r
  25 import com.indexdata.mkjsf.errors.ErrorHelper;\r
  26 import com.indexdata.mkjsf.pazpar2.commands.CommandParameter;\r
  27 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;\r
  28 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands;\r
  29 import com.indexdata.mkjsf.pazpar2.data.RecordResponse;\r
  30 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;\r
  31 import com.indexdata.mkjsf.pazpar2.data.ResponseParser;\r
  32 import com.indexdata.mkjsf.pazpar2.data.Responses;\r
  33 import com.indexdata.mkjsf.pazpar2.sp.auth.ServiceProxyUser;\r
  34 import com.indexdata.mkjsf.pazpar2.state.StateListener;\r
  35 import com.indexdata.mkjsf.pazpar2.state.StateManager;\r
  36 import com.indexdata.mkjsf.utils.Utils;\r
  37 \r
  38 @Named("pz2") @SessionScoped\r
  39 public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Serializable {\r
  40 \r
  41   private static final String MODULE_NAME = "service";\r
  42   private static String SERVICE_TYPE_TBD = "TBD", SERVICE_TYPE_PZ2 = "PZ2", SERVICE_TYPE_SP = "SP";\r
  43   private static final List<String> serviceTypes = \r
  44                 Arrays.asList(SERVICE_TYPE_PZ2,SERVICE_TYPE_SP,SERVICE_TYPE_TBD);\r
  45   private String serviceType = SERVICE_TYPE_TBD;\r
  46   private List<String> serviceProxyUrls = new ArrayList<String>();\r
  47   public static final String SERVICE_PROXY_URL_LIST = "SERVICE_PROXY_URL_LIST";\r
  48   private List<String> pazpar2Urls = new ArrayList<String>();\r
  49   public static final String PAZPAR2_URL_LIST = "PAZPAR2_URL_LIST";\r
  50 \r
  51 \r
  52   private static final long serialVersionUID = 3440277287081557861L;\r
  53   private static Logger logger = Logger.getLogger(Pz2Bean.class);\r
  54   private static Logger responseLogger = Logger.getLogger("com.indexdata.mkjsf.pazpar2.responses");   \r
  55   protected Pz2Client pz2Client = null;\r
  56   protected ServiceProxyClient spClient = null;\r
  57   protected SearchClient searchClient = null;  \r
  58     \r
  59   @Inject ConfigurationReader configurator;\r
  60   @Inject StateManager stateMgr;\r
  61   @Inject Pazpar2Commands pzreq;\r
  62   @Inject Responses pzresp;\r
  63   @Inject ErrorCentral errors;\r
  64   @Inject ServiceProxyUser user;\r
  65   \r
  66   protected ResultsPager pager = null; \r
  67   \r
  68   protected ErrorHelper errorHelper = null;\r
  69               \r
  70   public Pz2Bean () {\r
  71     logger.info("Instantiating pz2 bean [" + Utils.objectId(this) + "]");    \r
  72   }\r
  73   \r
  74   @PostConstruct\r
  75   public void postConstruct() {    \r
  76     logger.debug("Pz2Bean post-construct: Configurator is " + configurator);\r
  77     logger.debug(Utils.objectId(this) + " will instantiate a Pz2Client next.");\r
  78     pz2Client = new Pz2Client();\r
  79     configureClient(pz2Client,configurator);\r
  80     spClient = new ServiceProxyClient();\r
  81     configureClient(spClient,configurator);\r
  82     try {\r
  83       this.configure(configurator);\r
  84     } catch (ConfigurationException e) {\r
  85       logger.error("There was a problem configuring the Pz2Bean (\"pz2\")");\r
  86       e.printStackTrace();\r
  87     }    \r
  88     stateMgr.addStateListener(this);    \r
  89   }  \r
  90   \r
  91   public void configureClient(SearchClient client, ConfigurationReader configReader) {\r
  92     logger.debug(Utils.objectId(this) + " will configure search client for the session");\r
  93     try {\r
  94       client.configure(configReader);            \r
  95     } catch (ConfigurationException e) {\r
  96       logger.debug("Pz2Bean adding configuration error");\r
  97       errors.addConfigurationError(new ConfigurationError("Search Client","Configuration",e.getMessage()));                \r
  98     } \r
  99     logger.info(configReader.document());\r
 100     pzresp.resetAllSessionData();    \r
 101   }\r
 102   \r
 103   public void resetSearchAndRecordCommands () {\r
 104     pzreq.getRecord().removeParametersInState();\r
 105     pzreq.getSearch().removeParametersInState();   \r
 106   }\r
 107     \r
 108   public void doSearch(String query) {\r
 109     pzreq.getSearch().setParameter(new CommandParameter("query","=",query));     \r
 110     doSearch();\r
 111   }\r
 112 \r
 113   public void doSearch() {\r
 114     if (errors.hasConfigurationErrors()) {\r
 115       logger.error("Ignoring search request due to configuration errors.");\r
 116     } else if (searchClient == null){\r
 117       logger.error("No search client defined. A client must either be pre-configured or selected before searching.");\r
 118       errors.addConfigurationError(new ConfigurationError("No client defined","Client is null","No search client defined. A client must be pre-configured or selected runtime, prior to searching."));\r
 119     } else {\r
 120       stateMgr.hasPendingStateChange("search",false);\r
 121       pzresp.resetSearchResponses();\r
 122       // resets some record and show command parameters without \r
 123       // changing state or creating state change feedback\r
 124       pzreq.getRecord().removeParametersInState();        \r
 125       pzreq.getShow().setParameterInState(new CommandParameter("start","=",0));    \r
 126       logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommand("search").getUrlEncodedParameterValue("query"));\r
 127       searchClient.setSearchCommand(pzreq.getCommand("search"));\r
 128       doCommand("search");\r
 129     }\r
 130   }\r
 131   \r
 132   public String doRecord() {\r
 133     if (errors.hasConfigurationErrors()) {\r
 134       logger.error("Ignoring record request due to configuration errors.");\r
 135       return "";\r
 136     } else if (!pzreq.getCommand("record").hasParameterValue("id")) {\r
 137       logger.debug("Ignoring record request due to no id parameter.");\r
 138       return "";\r
 139     } else if (pzresp.getSearch().hasApplicationError()) {\r
 140       logger.debug("Ignoring record request due search error.");\r
 141       return "";\r
 142     } else {\r
 143       logger.debug("Executing record command");\r
 144       doCommand("record");\r
 145       return pzresp.getRecord().getActiveClients();\r
 146     }\r
 147   }\r
 148       \r
 149   /**\r
 150    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
 151    * \r
 152    * @return Number of activeclients at the time of the 'show' command.\r
 153    */\r
 154   public String update () {\r
 155     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
 156     if (errors.hasConfigurationErrors()) {\r
 157       logger.error("Ignoring show,stat,termlist,bytarget commands due to configuration errors.");\r
 158       return "";\r
 159     } else if (pzresp.getSearch().hasApplicationError()) {\r
 160       logger.error("Ignoring show,stat,termlist,bytarget commands due to problem with most recent search.");\r
 161       return "";\r
 162     } else if (!hasQuery()) {\r
 163       logger.error("Ignoring show,stat,termlist,bytarget commands because there is not yet a query.");\r
 164       return "";\r
 165     } else {\r
 166       return update("show,stat,termlist,bytarget");\r
 167     }\r
 168   }\r
 169      \r
 170   /**\r
 171    * Refreshes the data objects listed in 'commands' from pazpar2\r
 172    * \r
 173    * @param commands\r
 174    * @return Number of activeclients at the time of the 'show' command\r
 175    */\r
 176   public String update (String commands) {\r
 177     logger.info("Request to update: " + commands);\r
 178     try {\r
 179       if (commands.equals("search")) {\r
 180         doSearch();\r
 181         return "";\r
 182       } else if (commands.equals("record")) {\r
 183         return doRecord();\r
 184       } else if (pzresp.getSearch().isNew()) {\r
 185         logger.info("New search. Marking it old, then returning 'new' to trigger another round-trip.");\r
 186         pzresp.getSearch().setIsNew(false);\r
 187         return "new";\r
 188       } else {\r
 189         handleQueryStateChanges(commands);\r
 190         if (pzresp.getSearch().hasApplicationError()) {\r
 191           logger.error("The command(s) " + commands + " cancelled because the latest search command had an error.");\r
 192           return "0";\r
 193         } else if (errors.hasConfigurationErrors()) {\r
 194           logger.error("The command(s) " + commands + " cancelled due to configuration errors.");\r
 195           return "0";\r
 196         } else {\r
 197           logger.debug("Processing request for " + commands); \r
 198           \r
 199           List<CommandThread> threadList = new ArrayList<CommandThread>();\r
 200           StringTokenizer tokens = new StringTokenizer(commands,",");\r
 201           while (tokens.hasMoreElements()) {          \r
 202             threadList.add(new CommandThread(pzreq.getCommand(tokens.nextToken()),searchClient));            \r
 203           }\r
 204           for (CommandThread thread : threadList) {\r
 205             thread.start();\r
 206           }\r
 207           for (CommandThread thread : threadList) {\r
 208             try {\r
 209               thread.join();\r
 210             } catch (InterruptedException e) {\r
 211               e.printStackTrace();\r
 212             }\r
 213           }\r
 214           for (CommandThread thread : threadList) {\r
 215              String commandName = thread.getCommand().getCommandName();\r
 216              ClientCommandResponse response = (ClientCommandResponse) thread.getCommandResponse();\r
 217              responseLogger.debug("Response was: " + response.getResponseString());\r
 218              ResponseDataObject responseObject = ResponseParser.getParser().getDataObject(response);\r
 219              if (ResponseParser.docTypes.contains(responseObject.getType())) {\r
 220                pzresp.put(commandName, responseObject);\r
 221              } else {\r
 222                logger.info("Unknown doc type [" + responseObject.getType() + "]. Was not cached.");\r
 223              }\r
 224           }\r
 225           return pzresp.getActiveClients();\r
 226         }\r
 227       }  \r
 228     } catch (ClassCastException cce) {\r
 229       cce.printStackTrace();    \r
 230       return "";\r
 231     } catch (NullPointerException npe) {\r
 232       npe.printStackTrace();\r
 233       return "";\r
 234     } catch (Exception e) {\r
 235       e.printStackTrace();\r
 236       return "";\r
 237     }\r
 238     \r
 239   }\r
 240                                   \r
 241   public String toggleRecord (String recId) {\r
 242     if (hasRecord(recId)) {\r
 243       pzreq.getRecord().removeParameters();  \r
 244       pzresp.put("record", new RecordResponse());\r
 245       return "";\r
 246     } else {\r
 247       pzreq.getRecord().setId(recId);\r
 248       doCommand("record");\r
 249       return pzresp.getRecord().getActiveClients();\r
 250     }\r
 251   }\r
 252   \r
 253   @Override\r
 254   public boolean hasRecord (String recId) {\r
 255     return pzreq.getCommand("record").hasParameters() && pzresp.getRecord().getRecId().equals(recId);\r
 256   }\r
 257         \r
 258   public String getCurrentStateKey () {    \r
 259     return stateMgr.getCurrentState().getKey();\r
 260   }\r
 261       \r
 262   public void setCurrentStateKey(String key) {       \r
 263     stateMgr.setCurrentStateKey(key);\r
 264   }\r
 265       \r
 266   protected boolean hasQuery() {        \r
 267     return pzreq.getCommand("search").hasParameterValue("query"); \r
 268   }\r
 269     \r
 270     \r
 271   @Override\r
 272   public ResultsPager getPager () {\r
 273     if (pager == null) {\r
 274       pager = new ResultsPager(pzresp);      \r
 275     } \r
 276     return pager;      \r
 277   }\r
 278   \r
 279   @Override\r
 280   public ResultsPager setPager (int pageRange) {\r
 281     pager =  new ResultsPager(pzresp,pageRange,pzreq);\r
 282     return pager;\r
 283   }\r
 284    \r
 285   /**\r
 286    * This methods main purpose is to support browser history.\r
 287    *  \r
 288    * When the browsers back or forward buttons are pressed, a  \r
 289    * re-search /might/ be required - namely if the query changes.\r
 290    * So, as the UI requests updates of the page (show,facets,\r
 291    * etc) this method checks if a search must be executed\r
 292    * before those updates are performed.\r
 293    *  \r
 294    * @see {@link com.indexdata.mkjsf.pazpar2.state.StateManager#setCurrentStateKey} \r
 295    * @param commands\r
 296    */\r
 297   protected void handleQueryStateChanges (String commands) {\r
 298     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
 299       logger.info("Triggered search: Found pending search change [" + pzreq.getCommand("search").toString() + "], doing search before updating " + commands);      \r
 300       doSearch();\r
 301     } \r
 302     if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 303       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 304       stateMgr.hasPendingStateChange("record",false);\r
 305       if (pzreq.getCommand("record").hasParameterValue("id")) {\r
 306         doRecord();\r
 307       } else {         \r
 308         pzresp.put("record", new RecordResponse());\r
 309       }\r
 310     }\r
 311   }\r
 312   \r
 313   /**\r
 314    * Validates the request then executes the command and parses the response.\r
 315    * If the parsed response is of a known type it will be cached in 'pzresp'\r
 316    * \r
 317    * @param commandName The command to be executed\r
 318    * @return An XML response parsed to form a response data object\r
 319    */\r
 320   protected ResponseDataObject doCommand(String commandName) {\r
 321     ResponseDataObject responseObject = null;     \r
 322     logger.info("Request "+commandName + ": "+ pzreq.getCommand("search").toString());\r
 323     Pazpar2Command command = pzreq.getCommand(commandName);\r
 324     long start = System.currentTimeMillis();\r
 325     HttpResponseWrapper commandResponse = searchClient.executeCommand(command);\r
 326     long end = System.currentTimeMillis();\r
 327     logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );\r
 328     responseLogger.debug("Response was: " + commandResponse.getResponseString());\r
 329     if (commandResponse.getContentType().contains("xml")) {\r
 330       responseObject = ResponseParser.getParser().getDataObject((ClientCommandResponse)commandResponse);\r
 331       if (ResponseParser.docTypes.contains(responseObject.getType())) {\r
 332         logger.debug("Storing " + responseObject.getType() + " in pzresp. ");\r
 333         pzresp.put(commandName, responseObject);\r
 334       } else {\r
 335         if (commandName.equals("record")) {\r
 336           logger.debug("Command was 'record' but response not '<record>' - assuming raw record response.");\r
 337           ResponseDataObject recordResponse = new RecordResponse(); \r
 338           recordResponse.setType("record");\r
 339           recordResponse.setXml(responseObject.getXml());          \r
 340           recordResponse.setAttribute("activeclients", "0");\r
 341           pzresp.put("record", recordResponse); \r
 342         }        \r
 343       }\r
 344     } else if (commandResponse.isBinary()) {\r
 345       responseObject = new RecordResponse(); \r
 346       responseObject.setType(commandName);\r
 347       logger.info("Binary response");\r
 348       responseObject.setAttribute("activeclients", "0");\r
 349       responseObject.setXml("<record>binary response</record>");\r
 350       responseObject.setBinary(commandResponse.getBytes());\r
 351       pzresp.put("record", responseObject);\r
 352     } else {\r
 353       logger.error("Response was not found to be XML or binary. The response was not handled.");\r
 354     }\r
 355     return responseObject;\r
 356   }\r
 357     \r
 358   @Override\r
 359   public void stateUpdated(String commandName) {\r
 360     logger.debug("State change reported for [" + commandName + "]");\r
 361     if (commandName.equals("show")) {\r
 362       logger.debug("Updating show");\r
 363       update(commandName);\r
 364     } \r
 365   }\r
 366   \r
 367   public void setServiceProxyUrl(String url) {\r
 368     searchClient = spClient;\r
 369     setServiceType(SERVICE_TYPE_SP);\r
 370     setServiceUrl(url);\r
 371   }\r
 372   \r
 373   public String getServiceProxyUrl () {\r
 374     if (isServiceProxyService()) {\r
 375       return spClient.getServiceUrl();\r
 376     } else {\r
 377       return "";\r
 378     }\r
 379   }\r
 380   \r
 381   public void setPazpar2Url(String url) {\r
 382     searchClient = pz2Client;\r
 383     setServiceType(SERVICE_TYPE_PZ2);\r
 384     setServiceUrl(url);\r
 385   }\r
 386   \r
 387   public String getPazpar2Url() {\r
 388     if (isPazpar2Service()) {\r
 389       return pz2Client.getServiceUrl();\r
 390     } else {\r
 391       return "";\r
 392     }\r
 393   }\r
 394 \r
 395   \r
 396   @Override\r
 397   public void setServiceUrl(String url) {\r
 398     if (url!=null && searchClient != null && !url.equals(searchClient.getServiceUrl())) {\r
 399       pzreq.getRecord().removeParametersInState();\r
 400       pzreq.getSearch().removeParametersInState();\r
 401       pzresp.resetAllSessionData();\r
 402       user.clear();\r
 403       searchClient.setServiceUrl(url);\r
 404     }    \r
 405   }\r
 406   \r
 407   public String getServiceUrl() {\r
 408     return (searchClient!=null ? searchClient.getServiceUrl() : "");\r
 409   }\r
 410   \r
 411   public boolean getServiceUrlIsDefined() {\r
 412     return (searchClient != null && searchClient.hasServiceUrl());\r
 413   }\r
 414   \r
 415   public List<String> getServiceProxyUrls() {\r
 416     List<String> urls = new ArrayList<String>();\r
 417     urls.add("");\r
 418     urls.addAll(serviceProxyUrls);\r
 419     return urls;\r
 420   }\r
 421   \r
 422   public List<String> getPazpar2Urls () {\r
 423     List<String> urls = new ArrayList<String>();\r
 424     urls.add("");\r
 425     urls.addAll(pazpar2Urls);\r
 426     return urls;\r
 427   }\r
 428   \r
 429   public String getServiceType () {\r
 430     return serviceType;\r
 431   }\r
 432   \r
 433   public boolean isPazpar2Service () {\r
 434     return serviceType.equals(SERVICE_TYPE_PZ2);\r
 435   }\r
 436   \r
 437   public boolean isServiceProxyService() {\r
 438     return serviceType.equals(SERVICE_TYPE_SP);\r
 439   }\r
 440   \r
 441   public boolean serviceIsToBeDecided () {\r
 442     return serviceType.equals(SERVICE_TYPE_TBD);\r
 443   }\r
 444   \r
 445   public ServiceProxyClient getSpClient () {\r
 446     return spClient;\r
 447   }  \r
 448   \r
 449   @Override\r
 450   public boolean getAuthenticationRequired () {\r
 451     return spClient.isAuthenticatingClient();\r
 452   }\r
 453 \r
 454   @Override\r
 455   public String getCheckHistory () {\r
 456     return ":pz2watch:stateForm:windowlocationhash";\r
 457   }\r
 458     \r
 459   @Override\r
 460   public String getWatchActiveclients () {\r
 461     return ":pz2watch:activeclientsForm:activeclientsField";\r
 462   }\r
 463   \r
 464   @Override\r
 465   public String getWatchActiveclientsRecord () {\r
 466     return ":pz2watch:activeclientsForm:activeclientsFieldRecord";\r
 467   }\r
 468 \r
 469   @Override\r
 470   public void configure(ConfigurationReader reader)\r
 471       throws ConfigurationException {\r
 472     Configuration config = reader.getConfiguration(this);\r
 473     if (config == null) {\r
 474       serviceType = SERVICE_TYPE_TBD;\r
 475     } else {\r
 476       String service = config.get("TYPE");\r
 477       if (service == null || service.length()==0) {\r
 478         serviceType = SERVICE_TYPE_TBD;\r
 479       } else if (serviceTypes.contains(service.toUpperCase())) {        \r
 480         setServiceType(service.toUpperCase());\r
 481       } else {\r
 482         logger.error("Unknown serviceType type in configuration [" + service + "], can be one of " + serviceTypes);\r
 483         serviceType = SERVICE_TYPE_TBD;\r
 484       }\r
 485       serviceProxyUrls = config.getMultiProperty(SERVICE_PROXY_URL_LIST,",");\r
 486       pazpar2Urls = config.getMultiProperty(PAZPAR2_URL_LIST, ",");\r
 487     }\r
 488     logger.info(reader.document());\r
 489     logger.info("Service Type is configured to " + serviceType);\r
 490     \r
 491   }\r
 492 \r
 493   @Override\r
 494   public Map<String, String> getDefaults() {\r
 495     return new HashMap<String,String>();\r
 496   }\r
 497 \r
 498   @Override\r
 499   public String getModuleName() {\r
 500     return MODULE_NAME;\r
 501   }\r
 502 \r
 503   @Override\r
 504   public List<String> documentConfiguration() {\r
 505     return new ArrayList<String>();\r
 506   }\r
 507 \r
 508   @Override\r
 509   public void setServiceTypePZ2() {\r
 510     setServiceType(SERVICE_TYPE_PZ2);    \r
 511   }\r
 512 \r
 513   @Override\r
 514   public void setServiceTypeSP() {\r
 515     setServiceType(SERVICE_TYPE_SP);        \r
 516   }\r
 517 \r
 518   @Override\r
 519   public void setServiceTypeTBD() {\r
 520     setServiceType(SERVICE_TYPE_TBD);    \r
 521   }\r
 522   \r
 523   private void setServiceType(String type) {\r
 524     if (!serviceType.equals(type)  &&\r
 525         !serviceType.equals(SERVICE_TYPE_TBD)) {\r
 526       resetSearchAndRecordCommands();\r
 527       pzresp.resetAllSessionData();\r
 528     }\r
 529     serviceType = type;\r
 530     if (serviceType.equals(SERVICE_TYPE_PZ2)) {\r
 531       searchClient = pz2Client;\r
 532       logger.info("Setting a Pazpar2 client to serve requests.");\r
 533     } else if (serviceType.equals(SERVICE_TYPE_SP)) {\r
 534       searchClient = spClient;\r
 535       logger.info("Setting a Service Proxy client to serve requests.");\r
 536     } else {\r
 537       logger.info("Clearing search client. No client defined to serve requests at this point.");\r
 538       searchClient = null;\r
 539     }\r
 540   }\r
 541   \r
 542 }\r