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