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