1 package com.indexdata.pz2utils4jsf.pazpar2;
\r
3 import java.io.IOException;
\r
4 import java.util.ArrayList;
\r
5 import java.util.List;
\r
6 import java.util.Map;
\r
7 import java.util.StringTokenizer;
\r
8 import java.util.concurrent.ConcurrentHashMap;
\r
10 import javax.enterprise.context.SessionScoped;
\r
11 import javax.inject.Named;
\r
13 import org.apache.log4j.Logger;
\r
15 import com.indexdata.masterkey.pazpar2.client.Pazpar2Client;
\r
16 import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration;
\r
17 import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric;
\r
18 import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException;
\r
19 import com.indexdata.pz2utils4jsf.config.Pz2Configurator;
\r
20 import com.indexdata.pz2utils4jsf.controls.ResultsPager;
\r
21 import com.indexdata.pz2utils4jsf.errors.ErrorInterface;
\r
22 import com.indexdata.pz2utils4jsf.errors.ErrorHelper;
\r
23 import com.indexdata.pz2utils4jsf.errors.ConfigurationError;
\r
24 import com.indexdata.pz2utils4jsf.pazpar2.data.CommandError;
\r
25 import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget;
\r
26 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseData;
\r
27 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseParser;
\r
28 import com.indexdata.pz2utils4jsf.pazpar2.data.RecordResponse;
\r
29 import com.indexdata.pz2utils4jsf.pazpar2.data.SearchResponse;
\r
30 import com.indexdata.pz2utils4jsf.pazpar2.data.ShowResponse;
\r
31 import com.indexdata.pz2utils4jsf.pazpar2.data.StatResponse;
\r
32 import com.indexdata.pz2utils4jsf.pazpar2.data.TermListsResponse;
\r
33 import com.indexdata.pz2utils4jsf.pazpar2.data.TermResponse;
\r
34 import com.indexdata.pz2utils4jsf.pazpar2.state.QueryStates;
\r
35 import com.indexdata.pz2utils4jsf.utils.Utils;
\r
37 @Named @SessionScoped
\r
38 public class Pz2Session implements Pz2Interface {
\r
40 private static Logger logger = Logger.getLogger(Pz2Session.class);
\r
42 private Map<String,Pazpar2ResponseData> dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();
\r
43 private QueryStates queryStates = new QueryStates();
\r
45 private static final long serialVersionUID = 3947514708343320514L;
\r
46 private Pazpar2ClientConfiguration cfg = null;
\r
47 private Pazpar2Client client = null;
\r
48 private TargetFilter targetFilter = null;
\r
49 private ResultsPager pager = null;
\r
50 private ErrorHelper errorHelper = null;
\r
51 private List<ErrorInterface> configurationErrors = null;
\r
53 public Pz2Session () {
\r
54 logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]");
\r
57 public void init(Pz2Configurator pz2conf) {
\r
59 configurationErrors = new ArrayList<ErrorInterface>();
\r
60 errorHelper = new ErrorHelper(pz2conf);
\r
61 logger.info(Utils.objectId(this) + " is configuring itself using the provided " + Utils.objectId(pz2conf));
\r
63 cfg = new Pazpar2ClientConfiguration(pz2conf.getConfig());
\r
64 } catch (ProxyErrorException pe) {
\r
65 logger.error("Could not configure Pazpar2 client: " + pe.getMessage());
\r
66 configurationErrors.add(new ConfigurationError("Pz2Client Config","ProxyError","Could not configure Pazpar2 client: " + pe.getMessage(),errorHelper));
\r
67 } catch (IOException io) {
\r
68 logger.error("Could not configure Pazpar2 client: " + io.getMessage());
\r
69 configurationErrors.add(new ConfigurationError("Pz2Client Config","ProxyError","Could not configure Pazpar2 client: " + io.getMessage(),errorHelper));
\r
73 client = new Pazpar2ClientGeneric(cfg);
\r
74 } catch (ProxyErrorException pe) {
\r
75 logger.error("Could not instantiate Pazpar2 client: " + pe.getMessage());
\r
76 configurationErrors.add(new ConfigurationError("Pz2Client error","ProxyError","Could not create Pazpar2 client: " +pe.getMessage(),errorHelper));
\r
78 logger.info("Found " + configurationErrors.size() + " configuration errors");
\r
82 logger.warn("Attempt to configure session but it already has a configured client");
\r
86 public void doSearch(String query) {
\r
87 setCommandParameter("search",new CommandParameter("query","=",query));
\r
91 public void doSearch() {
\r
92 queryStates.hasPendingStateChange("search",false);
\r
94 setCommandParameter("show",new CommandParameter("start","=",0));
\r
95 logger.debug(Utils.objectId(this) + " is searching using "+getCommand("search").getParameter("query").getEncodedQueryString());
\r
96 doCommand("search");
\r
100 * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2
\r
102 * @return Number of activeclients at the time of the 'show' command.
\r
104 public String update () {
\r
105 logger.debug("Updating show,stat,termlist,bytarget from pazpar2");
\r
106 return update("show,stat,termlist,bytarget");
\r
110 * Refreshes the data objects listed in 'commands' from pazpar2
\r
113 * @return Number of activeclients at the time of the 'show' command
\r
115 public String update (String commands) {
\r
116 if (! hasConfigurationErrors()) {
\r
118 handleQueryStateChanges(commands);
\r
119 logger.debug("Processing request for " + commands);
\r
120 List<CommandThread> threadList = new ArrayList<CommandThread>();
\r
121 StringTokenizer tokens = new StringTokenizer(commands,",");
\r
122 while (tokens.hasMoreElements()) {
\r
123 threadList.add(new CommandThread(getCommand(tokens.nextToken()),client));
\r
125 for (CommandThread thread : threadList) {
\r
128 for (CommandThread thread : threadList) {
\r
131 } catch (InterruptedException e) {
\r
132 e.printStackTrace();
\r
135 for (CommandThread thread : threadList) {
\r
136 String commandName = thread.getCommand().getName();
\r
137 Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(thread.getResponse());
\r
138 dataObjects.put(commandName, responseObject);
\r
140 return getActiveClients();
\r
142 logger.debug("Skipped requests for " + commands + " as there's not yet a query.");
\r
143 resetDataObjects();
\r
147 logger.error("Did not attempt to execute query since there are configuration errors.");
\r
153 public void setQuery (String query) {
\r
154 logger.debug("Creating new command parameter for " + query);
\r
155 setCommandParameter("search",new CommandParameter("query","=",query));
\r
158 public String getQuery () {
\r
159 return getCommandParameterValueSimple("search","query",null);
\r
162 public void setFacet (String facetKey, String term) {
\r
163 if (term != null && term.length()>0) {
\r
164 queryStates.getCurrentState().setCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);
\r
169 public void setFacetOnQuery (String facetKey, String term) {
\r
170 String facetExpression = facetKey + "=" + term;
\r
171 if (term != null && term.length()>0) {
\r
172 setCommandParameter("search",new CommandParameter("query","=", getQuery() + " and " + facetExpression));
\r
177 public void removeFacet(String facetKey, String term) {
\r
178 queryStates.getCurrentState().removeCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);
\r
182 public void setTargetFilter (String targetId, String targetName) {
\r
183 if (hasTargetFilter(new TargetFilter(targetId,targetName))) {
\r
184 logger.debug("Already using target filter " + this.targetFilter.getFilterExpression());
\r
186 this.targetFilter = new TargetFilter(targetId,targetName);
\r
187 setCommandParameter("search",new CommandParameter("filter","=",this.targetFilter.getFilterExpression()));
\r
192 public TargetFilter getTargetFilter () {
\r
193 return targetFilter;
\r
196 public void removeTargetFilter () {
\r
197 logger.debug("Removing target filter " + targetFilter.getFilterExpression());
\r
198 this.targetFilter = null;
\r
199 removeCommandParameter("search","filter");
\r
203 public boolean hasTargetFilter() {
\r
204 return targetFilter != null;
\r
207 public void setSort (String sortOption) {
\r
208 logger.debug("Setting sort option: " + sortOption);
\r
209 setCommandParameter("show",new CommandParameter("sort","=",sortOption));
\r
213 public String getSort () {
\r
214 return getCommandParameterValue("show","sort","relevance");
\r
217 public void setPageSize (int perPageOption) {
\r
218 if (getPageSize()!=perPageOption) {
\r
219 logger.debug("Setting perpage option to " + perPageOption + " and resetting start page.");
\r
220 setCommandParameter("show",new CommandParameter("num","=",perPageOption));
\r
221 setCommandParameter("show",new CommandParameter("start","=",0));
\r
224 logger.debug("Not updating page size, already is " + perPageOption);
\r
228 public int getPageSize () {
\r
229 return getCommandParameterValue("show","num",20);
\r
232 public void setStart (int start) {
\r
233 logger.debug("Setting start num to " + start);
\r
234 setCommandParameter("show", new CommandParameter("start","=",start));
\r
238 public int getStart() {
\r
239 return getCommandParameterValue("show","start",0);
\r
242 public String toggleRecord (String recId) {
\r
243 if (hasRecord(recId)) {
\r
244 removeCommand("record");
\r
245 dataObjects.put("record", new RecordResponse());
\r
248 return updateRecord(recId);
\r
252 private String updateRecord(String recId) {
\r
253 setCommandParameter("record",new CommandParameter("id","=",recId));
\r
254 return doCommand("record");
\r
257 public boolean hasRecord (String recId) {
\r
258 return getCommand("record").hasParameters() && getRecord().getRecId().equals(recId);
\r
261 public ShowResponse getShow () {
\r
262 return ((ShowResponse) dataObjects.get("show"));
\r
265 public StatResponse getStat () {
\r
266 return ((StatResponse) dataObjects.get("stat"));
\r
269 public RecordResponse getRecord() {
\r
270 return ((RecordResponse) dataObjects.get("record"));
\r
273 public TermListsResponse getTermLists () {
\r
274 return ((TermListsResponse) dataObjects.get("termlist"));
\r
277 public List<TermResponse> getFacetTerms (String facet, int count) {
\r
278 return (getTermLists().getTermList(facet).getTerms(count));
\r
281 public List<TermResponse> getFacetTerms (String facet) {
\r
282 return (getTermLists().getTermList(facet).getTerms());
\r
285 public ByTarget getByTarget() {
\r
286 return ((ByTarget) dataObjects.get("bytarget"));
\r
290 public String getCurrentStateKey () {
\r
291 return queryStates.getCurrentStateKey();
\r
294 public void setCurrentStateKey(String key) {
\r
295 queryStates.setCurrentStateKey(key);
\r
298 public boolean hasConfigurationErrors () {
\r
299 return (configurationErrors.size()>0);
\r
302 public boolean hasCommandErrors () {
\r
303 if (dataObjects.get("search").hasApplicationError()) {
\r
304 logger.info("Error detected in search");
\r
307 for (String name : dataObjects.keySet()) {
\r
308 if (dataObjects.get(name).hasApplicationError()) {
\r
309 logger.info("Error detected in " + name);
\r
317 * Returns true if application error found in any response data objects
\r
319 public boolean hasErrors () {
\r
320 return hasConfigurationErrors() || hasCommandErrors();
\r
323 public List<ErrorInterface> getConfigurationErrors() {
\r
324 return configurationErrors;
\r
328 * Returns a search command error, if any, otherwise the first
\r
329 * error found for an arbitrary command, if any, otherwise
\r
330 * an empty dummy error.
\r
332 public ErrorInterface getCommandError() {
\r
333 CommandError error = new CommandError();
\r
334 if (dataObjects.get("search").hasApplicationError()) {
\r
335 error = dataObjects.get("search").getApplicationError();
\r
337 for (String name : dataObjects.keySet()) {
\r
338 if (dataObjects.get(name).hasApplicationError()) {
\r
339 error = dataObjects.get(name).getApplicationError();
\r
344 error.setErrorHelper(errorHelper);
\r
349 private boolean hasTargetFilter(TargetFilter targetFilter) {
\r
350 return hasTargetFilter() && targetFilter.equals(this.targetFilter);
\r
353 private boolean hasQuery() {
\r
354 return !(getCommand("search").getParameter("query") == null);
\r
357 public boolean hasRecords () {
\r
358 return getStat().getRecords() > 0
\r
359 && getShow().getHits() != null
\r
360 && getShow().getHits().size()>0;
\r
363 public ResultsPager getPager () {
\r
364 if (pager == null) {
\r
365 pager = new ResultsPager(this);
\r
370 public ResultsPager setPager (int pageRange) {
\r
371 pager = new ResultsPager(this,pageRange);
\r
375 protected ErrorHelper getTroubleshooter() {
\r
376 return errorHelper;
\r
379 private void handleQueryStateChanges (String commands) {
\r
380 if (queryStates.hasPendingStateChange("search")) {
\r
381 logger.debug("Found pending search change. Doing search before updating " + commands);
\r
384 if (queryStates.hasPendingStateChange("record") && ! commands.equals("record")) {
\r
385 logger.debug("Found pending record ID change. Doing record before updating " + commands);
\r
386 queryStates.hasPendingStateChange("record",false);
\r
387 if (getCommand("record").hasParameters()) {
\r
388 updateRecord(getCommand("record").getParameter("id").getSimpleValue());
\r
390 removeCommand("record");
\r
391 dataObjects.put("record", new RecordResponse());
\r
396 private String getActiveClients() {
\r
397 if (getShow()!=null) {
\r
398 logger.debug("Active clients: "+getShow().getActiveClients());
\r
399 return getShow().getActiveClients();
\r
405 private Pazpar2Command getCommand(String name) {
\r
406 return queryStates.getCurrentState().getCommand(name);
\r
409 private void setCommandParameter(String commandName, CommandParameter parameter) {
\r
410 logger.debug("Setting parameter for " + commandName + ": " + parameter);
\r
411 queryStates.getCurrentState().setCommandParameter(commandName, parameter, queryStates);
\r
415 private void removeCommandParameter(String commandName, String parameterName) {
\r
416 queryStates.getCurrentState().removeCommandParameter(commandName,parameterName,queryStates);
\r
419 private void removeCommand (String commandName) {
\r
420 queryStates.getCurrentState().removeCommand(commandName, queryStates);
\r
423 private String getCommandParameterValue (String commandName, String parameterName, String defaultValue) {
\r
424 Pazpar2Command command = getCommand(commandName);
\r
425 if (command != null) {
\r
426 CommandParameter parameter = command.getParameter(parameterName);
\r
427 if (parameter != null) {
\r
428 return parameter.getValueWithExpressions();
\r
431 return defaultValue;
\r
434 private String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) {
\r
435 Pazpar2Command command = getCommand(commandName);
\r
436 if (command != null) {
\r
437 CommandParameter parameter = command.getParameter(parameterName);
\r
438 if (parameter != null) {
\r
439 return parameter.getSimpleValue();
\r
442 return defaultValue;
\r
446 private int getCommandParameterValue (String commandName, String parameterName, int defaultValue) {
\r
447 Pazpar2Command command = getCommand(commandName);
\r
448 if (command != null) {
\r
449 CommandParameter parameter = command.getParameter(parameterName);
\r
450 if (parameter != null) {
\r
451 return Integer.parseInt(parameter.getSimpleValue());
\r
454 return defaultValue;
\r
457 private String doCommand(String commandName) {
\r
458 Pazpar2Command command = getCommand(commandName);
\r
459 logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString());
\r
460 return update(commandName);
\r
463 private void resetDataObjects() {
\r
464 logger.debug("Resetting show,stat,termlist,bytarget,search response objects.");
\r
465 dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();
\r
466 dataObjects.put("show", new ShowResponse());
\r
467 dataObjects.put("stat", new StatResponse());
\r
468 dataObjects.put("termlist", new TermListsResponse());
\r
469 dataObjects.put("bytarget", new ByTarget());
\r
470 dataObjects.put("record", new RecordResponse());
\r
471 dataObjects.put("search", new SearchResponse());
\r