+++ /dev/null
-package com.indexdata.pz2utils4jsf.pazpar2;\r
-\r
-import java.io.IOException;\r
-import java.util.ArrayList;\r
-import java.util.List;\r
-import java.util.Map;\r
-import java.util.StringTokenizer;\r
-import java.util.concurrent.ConcurrentHashMap;\r
-\r
-import javax.enterprise.context.SessionScoped;\r
-import javax.inject.Named;\r
-\r
-import org.apache.log4j.Logger;\r
-\r
-import com.indexdata.masterkey.pazpar2.client.Pazpar2Client;\r
-import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration;\r
-import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric;\r
-import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException;\r
-import com.indexdata.pz2utils4jsf.config.Pz2Configurator;\r
-import com.indexdata.pz2utils4jsf.controls.ResultsPager;\r
-import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
-import com.indexdata.pz2utils4jsf.errors.ErrorInterface;\r
-import com.indexdata.pz2utils4jsf.errors.ErrorHelper;\r
-import com.indexdata.pz2utils4jsf.errors.ConfigurationError;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.CommandError;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseData;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseParser;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.RecordResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.SearchResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.ShowResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.StatResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.TermListsResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.data.TermResponse;\r
-import com.indexdata.pz2utils4jsf.pazpar2.state.QueryStates;\r
-import com.indexdata.pz2utils4jsf.utils.Utils;\r
-\r
-@Named @SessionScoped \r
-public class Pz2Session implements Pz2Interface {\r
- \r
- private static Logger logger = Logger.getLogger(Pz2Session.class);\r
- \r
- private Map<String,Pazpar2ResponseData> dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
- private QueryStates queryStates = new QueryStates();\r
- \r
- private static final long serialVersionUID = 3947514708343320514L; \r
- private Pazpar2ClientConfiguration cfg = null;\r
- private Pazpar2Client client = null; \r
- private TargetFilter targetFilter = null; \r
- private ResultsPager pager = null; \r
- private ErrorHelper errorHelper = null;\r
- private List<ErrorInterface> configurationErrors = null;\r
- \r
- public Pz2Session () {\r
- logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]"); \r
- }\r
- \r
- public void init(Pz2Configurator pz2conf) {\r
- if (client==null) {\r
- configurationErrors = new ArrayList<ErrorInterface>();\r
- errorHelper = new ErrorHelper(pz2conf);\r
- logger.info(Utils.objectId(this) + " is configuring itself using the provided " + Utils.objectId(pz2conf));\r
- try {\r
- cfg = new Pazpar2ClientConfiguration(pz2conf.getConfig());\r
- } catch (ProxyErrorException pe) {\r
- logger.error("Could not configure Pazpar2 client: " + pe.getMessage());\r
- configurationErrors.add(new ConfigurationError("Pz2Client Config","ProxyError","Could not configure Pazpar2 client: " + pe.getMessage(),errorHelper));\r
- } catch (ConfigurationException io) {\r
- logger.error("Could not configure Pazpar2 client: " + io.getMessage());\r
- configurationErrors.add(new ConfigurationError("Pz2Client Config","ProxyError","Could not configure Pazpar2 client: " + io.getMessage(),errorHelper));\r
- }\r
- if (cfg != null) {\r
- try {\r
- client = new Pazpar2ClientGeneric(cfg); \r
- } catch (ProxyErrorException pe) {\r
- logger.error("Could not instantiate Pazpar2 client: " + pe.getMessage());\r
- configurationErrors.add(new ConfigurationError("Pz2Client error","ProxyError","Could not create Pazpar2 client: " +pe.getMessage(),errorHelper)); \r
- } \r
- logger.info("Found " + configurationErrors.size() + " configuration errors"); \r
- }\r
- resetDataObjects();\r
- } else {\r
- logger.warn("Attempt to configure session but it already has a configured client");\r
- }\r
- }\r
- \r
- public void doSearch(String query) {\r
- setCommandParameter("search",new CommandParameter("query","=",query)); \r
- doSearch();\r
- }\r
-\r
- public void doSearch() { \r
- queryStates.hasPendingStateChange("search",false);\r
- resetDataObjects();\r
- setCommandParameter("show",new CommandParameter("start","=",0)); \r
- logger.debug(Utils.objectId(this) + " is searching using "+getCommand("search").getParameter("query").getEncodedQueryString());\r
- doCommand("search"); \r
- }\r
- \r
- /**\r
- * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
- * \r
- * @return Number of activeclients at the time of the 'show' command.\r
- */\r
- public String update () {\r
- logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
- return update("show,stat,termlist,bytarget");\r
- }\r
- \r
- /**\r
- * Refreshes the data objects listed in 'commands' from pazpar2\r
- * \r
- * @param commands\r
- * @return Number of activeclients at the time of the 'show' command\r
- */\r
- public String update (String commands) {\r
- if (! hasConfigurationErrors()) {\r
- if (hasQuery()) {\r
- handleQueryStateChanges(commands);\r
- logger.debug("Processing request for " + commands); \r
- List<CommandThread> threadList = new ArrayList<CommandThread>();\r
- StringTokenizer tokens = new StringTokenizer(commands,",");\r
- while (tokens.hasMoreElements()) {\r
- threadList.add(new CommandThread(getCommand(tokens.nextToken()),client)); \r
- }\r
- for (CommandThread thread : threadList) {\r
- thread.start();\r
- }\r
- for (CommandThread thread : threadList) {\r
- try {\r
- thread.join();\r
- } catch (InterruptedException e) {\r
- e.printStackTrace();\r
- }\r
- }\r
- for (CommandThread thread : threadList) {\r
- String commandName = thread.getCommand().getName();\r
- Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(thread.getResponse());\r
- dataObjects.put(commandName, responseObject); \r
- }\r
- return getActiveClients();\r
- } else {\r
- logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
- resetDataObjects();\r
- return "0";\r
- }\r
- } else {\r
- logger.error("Did not attempt to execute query since there are configuration errors.");\r
- return "0";\r
- }\r
- \r
- }\r
- \r
- public void setQuery (String query) {\r
- logger.debug("Creating new command parameter for " + query);\r
- setCommandParameter("search",new CommandParameter("query","=",query));\r
- }\r
- \r
- public String getQuery () {\r
- return getCommandParameterValueSimple("search","query",null);\r
- }\r
- \r
- public void setFacet (String facetKey, String term) { \r
- if (term != null && term.length()>0) {\r
- queryStates.getCurrentState().setCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
- doSearch();\r
- } \r
- }\r
- \r
- public void setFacetOnQuery (String facetKey, String term) {\r
- String facetExpression = facetKey + "=" + term; \r
- if (term != null && term.length()>0) {\r
- setCommandParameter("search",new CommandParameter("query","=", getQuery() + " and " + facetExpression));\r
- doSearch(); \r
- } \r
- }\r
- \r
- public void removeFacet(String facetKey, String term) {\r
- queryStates.getCurrentState().removeCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
- doSearch();\r
- }\r
- \r
- public void setTargetFilter (String targetId, String targetName) { \r
- if (hasTargetFilter(new TargetFilter(targetId,targetName))) {\r
- logger.debug("Already using target filter " + this.targetFilter.getFilterExpression());\r
- } else { \r
- this.targetFilter = new TargetFilter(targetId,targetName);\r
- setCommandParameter("search",new CommandParameter("filter","=",this.targetFilter.getFilterExpression())); \r
- doSearch();\r
- } \r
- }\r
-\r
- public TargetFilter getTargetFilter () {\r
- return targetFilter;\r
- }\r
- \r
- public void removeTargetFilter () {\r
- logger.debug("Removing target filter " + targetFilter.getFilterExpression());\r
- this.targetFilter = null;\r
- removeCommandParameter("search","filter"); \r
- doSearch();\r
- }\r
- \r
- public boolean hasTargetFilter() {\r
- return targetFilter != null; \r
- }\r
- \r
- public void setSort (String sortOption) {\r
- logger.debug("Setting sort option: " + sortOption);\r
- setCommandParameter("show",new CommandParameter("sort","=",sortOption));\r
- update("show");\r
- }\r
- \r
- public String getSort () {\r
- return getCommandParameterValue("show","sort","relevance");\r
- }\r
- \r
- public void setPageSize (int perPageOption) {\r
- if (getPageSize()!=perPageOption) {\r
- logger.debug("Setting perpage option to " + perPageOption + " and resetting start page.");\r
- setCommandParameter("show",new CommandParameter("num","=",perPageOption));\r
- setCommandParameter("show",new CommandParameter("start","=",0));\r
- update("show");\r
- } else {\r
- logger.debug("Not updating page size, already is " + perPageOption);\r
- }\r
- }\r
- \r
- public int getPageSize () {\r
- return getCommandParameterValue("show","num",20);\r
- }\r
- \r
- public void setStart (int start) {\r
- logger.debug("Setting start num to " + start);\r
- setCommandParameter("show", new CommandParameter("start","=",start)); \r
- update("show");\r
- }\r
- \r
- public int getStart() {\r
- return getCommandParameterValue("show","start",0);\r
- }\r
- \r
- public String toggleRecord (String recId) {\r
- if (hasRecord(recId)) {\r
- removeCommand("record"); \r
- dataObjects.put("record", new RecordResponse());\r
- return "";\r
- } else {\r
- return updateRecord(recId);\r
- }\r
- }\r
- \r
- private String updateRecord(String recId) { \r
- setCommandParameter("record",new CommandParameter("id","=",recId)); \r
- return doCommand("record"); \r
- }\r
- \r
- public boolean hasRecord (String recId) {\r
- return getCommand("record").hasParameters() && getRecord().getRecId().equals(recId);\r
- }\r
- \r
- public ShowResponse getShow () {\r
- return ((ShowResponse) dataObjects.get("show"));\r
- }\r
- \r
- public StatResponse getStat () {\r
- return ((StatResponse) dataObjects.get("stat"));\r
- }\r
- \r
- public RecordResponse getRecord() {\r
- return ((RecordResponse) dataObjects.get("record"));\r
- }\r
- \r
- public TermListsResponse getTermLists () {\r
- return ((TermListsResponse) dataObjects.get("termlist"));\r
- }\r
- \r
- public List<TermResponse> getFacetTerms (String facet, int count) {\r
- return (getTermLists().getTermList(facet).getTerms(count));\r
- }\r
- \r
- public List<TermResponse> getFacetTerms (String facet) {\r
- return (getTermLists().getTermList(facet).getTerms());\r
- }\r
- \r
- public ByTarget getByTarget() {\r
- return ((ByTarget) dataObjects.get("bytarget"));\r
- }\r
- \r
- \r
- public String getCurrentStateKey () { \r
- return queryStates.getCurrentStateKey();\r
- }\r
- \r
- public void setCurrentStateKey(String key) { \r
- queryStates.setCurrentStateKey(key);\r
- }\r
- \r
- public boolean hasConfigurationErrors () {\r
- return (configurationErrors.size()>0); \r
- }\r
- \r
- public boolean hasCommandErrors () {\r
- if (dataObjects.get("search").hasApplicationError()) {\r
- logger.info("Error detected in search");\r
- return true;\r
- }\r
- for (String name : dataObjects.keySet()) {\r
- if (dataObjects.get(name).hasApplicationError()) {\r
- logger.info("Error detected in " + name);\r
- return true;\r
- }\r
- } \r
- return false; \r
- }\r
- \r
- /**\r
- * Returns true if application error found in any response data objects \r
- */\r
- public boolean hasErrors () {\r
- return hasConfigurationErrors() || hasCommandErrors();\r
- }\r
-\r
- public List<ErrorInterface> getConfigurationErrors() { \r
- return configurationErrors;\r
- }\r
- \r
- /**\r
- * Returns a search command error, if any, otherwise the first\r
- * error found for an arbitrary command, if any, otherwise\r
- * an empty dummy error. \r
- */ \r
- public ErrorInterface getCommandError() {\r
- CommandError error = new CommandError(); \r
- if (dataObjects.get("search").hasApplicationError()) {\r
- error = dataObjects.get("search").getApplicationError(); \r
- } else {\r
- for (String name : dataObjects.keySet()) { \r
- if (dataObjects.get(name).hasApplicationError()) { \r
- error = dataObjects.get(name).getApplicationError(); \r
- break;\r
- } \r
- }\r
- }\r
- error.setErrorHelper(errorHelper);\r
- return error; \r
- }\r
-\r
- \r
- private boolean hasTargetFilter(TargetFilter targetFilter) {\r
- return hasTargetFilter() && targetFilter.equals(this.targetFilter);\r
- }\r
- \r
- private boolean hasQuery() {\r
- return !(getCommand("search").getParameter("query") == null);\r
- }\r
- \r
- public boolean hasRecords () {\r
- return getStat().getRecords() > 0 \r
- && getShow().getHits() != null \r
- && getShow().getHits().size()>0;\r
- }\r
- \r
- public ResultsPager getPager () {\r
- if (pager == null) {\r
- pager = new ResultsPager(this); \r
- } \r
- return pager; \r
- }\r
- \r
- public ResultsPager setPager (int pageRange) {\r
- pager = new ResultsPager(this,pageRange);\r
- return pager;\r
- }\r
- \r
- protected ErrorHelper getTroubleshooter() {\r
- return errorHelper;\r
- }\r
- \r
- private void handleQueryStateChanges (String commands) {\r
- if (queryStates.hasPendingStateChange("search")) { \r
- logger.debug("Found pending search change. Doing search before updating " + commands);\r
- doSearch();\r
- } \r
- if (queryStates.hasPendingStateChange("record") && ! commands.equals("record")) { \r
- logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
- queryStates.hasPendingStateChange("record",false);\r
- if (getCommand("record").hasParameters()) {\r
- updateRecord(getCommand("record").getParameter("id").getSimpleValue());\r
- } else {\r
- removeCommand("record"); \r
- dataObjects.put("record", new RecordResponse());\r
- }\r
- } \r
- }\r
-\r
- private String getActiveClients() { \r
- if (getShow()!=null) {\r
- logger.debug("Active clients: "+getShow().getActiveClients());\r
- return getShow().getActiveClients();\r
- } else {\r
- return "";\r
- }\r
- }\r
-\r
- private Pazpar2Command getCommand(String name) {\r
- return queryStates.getCurrentState().getCommand(name);\r
- }\r
- \r
- private void setCommandParameter(String commandName, CommandParameter parameter) {\r
- logger.debug("Setting parameter for " + commandName + ": " + parameter);\r
- queryStates.getCurrentState().setCommandParameter(commandName, parameter, queryStates); \r
- }\r
- \r
- \r
- private void removeCommandParameter(String commandName, String parameterName) {\r
- queryStates.getCurrentState().removeCommandParameter(commandName,parameterName,queryStates); \r
- }\r
- \r
- private void removeCommand (String commandName) {\r
- queryStates.getCurrentState().removeCommand(commandName, queryStates);\r
- }\r
- \r
- private String getCommandParameterValue (String commandName, String parameterName, String defaultValue) { \r
- Pazpar2Command command = getCommand(commandName);\r
- if (command != null) {\r
- CommandParameter parameter = command.getParameter(parameterName);\r
- if (parameter != null) {\r
- return parameter.getValueWithExpressions();\r
- }\r
- }\r
- return defaultValue; \r
- }\r
- \r
- private String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) { \r
- Pazpar2Command command = getCommand(commandName);\r
- if (command != null) {\r
- CommandParameter parameter = command.getParameter(parameterName);\r
- if (parameter != null) {\r
- return parameter.getSimpleValue();\r
- }\r
- }\r
- return defaultValue; \r
- }\r
-\r
- \r
- private int getCommandParameterValue (String commandName, String parameterName, int defaultValue) {\r
- Pazpar2Command command = getCommand(commandName);\r
- if (command != null) {\r
- CommandParameter parameter = command.getParameter(parameterName);\r
- if (parameter != null) {\r
- return Integer.parseInt(parameter.getSimpleValue());\r
- }\r
- }\r
- return defaultValue; \r
- }\r
-\r
- private String doCommand(String commandName) { \r
- Pazpar2Command command = getCommand(commandName); \r
- logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString());\r
- return update(commandName); \r
- }\r
- \r
- private void resetDataObjects() {\r
- logger.debug("Resetting show,stat,termlist,bytarget,search response objects.");\r
- dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
- dataObjects.put("show", new ShowResponse());\r
- dataObjects.put("stat", new StatResponse());\r
- dataObjects.put("termlist", new TermListsResponse());\r
- dataObjects.put("bytarget", new ByTarget());\r
- dataObjects.put("record", new RecordResponse());\r
- dataObjects.put("search", new SearchResponse());\r
- }\r
- \r
-}\r