5b45551a1b1aa476e1899b4e901e4768ae4c60e3
[mkjsf-moved-to-github.git] / 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.commands.sp.ServiceProxyCommand;\r
30 import com.indexdata.mkjsf.pazpar2.data.RecordResponse;\r
31 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;\r
32 import com.indexdata.mkjsf.pazpar2.data.ResponseParser;\r
33 import com.indexdata.mkjsf.pazpar2.data.Responses;\r
34 import com.indexdata.mkjsf.pazpar2.sp.auth.ServiceProxyUser;\r
35 import com.indexdata.mkjsf.pazpar2.state.StateListener;\r
36 import com.indexdata.mkjsf.pazpar2.state.StateManager;\r
37 import com.indexdata.mkjsf.utils.Utils;\r
38 \r
39 @Named("pz2") @SessionScoped\r
40 public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Serializable {\r
41 \r
42   private static final String MODULE_NAME = "service";\r
43   private static String SERVICE_TYPE_TBD = "TBD", SERVICE_TYPE_PZ2 = "PZ2", SERVICE_TYPE_SP = "SP";\r
44   private static final List<String> serviceTypes = \r
45                 Arrays.asList(SERVICE_TYPE_PZ2,SERVICE_TYPE_SP,SERVICE_TYPE_TBD);\r
46   private String serviceType = SERVICE_TYPE_TBD;\r
47   private List<String> serviceProxyUrls = new ArrayList<String>();\r
48   public static final String SERVICE_PROXY_URL_LIST = "SERVICE_PROXY_URL_LIST";\r
49   private List<String> pazpar2Urls = new ArrayList<String>();\r
50   public static final String PAZPAR2_URL_LIST = "PAZPAR2_URL_LIST";\r
51 \r
52 \r
53   private static final long serialVersionUID = 3440277287081557861L;\r
54   private static Logger logger = Logger.getLogger(Pz2Bean.class);\r
55   private static Logger responseLogger = Logger.getLogger("com.indexdata.mkjsf.pazpar2.responses");   \r
56   protected Pz2Client pz2Client = null;\r
57   protected ServiceProxyClient spClient = null;\r
58   protected SearchClient searchClient = null;  \r
59     \r
60   @Inject ConfigurationReader configurator;\r
61   @Inject StateManager stateMgr;\r
62   @Inject Pazpar2Commands pzreq;\r
63   @Inject Responses pzresp;\r
64   @Inject ErrorCentral errors;\r
65   @Inject ServiceProxyUser user;\r
66   \r
67   protected ResultsPager pager = null; \r
68   \r
69   protected ErrorHelper errorHelper = null;\r
70               \r
71   public Pz2Bean () {\r
72     logger.info("Instantiating pz2 bean [" + Utils.objectId(this) + "]");    \r
73   }\r
74   \r
75   @PostConstruct\r
76   public void postConstruct() {    \r
77     logger.debug("Pz2Bean post-construct: Configurator is " + configurator);\r
78     logger.debug(Utils.objectId(this) + " will instantiate a Pz2Client next.");\r
79     pz2Client = new Pz2Client();\r
80     configureClient(pz2Client,configurator);\r
81     spClient = new ServiceProxyClient();\r
82     configureClient(spClient,configurator);\r
83     try {\r
84       this.configure(configurator);\r
85     } catch (ConfigurationException e) {\r
86       logger.error("There was a problem configuring the Pz2Bean (\"pz2\")");\r
87       e.printStackTrace();\r
88     }    \r
89     stateMgr.addStateListener(this);    \r
90   }  \r
91   \r
92   public void configureClient(SearchClient client, ConfigurationReader configReader) {\r
93     logger.debug(Utils.objectId(this) + " will configure search client for the session");\r
94     try {\r
95       client.configure(configReader);            \r
96     } catch (ConfigurationException e) {\r
97       logger.debug("Pz2Bean adding configuration error");\r
98       errors.addConfigurationError(new ConfigurationError("Search Client","Configuration",e.getMessage()));                \r
99     } \r
100     logger.info(configReader.document());\r
101     pzresp.resetAllSessionData();    \r
102   }\r
103   \r
104   public void resetSearchAndRecordCommands () {\r
105     pzreq.getRecord().removeParametersInState();\r
106     pzreq.getSearch().removeParametersInState();   \r
107   }\r
108     \r
109   public void doSearch(String query) {\r
110     pzreq.getSearch().setParameter(new CommandParameter("query","=",query));     \r
111     doSearch();\r
112   }\r
113 \r
114   public void doSearch() {\r
115     if (errors.hasConfigurationErrors()) {\r
116       logger.error("Ignoring search request due to configuration errors.");\r
117     } else if (searchClient == null){\r
118       logger.error("No search client defined. A client must either be pre-configured or selected before searching.");\r
119       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
120     } else {\r
121       stateMgr.hasPendingStateChange("search",false);\r
122       pzresp.resetSearchResponses();\r
123       // resets some record and show command parameters without \r
124       // changing state or creating state change feedback\r
125       pzreq.getRecord().removeParametersInState();        \r
126       pzreq.getShow().setParameterInState(new CommandParameter("start","=",0));    \r
127       logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommand("search").getUrlEncodedParameterValue("query"));\r
128       searchClient.setSearchCommand(pzreq.getCommand("search"));\r
129       doCommand("search");\r
130     }\r
131   }\r
132   \r
133   public String doRecord() {\r
134     if (errors.hasConfigurationErrors()) {\r
135       logger.error("Ignoring record request due to configuration errors.");\r
136       return "";\r
137     } else if (!pzreq.getCommand("record").hasParameterValue("id")) {\r
138       logger.debug("Ignoring record request due to no id parameter.");\r
139       return "";\r
140     } else if (pzresp.getSearch().hasApplicationError()) {\r
141       logger.debug("Ignoring record request due search error.");\r
142       return "";\r
143     } else {\r
144       logger.debug("Executing record command");\r
145       doCommand("record");\r
146       return pzresp.getRecord().getActiveClients();\r
147     }\r
148   }\r
149       \r
150   /**\r
151    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
152    * \r
153    * @return Number of activeclients at the time of the 'show' command.\r
154    */\r
155   public String update () {\r
156     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
157     if (errors.hasConfigurationErrors()) {\r
158       logger.error("Ignoring show,stat,termlist,bytarget commands due to configuration errors.");\r
159       return "";\r
160     } else if (pzresp.getSearch().hasApplicationError()) {\r
161       logger.error("Ignoring show,stat,termlist,bytarget commands due to problem with most recent search.");\r
162       return "";\r
163     } else if (!hasQuery()) {\r
164       logger.debug("Ignoring show,stat,termlist,bytarget commands because there is not yet a query.");\r
165       return "";\r
166     } else {\r
167       return update("show,stat,termlist,bytarget");\r
168     }\r
169   }\r
170      \r
171   /**\r
172    * Refreshes the data objects listed in 'commands' from pazpar2\r
173    * \r
174    * @param commands\r
175    * @return Number of activeclients at the time of the 'show' command\r
176    */\r
177   public String update (String commands) {\r
178     logger.debug("Request to update: " + commands);\r
179     try {\r
180       if (commands.equals("search")) {\r
181         doSearch();\r
182         return "";\r
183       } else if (commands.equals("record")) {\r
184         return doRecord();\r
185       } else if (pzresp.getSearch().isNew()) {\r
186         logger.info("New search. Marking it old, then returning 'new' to trigger another round-trip.");\r
187         pzresp.getSearch().setIsNew(false);\r
188         return "new";\r
189       } else {\r
190         handleQueryStateChanges(commands);\r
191         if (pzresp.getSearch().hasApplicationError()) {\r
192           logger.error("The command(s) " + commands + " cancelled because the latest search command had an error.");\r
193           return "0";\r
194         } else if (errors.hasConfigurationErrors()) {\r
195           logger.error("The command(s) " + commands + " cancelled due to configuration errors.");\r
196           return "0";\r
197         } else {\r
198           logger.debug("Processing request for " + commands); \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    * Executes the command and parses the response to create data objects.\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     if (pzreq.getCommand(commandName).spOnly() && isPazpar2Service()) {\r
322       logger.warn("Skipping " + commandName + " - SP-only command, un-supported by Pazpar2");\r
323       return new ResponseDataObject();\r
324     } else {\r
325       ResponseDataObject responseObject = null;     \r
326       logger.info("Request "+commandName + ": "+ pzreq.getCommand("search").toString());\r
327       Pazpar2Command command = pzreq.getCommand(commandName);\r
328       long start = System.currentTimeMillis();\r
329       HttpResponseWrapper commandResponse = searchClient.executeCommand(command);\r
330       long end = System.currentTimeMillis();\r
331       logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );\r
332       responseLogger.debug("Response was: " + commandResponse.getResponseString());\r
333       if (commandResponse.getContentType().contains("xml")) {\r
334         responseObject = ResponseParser.getParser().getDataObject((ClientCommandResponse)commandResponse);\r
335         if (ResponseParser.docTypes.contains(responseObject.getType())) {\r
336           logger.debug("Storing " + responseObject.getType() + " in pzresp. ");\r
337           pzresp.put(commandName, responseObject);\r
338         } else {\r
339           if (commandName.equals("record")) {\r
340             logger.debug("Command was 'record' but response not '<record>' - assuming raw record response.");\r
341             ResponseDataObject recordResponse = new RecordResponse(); \r
342             recordResponse.setType("record");\r
343             recordResponse.setXml(responseObject.getXml());          \r
344             recordResponse.setAttribute("activeclients", "0");\r
345             pzresp.put("record", recordResponse); \r
346           }        \r
347         }\r
348       } else if (commandResponse.isBinary()) {\r
349         responseObject = new RecordResponse(); \r
350         responseObject.setType(commandName);\r
351         logger.info("Binary response");\r
352         responseObject.setAttribute("activeclients", "0");\r
353         responseObject.setXml("<record>binary response</record>");\r
354         responseObject.setBinary(commandResponse.getBytes());\r
355         pzresp.put("record", responseObject);\r
356       } else {\r
357         logger.error("Response was not found to be XML or binary. The response was not handled.");\r
358       }\r
359       return responseObject;\r
360     }\r
361   }\r
362     \r
363   @Override\r
364   public void stateUpdated(String commandName) {\r
365     logger.debug("State change reported for [" + commandName + "]");\r
366     if (commandName.equals("show")) {\r
367       logger.debug("Updating show");\r
368       update(commandName);\r
369     } \r
370   }\r
371   \r
372   public void setServiceProxyUrl(String url) {\r
373     searchClient = spClient;\r
374     setServiceType(SERVICE_TYPE_SP);\r
375     setServiceUrl(url);\r
376   }\r
377   \r
378   public String getServiceProxyUrl () {\r
379     if (isServiceProxyService()) {\r
380       return spClient.getServiceUrl();\r
381     } else {\r
382       return "";\r
383     }\r
384   }\r
385   \r
386   public void setPazpar2Url(String url) {\r
387     searchClient = pz2Client;\r
388     setServiceType(SERVICE_TYPE_PZ2);\r
389     setServiceUrl(url);\r
390   }\r
391   \r
392   public String getPazpar2Url() {\r
393     if (isPazpar2Service()) {\r
394       return pz2Client.getServiceUrl();\r
395     } else {\r
396       return "";\r
397     }\r
398   }\r
399 \r
400   \r
401   @Override\r
402   public void setServiceUrl(String url) {\r
403     if (url!=null && searchClient != null && !url.equals(searchClient.getServiceUrl())) {\r
404       pzreq.getRecord().removeParametersInState();\r
405       pzreq.getSearch().removeParametersInState();\r
406       pzresp.resetAllSessionData();\r
407       user.clear();\r
408       searchClient.setServiceUrl(url);\r
409     }    \r
410   }\r
411   \r
412   public String getServiceUrl() {\r
413     return (searchClient!=null ? searchClient.getServiceUrl() : "");\r
414   }\r
415   \r
416   public void setServiceId () {\r
417     pzreq.getRecord().removeParametersInState();\r
418     pzreq.getSearch().removeParametersInState();\r
419     pzresp.resetSearchResponses();\r
420     pz2Client.setServiceId(pzreq.getInit().getService());\r
421   }\r
422   \r
423   public String getServiceId () {\r
424     return pzreq.getInit().getService();\r
425   }\r
426   \r
427   public boolean getServiceUrlIsDefined() {\r
428     return (searchClient != null && searchClient.hasServiceUrl());\r
429   }\r
430   \r
431   public List<String> getServiceProxyUrls() {\r
432     List<String> urls = new ArrayList<String>();\r
433     urls.add("");\r
434     urls.addAll(serviceProxyUrls);\r
435     return urls;\r
436   }\r
437   \r
438   public List<String> getPazpar2Urls () {\r
439     List<String> urls = new ArrayList<String>();\r
440     urls.add("");\r
441     urls.addAll(pazpar2Urls);\r
442     return urls;\r
443   }\r
444   \r
445   public String getServiceType () {\r
446     return serviceType;\r
447   }\r
448   \r
449   public boolean isPazpar2Service () {\r
450     return serviceType.equals(SERVICE_TYPE_PZ2);\r
451   }\r
452   \r
453   public boolean isServiceProxyService() {\r
454     return serviceType.equals(SERVICE_TYPE_SP);\r
455   }\r
456   \r
457   public boolean serviceIsToBeDecided () {\r
458     return serviceType.equals(SERVICE_TYPE_TBD);\r
459   }\r
460   \r
461   public ServiceProxyClient getSpClient () {\r
462     return spClient;\r
463   }  \r
464   \r
465   @Override\r
466   public boolean getAuthenticationRequired () {\r
467     return spClient.isAuthenticatingClient();\r
468   }\r
469 \r
470   @Override\r
471   public String getCheckHistory () {\r
472     return ":pz2watch:stateForm:windowlocationhash";\r
473   }\r
474     \r
475   @Override\r
476   public String getWatchActiveclients () {\r
477     return ":pz2watch:activeclientsForm:activeclientsField";\r
478   }\r
479   \r
480   @Override\r
481   public String getWatchActiveclientsRecord () {\r
482     return ":pz2watch:activeclientsForm:activeclientsFieldRecord";\r
483   }\r
484 \r
485   @Override\r
486   public void configure(ConfigurationReader reader)\r
487       throws ConfigurationException {\r
488     Configuration config = reader.getConfiguration(this);\r
489     if (config == null) {\r
490       serviceType = SERVICE_TYPE_TBD;\r
491     } else {\r
492       String service = config.get("TYPE");\r
493       if (service == null || service.length()==0) {\r
494         serviceType = SERVICE_TYPE_TBD;\r
495       } else if (serviceTypes.contains(service.toUpperCase())) {        \r
496         setServiceType(service.toUpperCase());\r
497       } else {\r
498         logger.error("Unknown serviceType type in configuration [" + service + "], can be one of " + serviceTypes);\r
499         serviceType = SERVICE_TYPE_TBD;\r
500       }\r
501       serviceProxyUrls = config.getMultiProperty(SERVICE_PROXY_URL_LIST,",");\r
502       pazpar2Urls = config.getMultiProperty(PAZPAR2_URL_LIST, ",");\r
503     }\r
504     logger.info(reader.document());\r
505     logger.info("Service Type is configured to " + serviceType);\r
506     \r
507   }\r
508 \r
509   @Override\r
510   public Map<String, String> getDefaults() {\r
511     return new HashMap<String,String>();\r
512   }\r
513 \r
514   @Override\r
515   public String getModuleName() {\r
516     return MODULE_NAME;\r
517   }\r
518 \r
519   @Override\r
520   public List<String> documentConfiguration() {\r
521     return new ArrayList<String>();\r
522   }\r
523 \r
524   @Override\r
525   public void setServiceTypePZ2() {\r
526     setServiceType(SERVICE_TYPE_PZ2);    \r
527   }\r
528 \r
529   @Override\r
530   public void setServiceTypeSP() {\r
531     setServiceType(SERVICE_TYPE_SP);        \r
532   }\r
533 \r
534   @Override\r
535   public void setServiceTypeTBD() {\r
536     setServiceType(SERVICE_TYPE_TBD);    \r
537   }\r
538   \r
539   private void setServiceType(String type) {\r
540     if (!serviceType.equals(type)  &&\r
541         !serviceType.equals(SERVICE_TYPE_TBD)) {\r
542       resetSearchAndRecordCommands();\r
543       pzresp.resetAllSessionData();\r
544     }\r
545     serviceType = type;\r
546     if (serviceType.equals(SERVICE_TYPE_PZ2)) {\r
547       searchClient = pz2Client;\r
548       logger.info("Setting a Pazpar2 client to serve requests.");\r
549     } else if (serviceType.equals(SERVICE_TYPE_SP)) {\r
550       searchClient = spClient;\r
551       logger.info("Setting a Service Proxy client to serve requests.");\r
552     } else {\r
553       logger.info("Clearing search client. No client defined to serve requests at this point.");\r
554       searchClient = null;\r
555     }\r
556   }\r
557   \r
558 }\r