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