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.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
39 @Named("pz2") @SessionScoped
\r
40 public class Pz2Bean implements Pz2Interface, StateListener, Configurable, Serializable {
\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
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
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
67 protected ResultsPager pager = null;
\r
69 protected ErrorHelper errorHelper = null;
\r
72 logger.info("Instantiating pz2 bean [" + Utils.objectId(this) + "]");
\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
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
89 stateMgr.addStateListener(this);
\r
92 public void configureClient(SearchClient client, ConfigurationReader configReader) {
\r
93 logger.debug(Utils.objectId(this) + " will configure search client for the session");
\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
100 logger.info(configReader.document());
\r
101 pzresp.resetAllSessionData();
\r
104 public void resetSearchAndRecordCommands () {
\r
105 pzreq.getRecord().removeParametersInState();
\r
106 pzreq.getSearch().removeParametersInState();
\r
109 public void doSearch(String query) {
\r
110 pzreq.getSearch().setParameter(new CommandParameter("query","=",query));
\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
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
133 public String doRecord() {
\r
134 if (errors.hasConfigurationErrors()) {
\r
135 logger.error("Ignoring record request due to configuration errors.");
\r
137 } else if (!pzreq.getCommand("record").hasParameterValue("id")) {
\r
138 logger.debug("Ignoring record request due to no id parameter.");
\r
140 } else if (pzresp.getSearch().hasApplicationError()) {
\r
141 logger.debug("Ignoring record request due search error.");
\r
144 logger.debug("Executing record command");
\r
145 doCommand("record");
\r
146 return pzresp.getRecord().getActiveClients();
\r
151 * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2
\r
153 * @return Number of activeclients at the time of the 'show' command.
\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
160 } else if (pzresp.getSearch().hasApplicationError()) {
\r
161 logger.error("Ignoring show,stat,termlist,bytarget commands due to problem with most recent search.");
\r
163 } else if (!hasQuery()) {
\r
164 logger.debug("Ignoring show,stat,termlist,bytarget commands because there is not yet a query.");
\r
167 return update("show,stat,termlist,bytarget");
\r
172 * Refreshes the data objects listed in 'commands' from pazpar2
\r
175 * @return Number of activeclients at the time of the 'show' command
\r
177 public String update (String commands) {
\r
178 logger.debug("Request to update: " + commands);
\r
180 if (commands.equals("search")) {
\r
183 } else if (commands.equals("record")) {
\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
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
194 } else if (errors.hasConfigurationErrors()) {
\r
195 logger.error("The command(s) " + commands + " cancelled due to configuration errors.");
\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
204 for (CommandThread thread : threadList) {
\r
207 for (CommandThread thread : threadList) {
\r
210 } catch (InterruptedException e) {
\r
211 e.printStackTrace();
\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
222 logger.info("Unknown doc type [" + responseObject.getType() + "]. Was not cached.");
\r
225 return pzresp.getActiveClients();
\r
228 } catch (ClassCastException cce) {
\r
229 cce.printStackTrace();
\r
231 } catch (NullPointerException npe) {
\r
232 npe.printStackTrace();
\r
234 } catch (Exception e) {
\r
235 e.printStackTrace();
\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
247 pzreq.getRecord().setId(recId);
\r
248 doCommand("record");
\r
249 return pzresp.getRecord().getActiveClients();
\r
254 public boolean hasRecord (String recId) {
\r
255 return pzreq.getCommand("record").hasParameters() && pzresp.getRecord().getRecId().equals(recId);
\r
258 public String getCurrentStateKey () {
\r
259 return stateMgr.getCurrentState().getKey();
\r
262 public void setCurrentStateKey(String key) {
\r
263 stateMgr.setCurrentStateKey(key);
\r
266 protected boolean hasQuery() {
\r
267 return pzreq.getCommand("search").hasParameterValue("query");
\r
272 public ResultsPager getPager () {
\r
273 if (pager == null) {
\r
274 pager = new ResultsPager(pzresp);
\r
280 public ResultsPager setPager (int pageRange) {
\r
281 pager = new ResultsPager(pzresp,pageRange,pzreq);
\r
286 * This methods main purpose is to support browser history.
\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
294 * @see {@link com.indexdata.mkjsf.pazpar2.state.StateManager#setCurrentStateKey}
\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
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
308 pzresp.put("record", new RecordResponse());
\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
317 * @param commandName The command to be executed
\r
318 * @return An XML response parsed to form a response data object
\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
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
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
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
357 logger.error("Response was not found to be XML or binary. The response was not handled.");
\r
359 return responseObject;
\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
372 public void setServiceProxyUrl(String url) {
\r
373 searchClient = spClient;
\r
374 setServiceType(SERVICE_TYPE_SP);
\r
375 setServiceUrl(url);
\r
378 public String getServiceProxyUrl () {
\r
379 if (isServiceProxyService()) {
\r
380 return spClient.getServiceUrl();
\r
386 public void setPazpar2Url(String url) {
\r
387 searchClient = pz2Client;
\r
388 setServiceType(SERVICE_TYPE_PZ2);
\r
389 setServiceUrl(url);
\r
392 public String getPazpar2Url() {
\r
393 if (isPazpar2Service()) {
\r
394 return pz2Client.getServiceUrl();
\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
408 searchClient.setServiceUrl(url);
\r
412 public String getServiceUrl() {
\r
413 return (searchClient!=null ? searchClient.getServiceUrl() : "");
\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
423 public String getServiceId () {
\r
424 return pzreq.getInit().getService();
\r
427 public boolean getServiceUrlIsDefined() {
\r
428 return (searchClient != null && searchClient.hasServiceUrl());
\r
431 public List<String> getServiceProxyUrls() {
\r
432 List<String> urls = new ArrayList<String>();
\r
434 urls.addAll(serviceProxyUrls);
\r
438 public List<String> getPazpar2Urls () {
\r
439 List<String> urls = new ArrayList<String>();
\r
441 urls.addAll(pazpar2Urls);
\r
445 public String getServiceType () {
\r
446 return serviceType;
\r
449 public boolean isPazpar2Service () {
\r
450 return serviceType.equals(SERVICE_TYPE_PZ2);
\r
453 public boolean isServiceProxyService() {
\r
454 return serviceType.equals(SERVICE_TYPE_SP);
\r
457 public boolean serviceIsToBeDecided () {
\r
458 return serviceType.equals(SERVICE_TYPE_TBD);
\r
461 public ServiceProxyClient getSpClient () {
\r
466 public boolean getAuthenticationRequired () {
\r
467 return spClient.isAuthenticatingClient();
\r
471 public String getCheckHistory () {
\r
472 return ":pz2watch:stateForm:windowlocationhash";
\r
476 public String getWatchActiveclients () {
\r
477 return ":pz2watch:activeclientsForm:activeclientsField";
\r
481 public String getWatchActiveclientsRecord () {
\r
482 return ":pz2watch:activeclientsForm:activeclientsFieldRecord";
\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
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
498 logger.error("Unknown serviceType type in configuration [" + service + "], can be one of " + serviceTypes);
\r
499 serviceType = SERVICE_TYPE_TBD;
\r
501 serviceProxyUrls = config.getMultiProperty(SERVICE_PROXY_URL_LIST,",");
\r
502 pazpar2Urls = config.getMultiProperty(PAZPAR2_URL_LIST, ",");
\r
504 logger.info(reader.document());
\r
505 logger.info("Service Type is configured to " + serviceType);
\r
510 public Map<String, String> getDefaults() {
\r
511 return new HashMap<String,String>();
\r
515 public String getModuleName() {
\r
516 return MODULE_NAME;
\r
520 public List<String> documentConfiguration() {
\r
521 return new ArrayList<String>();
\r
525 public void setServiceTypePZ2() {
\r
526 setServiceType(SERVICE_TYPE_PZ2);
\r
530 public void setServiceTypeSP() {
\r
531 setServiceType(SERVICE_TYPE_SP);
\r
535 public void setServiceTypeTBD() {
\r
536 setServiceType(SERVICE_TYPE_TBD);
\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
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
553 logger.info("Clearing search client. No client defined to serve requests at this point.");
\r
554 searchClient = null;
\r