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 {\r
 117       stateMgr.hasPendingStateChange("search",false);\r
 118       pzresp.resetSearchResponses();\r
 119       // resets some record and show command parameters without \r
 120       // changing state or creating state change feedback\r
 121       pzreq.getRecord().removeParametersInState();        \r
 122       pzreq.getShow().setParameterInState(new CommandParameter("start","=",0));    \r
 123       logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommand("search").getUrlEncodedParameterValue("query"));\r
 124       doCommand("search");\r
 125     }\r
 126   }\r
 127   \r
 128   public String doRecord() {\r
 129     if (errors.hasConfigurationErrors()) {\r
 130       logger.error("Ignoring record request due to configuration errors.");\r
 131       return "";\r
 132     } else if (!pzreq.getCommand("record").hasParameterValue("id")) {\r
 133       logger.debug("Ignoring record request due to no id parameter.");\r
 134       return "";\r
 135     } else if (pzresp.getSearch().hasApplicationError()) {\r
 136       logger.debug("Ignoring record request due search error.");\r
 137       return "";\r
 138     } else {\r
 139       ResponseDataObject responseObject = doCommand("record");\r
 140       if (pzreq.getRecord().hasParameterValue("offset") ||\r
 141             pzreq.getRecord().hasParameterValue("checksum")) {\r
 142         RecordResponse recordResponse = new RecordResponse();\r
 143         recordResponse.setType("record");\r
 144         recordResponse.setXml(responseObject.getXml());\r
 145         recordResponse.setAttribute("activeclients", "0");\r
 146         pzresp.put("record", recordResponse);\r
 147       }\r
 148       return pzresp.getRecord().getActiveClients();\r
 149     }\r
 150   }\r
 151       \r
 152   /**\r
 153    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
 154    * \r
 155    * @return Number of activeclients at the time of the 'show' command.\r
 156    */\r
 157   public String update () {\r
 158     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
 159     if (errors.hasConfigurationErrors()) {\r
 160       logger.error("Ignoring show,stat,termlist,bytarget commands due to configuration errors.");\r
 161       return "";\r
 162     } else if (pzresp.getSearch().hasApplicationError()) {\r
 163       logger.error("Ignoring show,stat,termlist,bytarget commands due to problem with most recent search.");\r
 164       return "";\r
 165     } else if (!hasQuery()) {\r
 166       logger.error("Ignoring show,stat,termlist,bytarget commands because there is not yet a query.");\r
 167       return "";\r
 168     } else {\r
 169       return update("show,stat,termlist,bytarget");\r
 170     }\r
 171   }\r
 172      \r
 173   /**\r
 174    * Refreshes the data objects listed in 'commands' from pazpar2\r
 175    * \r
 176    * @param commands\r
 177    * @return Number of activeclients at the time of the 'show' command\r
 178    */\r
 179   public String update (String commands) {\r
 180     logger.info("Request to update: " + commands);\r
 181     try {\r
 182       if (commands.equals("search")) {\r
 183         doSearch();\r
 184         return "";\r
 185       } else if (commands.equals("record")) {\r
 186         return doRecord();\r
 187       } else if (pzresp.getSearch().isNew()) {\r
 188         logger.info("New search. Marking it old, then returning 'new' to trigger another round-trip.");\r
 189         pzresp.getSearch().setIsNew(false);\r
 190         return "new";\r
 191       } else {\r
 192         handleQueryStateChanges(commands);\r
 193         if (pzresp.getSearch().hasApplicationError()) {\r
 194           logger.error("The command(s) " + commands + " are cancelled because the latest search command had an error.");\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   protected void handleQueryStateChanges (String commands) {\r
 286     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
 287       logger.info("Triggered search: Found pending search change, doing search before updating " + commands);      \r
 288       doSearch();\r
 289     } \r
 290     if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 291       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 292       stateMgr.hasPendingStateChange("record",false);\r
 293       if (pzreq.getCommand("record").hasParameterValue("id")) {\r
 294         doRecord();\r
 295       } else {         \r
 296         pzresp.put("record", new RecordResponse());\r
 297       }\r
 298     }\r
 299   }\r
 300   \r
 301   /**\r
 302    * Validates the request then executes the command and parses the response.\r
 303    * If the parsed response is of a known type it will be cached in 'pzresp'\r
 304    * \r
 305    * @param commandName The command to be executed\r
 306    * @return An XML response parsed to form a response data object\r
 307    */\r
 308   protected ResponseDataObject doCommand(String commandName) {\r
 309     ResponseDataObject responseObject = null;     \r
 310     // logger.debug(pzreq.getCommand(commandName).getEncodedQueryString() + ": Results for "+ pzreq.getCommand("search").getEncodedQueryString());\r
 311     Pazpar2Command command = pzreq.getCommand(commandName);\r
 312     long start = System.currentTimeMillis();\r
 313     HttpResponseWrapper commandResponse = searchClient.executeCommand(command);\r
 314     long end = System.currentTimeMillis();\r
 315     logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );\r
 316     responseLogger.debug("Response was: " + commandResponse.getResponseString());\r
 317     responseObject = ResponseParser.getParser().getDataObject((ClientCommandResponse)commandResponse);\r
 318     if (ResponseParser.docTypes.contains(responseObject.getType())) {\r
 319       pzresp.put(commandName, responseObject);\r
 320     }          \r
 321     return responseObject;\r
 322   }\r
 323     \r
 324   @Override\r
 325   public void stateUpdated(String commandName) {\r
 326     logger.debug("State change reported for [" + commandName + "]");\r
 327     if (commandName.equals("show")) {\r
 328       logger.debug("Updating show");\r
 329       update(commandName);\r
 330     } \r
 331   }\r
 332   \r
 333   public void setServiceProxyUrl(String url) {\r
 334     searchClient = spClient;\r
 335     setServiceType(SERVICE_TYPE_SP);\r
 336     setServiceUrl(url);\r
 337   }\r
 338   \r
 339   public String getServiceProxyUrl () {\r
 340     if (isServiceProxyService()) {\r
 341       return spClient.getServiceUrl();\r
 342     } else {\r
 343       return "";\r
 344     }\r
 345   }\r
 346   \r
 347   public void setPazpar2Url(String url) {\r
 348     searchClient = pz2Client;\r
 349     setServiceType(SERVICE_TYPE_PZ2);\r
 350     setServiceUrl(url);\r
 351   }\r
 352   \r
 353   public String getPazpar2Url() {\r
 354     if (isPazpar2Service()) {\r
 355       return pz2Client.getServiceUrl();\r
 356     } else {\r
 357       return "";\r
 358     }\r
 359   }\r
 360 \r
 361   \r
 362   @Override\r
 363   public void setServiceUrl(String url) {\r
 364     if (url!=null && searchClient != null && !url.equals(searchClient.getServiceUrl())) {\r
 365       pzreq.getRecord().removeParametersInState();\r
 366       pzreq.getSearch().removeParametersInState();\r
 367       pzresp.resetAllSessionData();\r
 368       user.clear();\r
 369       searchClient.setServiceUrl(url);\r
 370     }    \r
 371   }\r
 372   \r
 373   public String getServiceUrl() {\r
 374     return (searchClient!=null ? searchClient.getServiceUrl() : "");\r
 375   }\r
 376   \r
 377   public boolean getServiceUrlIsDefined() {\r
 378     return (searchClient != null && searchClient.hasServiceUrl());\r
 379   }\r
 380   \r
 381   public List<String> getServiceProxyUrls() {\r
 382     List<String> urls = new ArrayList<String>();\r
 383     urls.add("");\r
 384     urls.addAll(serviceProxyUrls);\r
 385     return urls;\r
 386   }\r
 387   \r
 388   public List<String> getPazpar2Urls () {\r
 389     List<String> urls = new ArrayList<String>();\r
 390     urls.add("");\r
 391     urls.addAll(pazpar2Urls);\r
 392     return urls;\r
 393   }\r
 394   \r
 395   public String getServiceType () {\r
 396     return serviceType;\r
 397   }\r
 398   \r
 399   public boolean isPazpar2Service () {\r
 400     return serviceType.equals(SERVICE_TYPE_PZ2);\r
 401   }\r
 402   \r
 403   public boolean isServiceProxyService() {\r
 404     return serviceType.equals(SERVICE_TYPE_SP);\r
 405   }\r
 406   \r
 407   public boolean serviceIsToBeDecided () {\r
 408     return serviceType.equals(SERVICE_TYPE_TBD);\r
 409   }\r
 410   \r
 411   public ServiceProxyClient getSpClient () {\r
 412     return spClient;\r
 413   }  \r
 414   \r
 415   @Override\r
 416   public boolean getAuthenticationRequired () {\r
 417     return spClient.isAuthenticatingClient();\r
 418   }\r
 419 \r
 420   @Override\r
 421   public String getCheckHistory () {\r
 422     return ":pz2watch:stateForm:windowlocationhash";\r
 423   }\r
 424     \r
 425   @Override\r
 426   public String getWatchActiveclients () {\r
 427     return ":pz2watch:activeclientsForm:activeclientsField";\r
 428   }\r
 429   \r
 430   @Override\r
 431   public String getWatchActiveclientsRecord () {\r
 432     return ":pz2watch:activeclientsForm:activeclientsFieldRecord";\r
 433   }\r
 434 \r
 435   @Override\r
 436   public void configure(ConfigurationReader reader)\r
 437       throws ConfigurationException {\r
 438     Configuration config = reader.getConfiguration(this);\r
 439     if (config == null) {\r
 440       serviceType = SERVICE_TYPE_TBD;\r
 441     } else {\r
 442       String service = config.get("TYPE");\r
 443       if (service == null || service.length()==0) {\r
 444         serviceType = SERVICE_TYPE_TBD;\r
 445       } else if (serviceTypes.contains(service.toUpperCase())) {        \r
 446         setServiceType(service.toUpperCase());\r
 447       } else {\r
 448         logger.error("Unknown serviceType type in configuration [" + service + "], can be one of " + serviceTypes);\r
 449         serviceType = SERVICE_TYPE_TBD;\r
 450       }\r
 451       serviceProxyUrls = config.getMultiProperty(SERVICE_PROXY_URL_LIST,",");\r
 452       pazpar2Urls = config.getMultiProperty(PAZPAR2_URL_LIST, ",");\r
 453     }\r
 454     logger.info("Service Type is configured to " + serviceType);\r
 455     \r
 456   }\r
 457 \r
 458   @Override\r
 459   public Map<String, String> getDefaults() {\r
 460     return new HashMap<String,String>();\r
 461   }\r
 462 \r
 463   @Override\r
 464   public String getModuleName() {\r
 465     return MODULE_NAME;\r
 466   }\r
 467 \r
 468   @Override\r
 469   public List<String> documentConfiguration() {\r
 470     return new ArrayList<String>();\r
 471   }\r
 472 \r
 473   @Override\r
 474   public void setServiceTypePZ2() {\r
 475     setServiceType(SERVICE_TYPE_PZ2);    \r
 476   }\r
 477 \r
 478   @Override\r
 479   public void setServiceTypeSP() {\r
 480     setServiceType(SERVICE_TYPE_SP);        \r
 481   }\r
 482 \r
 483   @Override\r
 484   public void setServiceTypeTBD() {\r
 485     setServiceType(SERVICE_TYPE_TBD);    \r
 486   }\r
 487   \r
 488   private void setServiceType(String type) {\r
 489     if (!serviceType.equals(type)  &&\r
 490         !serviceType.equals(SERVICE_TYPE_TBD)) {\r
 491       resetSearchAndRecordCommands();\r
 492       pzresp.resetAllSessionData();\r
 493     }\r
 494     serviceType = type;\r
 495     if (serviceType.equals(SERVICE_TYPE_PZ2)) {\r
 496       searchClient = pz2Client;\r
 497       logger.info("Setting a Pazpar2 client to serve requests.");\r
 498     } else if (serviceType.equals(SERVICE_TYPE_SP)) {\r
 499       searchClient = spClient;\r
 500       logger.info("Setting a Service Proxy client to serve requests.");\r
 501     } else {\r
 502       logger.info("Clearing search client. No client defined to serve requests at this point.");\r
 503       searchClient = null;\r
 504     }\r
 505   }\r
 506   \r
 507 }\r