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