1 package com.indexdata.mkjsf.pazpar2;
\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
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
16 import org.apache.log4j.Logger;
\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.state.StateListener;
\r
34 import com.indexdata.mkjsf.pazpar2.state.StateManager;
\r
35 import com.indexdata.mkjsf.utils.Utils;
\r
37 @Named("pz2") @SessionScoped
\r
38 public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Serializable {
\r
40 private static final String MODULE_NAME = "service";
\r
41 private static String SERVICE_TYPE_TBD = "TBD", SERVICE_TYPE_PZ2 = "PZ2", SERVICE_TYPE_SP = "SP";
\r
42 private static final List<String> serviceTypes =
\r
43 Arrays.asList(SERVICE_TYPE_PZ2,SERVICE_TYPE_SP,SERVICE_TYPE_TBD);
\r
44 private String serviceType = SERVICE_TYPE_TBD;
\r
45 private List<String> serviceProxyUrls = new ArrayList<String>();
\r
46 public static final String SERVICE_PROXY_URL_LIST = "SERVICE_PROXY_URL_LIST";
\r
47 private List<String> pazpar2Urls = new ArrayList<String>();
\r
48 public static final String PAZPAR2_URL_LIST = "PAZPAR2_URL_LIST";
\r
51 private static final long serialVersionUID = 3440277287081557861L;
\r
52 private static Logger logger = Logger.getLogger(Pz2Bean.class);
\r
53 private static Logger responseLogger = Logger.getLogger("com.indexdata.mkjsf.pazpar2.responses");
\r
54 protected Pz2Client pz2Client = null;
\r
55 protected ServiceProxyClient spClient = null;
\r
56 protected SearchClient searchClient = null;
\r
58 @Inject ConfigurationReader configurator;
\r
59 @Inject StateManager stateMgr;
\r
60 @Inject Pazpar2Commands pzreq;
\r
61 @Inject Responses pzresp;
\r
62 @Inject ErrorCentral errors;
\r
64 protected ResultsPager pager = null;
\r
66 protected ErrorHelper errorHelper = null;
\r
69 logger.info("Instantiating pz2 bean [" + Utils.objectId(this) + "]");
\r
73 public void postConstruct() {
\r
74 logger.debug("Pz2Bean post-construct: Configurator is " + configurator);
\r
75 logger.debug(Utils.objectId(this) + " will instantiate a Pz2Client next.");
\r
76 pz2Client = new Pz2Client();
\r
77 configureClient(pz2Client,configurator);
\r
78 spClient = new ServiceProxyClient();
\r
79 configureClient(spClient,configurator);
\r
81 this.configure(configurator);
\r
82 } catch (ConfigurationException e) {
\r
83 logger.error("There was a problem configuring the Pz2Bean (\"pz2\")");
\r
84 e.printStackTrace();
\r
86 stateMgr.addStateListener(this);
\r
89 public void configureClient(SearchClient client, ConfigurationReader configReader) {
\r
90 logger.debug(Utils.objectId(this) + " will configure search client for the session");
\r
92 client.configure(configReader);
\r
93 } catch (ConfigurationException e) {
\r
94 logger.debug("Pz2Bean adding configuration error");
\r
95 errors.addConfigurationError(new ConfigurationError("Search Client","Configuration",e.getMessage()));
\r
97 logger.info(configReader.document());
\r
98 pzresp.getSp().resetAuthAndBeyond(true);
\r
101 public void resetSearchAndRecordCommands () {
\r
102 pzreq.getRecord().removeParametersInState();
\r
103 pzreq.getSearch().removeParametersInState();
\r
106 public void doSearch(String query) {
\r
107 pzreq.getSearch().setParameter(new CommandParameter("query","=",query));
\r
111 public void doSearch() {
\r
112 if (errors.hasConfigurationErrors()) {
\r
113 logger.error("Ignoring search request due to configuration errors.");
\r
114 } else if (searchClient == null){
\r
115 logger.error("No search client defined. A client must either be pre-configured or selected before searching.");
\r
116 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
118 stateMgr.hasPendingStateChange("search",false);
\r
119 pzresp.resetSearchAndBeyond();
\r
120 pzreq.getRecord().removeParametersInState();
\r
121 pzreq.getShow().setParameterInState(new CommandParameter("start","=",0));
\r
122 logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommand("search").getUrlEncodedParameterValue("query"));
\r
123 searchClient.setSearchCommand(pzreq.getCommand("search"));
\r
124 doCommand("search");
\r
128 public String doRecord() {
\r
129 if (errors.hasConfigurationErrors()) {
\r
130 logger.error("Ignoring record request due to configuration errors.");
\r
132 } else if (!pzreq.getCommand("record").hasParameterValue("id")) {
\r
133 logger.debug("Ignoring record request due to no id parameter.");
\r
135 } else if (pzresp.getSearch().hasApplicationError()) {
\r
136 logger.debug("Ignoring record request due search error.");
\r
139 logger.debug("Executing record command");
\r
140 doCommand("record");
\r
141 return pzresp.getRecord().getActiveClients();
\r
146 * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2
\r
148 * @return Number of activeclients at the time of the 'show' command.
\r
150 public String update () {
\r
151 logger.debug("Updating show,stat,termlist,bytarget from pazpar2");
\r
152 if (errors.hasConfigurationErrors()) {
\r
153 logger.error("Ignoring show,stat,termlist,bytarget commands due to configuration errors.");
\r
155 } else if (pzresp.getSearch().hasApplicationError()) {
\r
156 logger.error("Ignoring show,stat,termlist,bytarget commands due to problem with most recent search.");
\r
158 } else if (!hasQuery()) {
\r
159 logger.debug("Ignoring show,stat,termlist,bytarget commands because there is not yet a query.");
\r
162 return update("show,stat,termlist,bytarget");
\r
167 * Refreshes the data objects listed in 'commands' from pazpar2
\r
170 * @return Number of activeclients at the time of the 'show' command,
\r
171 * or 'new' if search was just initiated.
\r
173 public String update (String commands) {
\r
174 logger.debug("Request to update: " + commands);
\r
176 if (commands.equals("search")) {
\r
179 } else if (commands.equals("record")) {
\r
181 } else if (pzresp.getSearch().isNew()) {
\r
182 // For returning notification of 'search started' quickly to UI
\r
183 logger.info("New search. Marking it old, then returning 'new' to trigger another round-trip.");
\r
184 pzresp.getSearch().setIsNew(false);
\r
187 handleQueryStateChanges(commands);
\r
188 if (pzresp.getSearch().hasApplicationError()) {
\r
189 logger.error("The command(s) " + commands + " cancelled because the latest search command had an error.");
\r
191 } else if (errors.hasConfigurationErrors()) {
\r
192 logger.error("The command(s) " + commands + " cancelled due to configuration errors.");
\r
195 logger.debug("Processing request for " + commands);
\r
196 List<CommandThread> threadList = new ArrayList<CommandThread>();
\r
197 StringTokenizer tokens = new StringTokenizer(commands,",");
\r
198 while (tokens.hasMoreElements()) {
\r
199 threadList.add(new CommandThread(pzreq.getCommand(tokens.nextToken()),searchClient));
\r
201 for (CommandThread thread : threadList) {
\r
204 for (CommandThread thread : threadList) {
\r
207 } catch (InterruptedException e) {
\r
208 e.printStackTrace();
\r
211 for (CommandThread thread : threadList) {
\r
212 String commandName = thread.getCommand().getCommandName();
\r
213 ClientCommandResponse response = (ClientCommandResponse) thread.getCommandResponse();
\r
214 responseLogger.debug("Response was: " + response.getResponseString());
\r
215 ResponseDataObject responseObject = ResponseParser.getParser().getDataObject(response);
\r
216 if (ResponseParser.docTypes.contains(responseObject.getType())) {
\r
217 pzresp.put(commandName, responseObject);
\r
219 logger.info("Unknown doc type [" + responseObject.getType() + "]. Was not cached.");
\r
222 return pzresp.getActiveClients();
\r
225 } catch (ClassCastException cce) {
\r
226 cce.printStackTrace();
\r
228 } catch (NullPointerException npe) {
\r
229 npe.printStackTrace();
\r
231 } catch (Exception e) {
\r
232 e.printStackTrace();
\r
238 public String toggleRecord (String recId) {
\r
239 if (hasRecord(recId)) {
\r
240 pzreq.getRecord().removeParameters();
\r
241 pzresp.put("record", new RecordResponse());
\r
244 pzreq.getRecord().setId(recId);
\r
245 doCommand("record");
\r
246 return pzresp.getRecord().getActiveClients();
\r
251 public boolean hasRecord (String recId) {
\r
252 return pzreq.getCommand("record").hasParameters() && pzresp.getRecord().getRecId().equals(recId);
\r
255 public String getCurrentStateKey () {
\r
256 return stateMgr.getCurrentState().getKey();
\r
259 public void setCurrentStateKey(String key) {
\r
260 stateMgr.setCurrentStateKey(key);
\r
263 protected boolean hasQuery() {
\r
264 return pzreq.getCommand("search").hasParameterValue("query");
\r
269 public ResultsPager getPager () {
\r
270 if (pager == null) {
\r
271 pager = new ResultsPager(pzresp);
\r
277 public ResultsPager setPager (int pageRange) {
\r
278 pager = new ResultsPager(pzresp,pageRange,pzreq);
\r
283 * This methods main purpose is to support browser history.
\r
285 * When the browsers back or forward buttons are pressed, a
\r
286 * re-search /might/ be required - namely if the query changes.
\r
287 * So, as the UI requests updates of the page (show,facets,
\r
288 * etc) this method checks if a search must be executed
\r
289 * before those updates are performed.
\r
291 * @see {@link com.indexdata.mkjsf.pazpar2.state.StateManager#setCurrentStateKey}
\r
294 protected void handleQueryStateChanges (String commands) {
\r
295 if (stateMgr.hasPendingStateChange("search") && hasQuery()) {
\r
296 logger.info("Triggered search: Found pending search change [" + pzreq.getCommand("search").toString() + "], doing search before updating " + commands);
\r
299 if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {
\r
300 logger.debug("Found pending record ID change. Doing record before updating " + commands);
\r
301 stateMgr.hasPendingStateChange("record",false);
\r
302 if (pzreq.getCommand("record").hasParameterValue("id")) {
\r
305 pzresp.put("record", new RecordResponse());
\r
311 * Executes the command and parses the response to create data objects.
\r
312 * If the parsed response is of a known type it will be cached in 'pzresp'
\r
314 * @param commandName The command to be executed
\r
315 * @return An XML response parsed to form a response data object
\r
317 protected ResponseDataObject doCommand(String commandName) {
\r
318 if (pzreq.getCommand(commandName).spOnly() && isPazpar2Service()) {
\r
319 logger.warn("Skipping " + commandName + " - SP-only command, un-supported by Pazpar2");
\r
320 return new ResponseDataObject();
\r
322 ResponseDataObject responseObject = null;
\r
323 logger.info("Request "+commandName + ": "+ pzreq.getCommand("search").toString());
\r
324 Pazpar2Command command = pzreq.getCommand(commandName);
\r
325 long start = System.currentTimeMillis();
\r
326 HttpResponseWrapper commandResponse = searchClient.executeCommand(command);
\r
327 long end = System.currentTimeMillis();
\r
328 logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );
\r
329 responseLogger.debug("Response was: " + commandResponse.getResponseString());
\r
330 if (commandResponse.getContentType().contains("xml")) {
\r
331 responseObject = ResponseParser.getParser().getDataObject((ClientCommandResponse)commandResponse);
\r
332 if (ResponseParser.docTypes.contains(responseObject.getType())) {
\r
333 logger.debug("Storing " + responseObject.getType() + " in pzresp. ");
\r
334 pzresp.put(commandName, responseObject);
\r
336 if (commandName.equals("record")) {
\r
337 logger.debug("Command was 'record' but response not '<record>' - assuming raw record response.");
\r
338 ResponseDataObject recordResponse = new RecordResponse();
\r
339 recordResponse.setType("record");
\r
340 recordResponse.setXml(responseObject.getXml());
\r
341 recordResponse.setAttribute("activeclients", "0");
\r
342 pzresp.put("record", recordResponse);
\r
345 } else if (commandResponse.isBinary()) {
\r
346 responseObject = new RecordResponse();
\r
347 responseObject.setType(commandName);
\r
348 logger.info("Binary response");
\r
349 responseObject.setAttribute("activeclients", "0");
\r
350 responseObject.setXml("<record>binary response</record>");
\r
351 responseObject.setBinary(commandResponse.getBytes());
\r
352 pzresp.put("record", responseObject);
\r
354 logger.error("Response was not found to be XML or binary. The response was not handled.");
\r
356 return responseObject;
\r
361 public void stateUpdated(String commandName) {
\r
362 logger.debug("State change reported for [" + commandName + "]");
\r
363 if (commandName.equals("show")) {
\r
364 logger.debug("Updating show");
\r
365 update(commandName);
\r
369 public void setServiceProxyUrl(String url) {
\r
370 searchClient = spClient;
\r
371 setServiceType(SERVICE_TYPE_SP);
\r
372 setServiceUrl(url);
\r
375 public String getServiceProxyUrl () {
\r
376 if (isServiceProxyService()) {
\r
377 return spClient.getServiceUrl();
\r
383 public void setPazpar2Url(String url) {
\r
384 searchClient = pz2Client;
\r
385 setServiceType(SERVICE_TYPE_PZ2);
\r
386 setServiceUrl(url);
\r
389 public String getPazpar2Url() {
\r
390 if (isPazpar2Service()) {
\r
391 return pz2Client.getServiceUrl();
\r
399 public void setServiceUrl(String url) {
\r
400 if (url!=null && searchClient != null && !url.equals(searchClient.getServiceUrl())) {
\r
401 pzreq.getRecord().removeParametersInState();
\r
402 pzreq.getSearch().removeParametersInState();
\r
403 pzresp.getSp().resetAuthAndBeyond(true);
\r
404 searchClient.setServiceUrl(url);
\r
408 public String getServiceUrl() {
\r
409 return (searchClient!=null ? searchClient.getServiceUrl() : "");
\r
412 public void setServiceId () {
\r
413 pzreq.getRecord().removeParametersInState();
\r
414 pzreq.getSearch().removeParametersInState();
\r
415 pzresp.resetSearchAndBeyond();
\r
416 pz2Client.setServiceId(pzreq.getInit().getService());
\r
419 public String getServiceId () {
\r
420 return pzreq.getInit().getService();
\r
423 public boolean getServiceUrlIsDefined() {
\r
424 return (searchClient != null && searchClient.hasServiceUrl());
\r
427 public List<String> getServiceProxyUrls() {
\r
428 List<String> urls = new ArrayList<String>();
\r
430 urls.addAll(serviceProxyUrls);
\r
434 public List<String> getPazpar2Urls () {
\r
435 List<String> urls = new ArrayList<String>();
\r
437 urls.addAll(pazpar2Urls);
\r
441 public String getServiceType () {
\r
442 return serviceType;
\r
445 public boolean isPazpar2Service () {
\r
446 return serviceType.equals(SERVICE_TYPE_PZ2);
\r
449 public boolean isServiceProxyService() {
\r
450 return serviceType.equals(SERVICE_TYPE_SP);
\r
453 public boolean serviceIsToBeDecided () {
\r
454 return serviceType.equals(SERVICE_TYPE_TBD);
\r
457 public ServiceProxyClient getSpClient () {
\r
462 public boolean getAuthenticationRequired () {
\r
463 return spClient.isAuthenticatingClient();
\r
467 public String getCheckHistory () {
\r
468 return ":pz2watch:stateForm:windowlocationhash";
\r
472 public String getWatchActiveclients () {
\r
473 return ":pz2watch:activeclientsForm:activeclientsField";
\r
477 public String getWatchActiveclientsRecord () {
\r
478 return ":pz2watch:activeclientsForm:activeclientsFieldRecord";
\r
482 public void configure(ConfigurationReader reader)
\r
483 throws ConfigurationException {
\r
484 Configuration config = reader.getConfiguration(this);
\r
485 if (config == null) {
\r
486 serviceType = SERVICE_TYPE_TBD;
\r
488 String service = config.get("TYPE");
\r
489 if (service == null || service.length()==0) {
\r
490 serviceType = SERVICE_TYPE_TBD;
\r
491 } else if (serviceTypes.contains(service.toUpperCase())) {
\r
492 setServiceType(service.toUpperCase());
\r
494 logger.error("Unknown serviceType type in configuration [" + service + "], can be one of " + serviceTypes);
\r
495 serviceType = SERVICE_TYPE_TBD;
\r
497 serviceProxyUrls = config.getMultiProperty(SERVICE_PROXY_URL_LIST,",");
\r
498 pazpar2Urls = config.getMultiProperty(PAZPAR2_URL_LIST, ",");
\r
500 logger.info(reader.document());
\r
501 logger.info("Service Type is configured to " + serviceType);
\r
506 public Map<String, String> getDefaults() {
\r
507 return new HashMap<String,String>();
\r
511 public String getModuleName() {
\r
512 return MODULE_NAME;
\r
516 public List<String> documentConfiguration() {
\r
517 return new ArrayList<String>();
\r
521 public void setServiceTypePZ2() {
\r
522 setServiceType(SERVICE_TYPE_PZ2);
\r
526 public void setServiceTypeSP() {
\r
527 setServiceType(SERVICE_TYPE_SP);
\r
531 public void setServiceTypeTBD() {
\r
532 setServiceType(SERVICE_TYPE_TBD);
\r
535 private void setServiceType(String type) {
\r
536 if (!serviceType.equals(type) &&
\r
537 !serviceType.equals(SERVICE_TYPE_TBD)) {
\r
538 resetSearchAndRecordCommands();
\r
539 pzresp.getSp().resetAuthAndBeyond(true);
\r
541 serviceType = type;
\r
542 if (serviceType.equals(SERVICE_TYPE_PZ2)) {
\r
543 searchClient = pz2Client;
\r
544 logger.info("Setting a Pazpar2 client to serve requests.");
\r
545 } else if (serviceType.equals(SERVICE_TYPE_SP)) {
\r
546 searchClient = spClient;
\r
547 logger.info("Setting a Service Proxy client to serve requests.");
\r
549 logger.info("Clearing search client. No client defined to serve requests at this point.");
\r
550 searchClient = null;
\r