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       ResponseDataObject responseObject = doCommand("record");\r
 145       if ((pzreq.getRecord().hasParameterValue("offset") ||\r
 146             pzreq.getRecord().hasParameterValue("checksum")) &&\r
 147             !responseObject.getType().equals("record")) {\r
 148         logger.debug("Storing record offset response as 'record'");\r
 149         RecordResponse recordResponse = new RecordResponse();\r
 150         recordResponse.setType("record");\r
 151         recordResponse.setXml(responseObject.getXml());\r
 152         recordResponse.setAttribute("activeclients", "0");\r
 153         pzresp.put("record", recordResponse);\r
 154       }\r
 155       return pzresp.getRecord().getActiveClients();\r
 156     }\r
 157   }\r
 158       \r
 159   /**\r
 160    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
 161    * \r
 162    * @return Number of activeclients at the time of the 'show' command.\r
 163    */\r
 164   public String update () {\r
 165     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
 166     if (errors.hasConfigurationErrors()) {\r
 167       logger.error("Ignoring show,stat,termlist,bytarget commands due to configuration errors.");\r
 168       return "";\r
 169     } else if (pzresp.getSearch().hasApplicationError()) {\r
 170       logger.error("Ignoring show,stat,termlist,bytarget commands due to problem with most recent search.");\r
 171       return "";\r
 172     } else if (!hasQuery()) {\r
 173       logger.error("Ignoring show,stat,termlist,bytarget commands because there is not yet a query.");\r
 174       return "";\r
 175     } else {\r
 176       return update("show,stat,termlist,bytarget");\r
 177     }\r
 178   }\r
 179      \r
 180   /**\r
 181    * Refreshes the data objects listed in 'commands' from pazpar2\r
 182    * \r
 183    * @param commands\r
 184    * @return Number of activeclients at the time of the 'show' command\r
 185    */\r
 186   public String update (String commands) {\r
 187     logger.info("Request to update: " + commands);\r
 188     try {\r
 189       if (commands.equals("search")) {\r
 190         doSearch();\r
 191         return "";\r
 192       } else if (commands.equals("record")) {\r
 193         return doRecord();\r
 194       } else if (pzresp.getSearch().isNew()) {\r
 195         logger.info("New search. Marking it old, then returning 'new' to trigger another round-trip.");\r
 196         pzresp.getSearch().setIsNew(false);\r
 197         return "new";\r
 198       } else {\r
 199         handleQueryStateChanges(commands);\r
 200         if (pzresp.getSearch().hasApplicationError()) {\r
 201           logger.error("The command(s) " + commands + " cancelled because the latest search command had an error.");\r
 202           return "0";\r
 203         } else if (errors.hasConfigurationErrors()) {\r
 204           logger.error("The command(s) " + commands + " cancelled due to configuration errors.");\r
 205           return "0";\r
 206         } else {\r
 207           logger.debug("Processing request for " + commands); \r
 208           \r
 209           List<CommandThread> threadList = new ArrayList<CommandThread>();\r
 210           StringTokenizer tokens = new StringTokenizer(commands,",");\r
 211           while (tokens.hasMoreElements()) {          \r
 212             threadList.add(new CommandThread(pzreq.getCommand(tokens.nextToken()),searchClient));            \r
 213           }\r
 214           for (CommandThread thread : threadList) {\r
 215             thread.start();\r
 216           }\r
 217           for (CommandThread thread : threadList) {\r
 218             try {\r
 219               thread.join();\r
 220             } catch (InterruptedException e) {\r
 221               e.printStackTrace();\r
 222             }\r
 223           }\r
 224           for (CommandThread thread : threadList) {\r
 225              String commandName = thread.getCommand().getCommandName();\r
 226              ClientCommandResponse response = (ClientCommandResponse) thread.getCommandResponse();\r
 227              responseLogger.debug("Response was: " + response.getResponseString());\r
 228              ResponseDataObject responseObject = ResponseParser.getParser().getDataObject(response);\r
 229              if (ResponseParser.docTypes.contains(responseObject.getType())) {\r
 230                pzresp.put(commandName, responseObject);\r
 231              } else {\r
 232                logger.info("Unknown doc type [" + responseObject.getType() + "]. Was not cached.");\r
 233              }\r
 234           }\r
 235           return pzresp.getActiveClients();\r
 236         }\r
 237       }  \r
 238     } catch (ClassCastException cce) {\r
 239       cce.printStackTrace();    \r
 240       return "";\r
 241     } catch (NullPointerException npe) {\r
 242       npe.printStackTrace();\r
 243       return "";\r
 244     } catch (Exception e) {\r
 245       e.printStackTrace();\r
 246       return "";\r
 247     }\r
 248     \r
 249   }\r
 250                                   \r
 251   public String toggleRecord (String recId) {\r
 252     if (hasRecord(recId)) {\r
 253       pzreq.getRecord().removeParameters();  \r
 254       pzresp.put("record", new RecordResponse());\r
 255       return "";\r
 256     } else {\r
 257       pzreq.getRecord().setId(recId);\r
 258       doCommand("record");\r
 259       return pzresp.getRecord().getActiveClients();\r
 260     }\r
 261   }\r
 262   \r
 263   @Override\r
 264   public boolean hasRecord (String recId) {\r
 265     return pzreq.getCommand("record").hasParameters() && pzresp.getRecord().getRecId().equals(recId);\r
 266   }\r
 267         \r
 268   public String getCurrentStateKey () {    \r
 269     return stateMgr.getCurrentState().getKey();\r
 270   }\r
 271       \r
 272   public void setCurrentStateKey(String key) {       \r
 273     stateMgr.setCurrentStateKey(key);\r
 274   }\r
 275       \r
 276   protected boolean hasQuery() {        \r
 277     return pzreq.getCommand("search").hasParameterValue("query"); \r
 278   }\r
 279     \r
 280     \r
 281   @Override\r
 282   public ResultsPager getPager () {\r
 283     if (pager == null) {\r
 284       pager = new ResultsPager(pzresp);      \r
 285     } \r
 286     return pager;      \r
 287   }\r
 288   \r
 289   @Override\r
 290   public ResultsPager setPager (int pageRange) {\r
 291     pager =  new ResultsPager(pzresp,pageRange,pzreq);\r
 292     return pager;\r
 293   }\r
 294    \r
 295   /**\r
 296    * This methods main purpose is to support browser history.\r
 297    *  \r
 298    * When the browsers back or forward buttons are pressed, a  \r
 299    * re-search /might/ be required - namely if the query changes.\r
 300    * So, as the UI requests updates of the page (show,facets,\r
 301    * etc) this method checks if a search must be executed\r
 302    * before those updates are performed.\r
 303    *  \r
 304    * @see {@link com.indexdata.mkjsf.pazpar2.state.StateManager#setCurrentStateKey} \r
 305    * @param commands\r
 306    */\r
 307   protected void handleQueryStateChanges (String commands) {\r
 308     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
 309       logger.info("Triggered search: Found pending search change [" + pzreq.getCommand("search").toString() + "], doing search before updating " + commands);      \r
 310       doSearch();\r
 311     } \r
 312     if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 313       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 314       stateMgr.hasPendingStateChange("record",false);\r
 315       if (pzreq.getCommand("record").hasParameterValue("id")) {\r
 316         doRecord();\r
 317       } else {         \r
 318         pzresp.put("record", new RecordResponse());\r
 319       }\r
 320     }\r
 321   }\r
 322   \r
 323   /**\r
 324    * Validates the request then executes the command and parses the response.\r
 325    * If the parsed response is of a known type it will be cached in 'pzresp'\r
 326    * \r
 327    * @param commandName The command to be executed\r
 328    * @return An XML response parsed to form a response data object\r
 329    */\r
 330   protected ResponseDataObject doCommand(String commandName) {\r
 331     ResponseDataObject responseObject = null;     \r
 332     logger.info("Request "+commandName + ": "+ pzreq.getCommand("search").toString());\r
 333     Pazpar2Command command = pzreq.getCommand(commandName);\r
 334     long start = System.currentTimeMillis();\r
 335     HttpResponseWrapper commandResponse = searchClient.executeCommand(command);\r
 336     long end = System.currentTimeMillis();\r
 337     logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );\r
 338     responseLogger.debug("Response was: " + commandResponse.getResponseString());\r
 339     responseObject = ResponseParser.getParser().getDataObject((ClientCommandResponse)commandResponse);\r
 340     if (ResponseParser.docTypes.contains(responseObject.getType())) {\r
 341       logger.debug("Storing " + responseObject.getType() + " in pzresp. ");\r
 342       pzresp.put(commandName, responseObject);\r
 343     } else {\r
 344       logger.info("Unrecognized response object type not cached in pzresp: " + responseObject.getType());\r
 345     }\r
 346     return responseObject;\r
 347   }\r
 348     \r
 349   @Override\r
 350   public void stateUpdated(String commandName) {\r
 351     logger.debug("State change reported for [" + commandName + "]");\r
 352     if (commandName.equals("show")) {\r
 353       logger.debug("Updating show");\r
 354       update(commandName);\r
 355     } \r
 356   }\r
 357   \r
 358   public void setServiceProxyUrl(String url) {\r
 359     searchClient = spClient;\r
 360     setServiceType(SERVICE_TYPE_SP);\r
 361     setServiceUrl(url);\r
 362   }\r
 363   \r
 364   public String getServiceProxyUrl () {\r
 365     if (isServiceProxyService()) {\r
 366       return spClient.getServiceUrl();\r
 367     } else {\r
 368       return "";\r
 369     }\r
 370   }\r
 371   \r
 372   public void setPazpar2Url(String url) {\r
 373     searchClient = pz2Client;\r
 374     setServiceType(SERVICE_TYPE_PZ2);\r
 375     setServiceUrl(url);\r
 376   }\r
 377   \r
 378   public String getPazpar2Url() {\r
 379     if (isPazpar2Service()) {\r
 380       return pz2Client.getServiceUrl();\r
 381     } else {\r
 382       return "";\r
 383     }\r
 384   }\r
 385 \r
 386   \r
 387   @Override\r
 388   public void setServiceUrl(String url) {\r
 389     if (url!=null && searchClient != null && !url.equals(searchClient.getServiceUrl())) {\r
 390       pzreq.getRecord().removeParametersInState();\r
 391       pzreq.getSearch().removeParametersInState();\r
 392       pzresp.resetAllSessionData();\r
 393       user.clear();\r
 394       searchClient.setServiceUrl(url);\r
 395     }    \r
 396   }\r
 397   \r
 398   public String getServiceUrl() {\r
 399     return (searchClient!=null ? searchClient.getServiceUrl() : "");\r
 400   }\r
 401   \r
 402   public boolean getServiceUrlIsDefined() {\r
 403     return (searchClient != null && searchClient.hasServiceUrl());\r
 404   }\r
 405   \r
 406   public List<String> getServiceProxyUrls() {\r
 407     List<String> urls = new ArrayList<String>();\r
 408     urls.add("");\r
 409     urls.addAll(serviceProxyUrls);\r
 410     return urls;\r
 411   }\r
 412   \r
 413   public List<String> getPazpar2Urls () {\r
 414     List<String> urls = new ArrayList<String>();\r
 415     urls.add("");\r
 416     urls.addAll(pazpar2Urls);\r
 417     return urls;\r
 418   }\r
 419   \r
 420   public String getServiceType () {\r
 421     return serviceType;\r
 422   }\r
 423   \r
 424   public boolean isPazpar2Service () {\r
 425     return serviceType.equals(SERVICE_TYPE_PZ2);\r
 426   }\r
 427   \r
 428   public boolean isServiceProxyService() {\r
 429     return serviceType.equals(SERVICE_TYPE_SP);\r
 430   }\r
 431   \r
 432   public boolean serviceIsToBeDecided () {\r
 433     return serviceType.equals(SERVICE_TYPE_TBD);\r
 434   }\r
 435   \r
 436   public ServiceProxyClient getSpClient () {\r
 437     return spClient;\r
 438   }  \r
 439   \r
 440   @Override\r
 441   public boolean getAuthenticationRequired () {\r
 442     return spClient.isAuthenticatingClient();\r
 443   }\r
 444 \r
 445   @Override\r
 446   public String getCheckHistory () {\r
 447     return ":pz2watch:stateForm:windowlocationhash";\r
 448   }\r
 449     \r
 450   @Override\r
 451   public String getWatchActiveclients () {\r
 452     return ":pz2watch:activeclientsForm:activeclientsField";\r
 453   }\r
 454   \r
 455   @Override\r
 456   public String getWatchActiveclientsRecord () {\r
 457     return ":pz2watch:activeclientsForm:activeclientsFieldRecord";\r
 458   }\r
 459 \r
 460   @Override\r
 461   public void configure(ConfigurationReader reader)\r
 462       throws ConfigurationException {\r
 463     Configuration config = reader.getConfiguration(this);\r
 464     if (config == null) {\r
 465       serviceType = SERVICE_TYPE_TBD;\r
 466     } else {\r
 467       String service = config.get("TYPE");\r
 468       if (service == null || service.length()==0) {\r
 469         serviceType = SERVICE_TYPE_TBD;\r
 470       } else if (serviceTypes.contains(service.toUpperCase())) {        \r
 471         setServiceType(service.toUpperCase());\r
 472       } else {\r
 473         logger.error("Unknown serviceType type in configuration [" + service + "], can be one of " + serviceTypes);\r
 474         serviceType = SERVICE_TYPE_TBD;\r
 475       }\r
 476       serviceProxyUrls = config.getMultiProperty(SERVICE_PROXY_URL_LIST,",");\r
 477       pazpar2Urls = config.getMultiProperty(PAZPAR2_URL_LIST, ",");\r
 478     }\r
 479     logger.info(reader.document());\r
 480     logger.info("Service Type is configured to " + serviceType);\r
 481     \r
 482   }\r
 483 \r
 484   @Override\r
 485   public Map<String, String> getDefaults() {\r
 486     return new HashMap<String,String>();\r
 487   }\r
 488 \r
 489   @Override\r
 490   public String getModuleName() {\r
 491     return MODULE_NAME;\r
 492   }\r
 493 \r
 494   @Override\r
 495   public List<String> documentConfiguration() {\r
 496     return new ArrayList<String>();\r
 497   }\r
 498 \r
 499   @Override\r
 500   public void setServiceTypePZ2() {\r
 501     setServiceType(SERVICE_TYPE_PZ2);    \r
 502   }\r
 503 \r
 504   @Override\r
 505   public void setServiceTypeSP() {\r
 506     setServiceType(SERVICE_TYPE_SP);        \r
 507   }\r
 508 \r
 509   @Override\r
 510   public void setServiceTypeTBD() {\r
 511     setServiceType(SERVICE_TYPE_TBD);    \r
 512   }\r
 513   \r
 514   private void setServiceType(String type) {\r
 515     if (!serviceType.equals(type)  &&\r
 516         !serviceType.equals(SERVICE_TYPE_TBD)) {\r
 517       resetSearchAndRecordCommands();\r
 518       pzresp.resetAllSessionData();\r
 519     }\r
 520     serviceType = type;\r
 521     if (serviceType.equals(SERVICE_TYPE_PZ2)) {\r
 522       searchClient = pz2Client;\r
 523       logger.info("Setting a Pazpar2 client to serve requests.");\r
 524     } else if (serviceType.equals(SERVICE_TYPE_SP)) {\r
 525       searchClient = spClient;\r
 526       logger.info("Setting a Service Proxy client to serve requests.");\r
 527     } else {\r
 528       logger.info("Clearing search client. No client defined to serve requests at this point.");\r
 529       searchClient = null;\r
 530     }\r
 531   }\r
 532   \r
 533 }\r