X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fpz2utils4jsf%2Fpazpar2%2FPz2Session.java;h=654f3c84064670cbd837afe26a480d8cdf852d68;hb=ef76a342d67b814bea4ca54de78000d540e879a8;hp=b4323fcf5db6bcd5c40abc5568b09ee367a1e68e;hpb=17d3168e6fec9a87936aee992ac1a5deaad49cfe;p=mkjsf-moved-to-github.git diff --git a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Session.java b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Session.java index b4323fc..654f3c8 100644 --- a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Session.java +++ b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Session.java @@ -6,68 +6,96 @@ import java.util.Map; import java.util.StringTokenizer; import java.util.concurrent.ConcurrentHashMap; -import javax.enterprise.context.SessionScoped; -import javax.inject.Named; +import javax.annotation.PostConstruct; +import javax.inject.Inject; import org.apache.log4j.Logger; -import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException; -import com.indexdata.pz2utils4jsf.config.Pz2Configurator; +import com.indexdata.pz2utils4jsf.config.ConfigurationReader; import com.indexdata.pz2utils4jsf.controls.ResultsPager; +import com.indexdata.pz2utils4jsf.errors.ConfigurationError; +import com.indexdata.pz2utils4jsf.errors.ConfigurationException; +import com.indexdata.pz2utils4jsf.errors.ErrorHelper; +import com.indexdata.pz2utils4jsf.errors.ErrorInterface; +import com.indexdata.pz2utils4jsf.pazpar2.commands.CommandParameter; +import com.indexdata.pz2utils4jsf.pazpar2.commands.CommandReadOnly; +import com.indexdata.pz2utils4jsf.pazpar2.commands.Pazpar2Command; +import com.indexdata.pz2utils4jsf.pazpar2.commands.Pazpar2Commands; import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget; +import com.indexdata.pz2utils4jsf.pazpar2.data.CommandError; import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseData; import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseParser; import com.indexdata.pz2utils4jsf.pazpar2.data.RecordResponse; +import com.indexdata.pz2utils4jsf.pazpar2.data.SearchResponse; import com.indexdata.pz2utils4jsf.pazpar2.data.ShowResponse; import com.indexdata.pz2utils4jsf.pazpar2.data.StatResponse; import com.indexdata.pz2utils4jsf.pazpar2.data.TermListsResponse; import com.indexdata.pz2utils4jsf.pazpar2.data.TermResponse; -import com.indexdata.pz2utils4jsf.pazpar2.state.QueryStates; +import com.indexdata.pz2utils4jsf.pazpar2.state.StateListener; +import com.indexdata.pz2utils4jsf.pazpar2.state.StateManager; +import com.indexdata.pz2utils4jsf.utils.Utils; -@Named -@SessionScoped -public class Pz2Session implements Pz2Interface { - +@ForStraightPz2 +public class Pz2Session implements Pz2Interface, StateListener { + + private static final long serialVersionUID = 3947514708343320514L; private static Logger logger = Logger.getLogger(Pz2Session.class); - private Map dataObjects = new ConcurrentHashMap(); - private QueryStates queryStates = new QueryStates(); + protected Map dataObjects = new ConcurrentHashMap(); - private static final long serialVersionUID = 3947514708343320514L; - private com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration cfg = null; - private com.indexdata.masterkey.pazpar2.client.Pazpar2Client client = null; - private TargetFilter targetFilter = null; - private ResultsPager pager = null; - + @Inject StateManager stateMgr; + @Inject Pazpar2Commands req; + + protected ErrorHelper errorHelper = null; + + protected List configurationErrors = null; + protected SearchClient searchClient = null; + protected SingleTargetFilter singleTargetFilter = null; + protected ResultsPager pager = null; + public Pz2Session () { - logger.debug("Instantiating pz2 session object"); + logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]"); + } + + @PostConstruct + public void listenToStateManager() { + logger.debug("in post-construct of Pz2Session stateMgr is " + stateMgr); + logger.debug("in post-construct req is " + req); + stateMgr.addStateListener(this); } - public void init(Pz2Configurator pz2conf) { - if (client==null) { - logger.debug("Initiating a session holding object "); + public void configureClient(SearchClient searchClient, ConfigurationReader configReader) { + configurationErrors = new ArrayList(); + errorHelper = new ErrorHelper(configReader); + logger.debug(Utils.objectId(this) + " will configure search client for the session"); try { - cfg = new com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration(pz2conf.getConfig()); - client = new com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric(cfg); - resetDataObjects(); - } catch (ProxyErrorException e) { - e.printStackTrace(); - } - } else { - logger.error("??? attempt to initiate session but already has a client"); - } + searchClient.configure(configReader); + // At the time of writing this search client is injected using Weld. + // However, the client is used for asynchronously sending off requests + // to the server AND propagation of context to threads is currently + // not supported. Trying to do so throws a WELD-001303 error. + // To avoid that, a context free client is cloned from the context + // dependent one. + // If propagation to threads gets supported, the cloning can go. + this.searchClient = searchClient.cloneMe(); + } catch (ConfigurationException e) { + configurationErrors.add(new ConfigurationError("Search Client","Configuration",e.getMessage(),new ErrorHelper(configReader))); + } + logger.info(configReader.document()); + resetDataObjects(); } - + public void doSearch(String query) { setCommandParameter("search",new CommandParameter("query","=",query)); doSearch(); } public void doSearch() { - queryStates.hasPendingStateChange("search",false); + stateMgr.hasPendingStateChange("search",false); resetDataObjects(); + removeCommand("record"); setCommandParameter("show",new CommandParameter("start","=",0)); - logger.info("Searching using "+getCommand("search").getParameter("query").getEncodedQueryString()); + logger.debug(Utils.objectId(this) + " is searching using "+req.getCommandReadOnly("search").getUrlEncodedParameterValue("query")); doCommand("search"); } @@ -77,10 +105,10 @@ public class Pz2Session implements Pz2Interface { * @return Number of activeclients at the time of the 'show' command. */ public String update () { - logger.info("Updating show,stat,termlist, and bytarget data from pazpar2"); + logger.debug("Updating show,stat,termlist,bytarget from pazpar2"); return update("show,stat,termlist,bytarget"); } - + /** * Refreshes the data objects listed in 'commands' from pazpar2 * @@ -88,144 +116,89 @@ public class Pz2Session implements Pz2Interface { * @return Number of activeclients at the time of the 'show' command */ public String update (String commands) { - if (hasQuery()) { - handleQueryStateChanges(commands); - logger.debug("Processing request for " + commands); - List threadList = new ArrayList(); - StringTokenizer tokens = new StringTokenizer(commands,","); - while (tokens.hasMoreElements()) { - threadList.add(new CommandThread(getCommand(tokens.nextToken()),client)); - } - for (CommandThread thread : threadList) { - thread.start(); - } - for (CommandThread thread : threadList) { - try { - thread.join(); - } catch (InterruptedException e) { - e.printStackTrace(); + if (! hasConfigurationErrors()) { + if (hasQuery()) { + handleQueryStateChanges(commands); + logger.debug("Processing request for " + commands); + List threadList = new ArrayList(); + StringTokenizer tokens = new StringTokenizer(commands,","); + while (tokens.hasMoreElements()) { + threadList.add(new CommandThread(req.getCommandReadOnly(tokens.nextToken()),searchClient)); } - } - for (CommandThread thread : threadList) { - if (!thread.getCommand().getName().equals("search")) { - dataObjects.put(thread.getCommand().getName(), new Pazpar2ResponseParser().getObject(thread.getResponse())); + for (CommandThread thread : threadList) { + thread.start(); + } + for (CommandThread thread : threadList) { + try { + thread.join(); + } catch (InterruptedException e) { + e.printStackTrace(); + } + } + for (CommandThread thread : threadList) { + String commandName = thread.getCommand().getName(); + String response = thread.getResponse(); + logger.debug("Response was: " + response); + Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response); + dataObjects.put(commandName, responseObject); } + if (commands.equals("record")) { + logger.debug("Record: Active clients: "+getRecord().getActiveClients()); + return getRecord().getActiveClients(); + } else { + return getActiveClients(); + } + } else { + logger.debug("Skipped requests for " + commands + " as there's not yet a query."); + resetDataObjects(); + return "0"; } - return getActiveClients(); } else { - logger.info("Skipped requests for " + commands + " as there's not yet a query."); - resetDataObjects(); + logger.error("Did not attempt to execute query since there are configuration errors."); return "0"; } } - - public void setQuery (String query) { - logger.debug("Creating new command parameter for " + query); - setCommandParameter("search",new CommandParameter("query","=",query)); - } - - public String getQuery () { - return getCommandParameterValueSimple("search","query",null); - } - - public void setFacet (String facetKey, String term) { - if (term != null && term.length()>0) { - queryStates.getCurrentState().setCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates); - doSearch(); - } - } - - public void setFacetOnQuery (String facetKey, String term) { - String facetExpression = facetKey + "=" + term; - if (term != null && term.length()>0) { - setCommandParameter("search",new CommandParameter("query","=", getQuery() + " and " + facetExpression)); - doSearch(); - } - } - - public void removeFacet(String facetKey, String term) { - queryStates.getCurrentState().removeCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates); - doSearch(); - } - - public void setTargetFilter (String targetId, String targetName) { - if (hasTargetFilter(new TargetFilter(targetId,targetName))) { - logger.debug("Already using target filter " + this.targetFilter.getFilterExpression()); + + public void setSingleTargetFilter (String targetId, String targetName) { + if (hasSingleTargetFilter(new SingleTargetFilter(targetId,targetName))) { + logger.debug("Already using target filter " + this.singleTargetFilter.getFilterExpression()); } else { - this.targetFilter = new TargetFilter(targetId,targetName); - setCommandParameter("search",new CommandParameter("filter","=",this.targetFilter.getFilterExpression())); + this.singleTargetFilter = new SingleTargetFilter(targetId,targetName); + setCommandParameter("search",new CommandParameter("filter","=",this.singleTargetFilter.getFilterExpression())); doSearch(); } } - public TargetFilter getTargetFilter () { - return targetFilter; + public SingleTargetFilter getSingleTargetFilter () { + return singleTargetFilter; } - public void removeTargetFilter () { - logger.debug("Removing target filter " + targetFilter.getFilterExpression()); - this.targetFilter = null; + public void removeSingleTargetFilter () { + logger.debug("Removing target filter " + singleTargetFilter.getFilterExpression()); + this.singleTargetFilter = null; removeCommandParameter("search","filter"); doSearch(); } - public boolean hasTargetFilter() { - return targetFilter != null; + public boolean hasSingleTargetFilter() { + return singleTargetFilter != null; } - - public void setSort (String sortOption) { - logger.debug("Setting sort option: " + sortOption); - setCommandParameter("show",new CommandParameter("sort","=",sortOption)); - update("show"); - } - - public String getSort () { - return getCommandParameterValue("show","sort","relevance"); - } - - public void setPageSize (int perPageOption) { - if (getPageSize()!=perPageOption) { - logger.debug("Setting perpage option to " + perPageOption + " and resetting start page."); - setCommandParameter("show",new CommandParameter("num","=",perPageOption)); - setCommandParameter("show",new CommandParameter("start","=",0)); - update("show"); - } else { - logger.debug("Not updating page size, already is " + perPageOption); - } - } - - public int getPageSize () { - return getCommandParameterValue("show","num",20); - } - - public void setStart (int start) { - logger.debug("Setting start num to " + start); - setCommandParameter("show", new CommandParameter("start","=",start)); - update("show"); - } - - public int getStart() { - return getCommandParameterValue("show","start",0); - } - + public String toggleRecord (String recId) { if (hasRecord(recId)) { removeCommand("record"); dataObjects.put("record", new RecordResponse()); return ""; } else { - return updateRecord(recId); + req.getRecord().setRecordId(recId); + return doCommand("record"); } } - private String updateRecord(String recId) { - setCommandParameter("record",new CommandParameter("id","=",recId)); - return doCommand("record"); - } - + @Override public boolean hasRecord (String recId) { - return getCommand("record").hasParameters() && getRecord().getRecId().equals(recId); + return req.getCommandReadOnly("record").hasParameters() && getRecord().getRecId().equals(recId); } public ShowResponse getShow () { @@ -258,20 +231,70 @@ public class Pz2Session implements Pz2Interface { public String getCurrentStateKey () { - return queryStates.getCurrentStateKey(); + return stateMgr.getCurrentState().getKey(); } - public void setCurrentStateKey(String key) { - logger.debug("************** request to set state key to: [" + key + "]"); - queryStates.setCurrentStateKey(key); + public void setCurrentStateKey(String key) { + stateMgr.setCurrentStateKey(key); + } + + public boolean hasConfigurationErrors () { + return (configurationErrors.size()>0); + } + + public boolean hasCommandErrors () { + if (dataObjects.get("search").hasApplicationError()) { + logger.info("Error detected in search"); + return true; + } + for (String name : dataObjects.keySet()) { + if (dataObjects.get(name).hasApplicationError()) { + logger.info("Error detected in " + name); + return true; + } + } + return false; } + + /** + * Returns true if application error found in any response data objects + */ + public boolean hasErrors () { + return hasConfigurationErrors() || hasCommandErrors(); + } + + public List getConfigurationErrors() { + return configurationErrors; + } + + /** + * Returns a search command error, if any, otherwise the first + * error found for an arbitrary command, if any, otherwise + * an empty dummy error. + */ + public ErrorInterface getCommandError() { + CommandError error = new CommandError(); + if (dataObjects.get("search").hasApplicationError()) { + error = dataObjects.get("search").getApplicationError(); + } else { + for (String name : dataObjects.keySet()) { + if (dataObjects.get(name).hasApplicationError()) { + error = dataObjects.get(name).getApplicationError(); + break; + } + } + } + error.setErrorHelper(errorHelper); + return error; + } + - private boolean hasTargetFilter(TargetFilter targetFilter) { - return hasTargetFilter() && targetFilter.equals(this.targetFilter); + protected boolean hasSingleTargetFilter(SingleTargetFilter targetFilter) { + return hasSingleTargetFilter() && targetFilter.equals(this.singleTargetFilter); } - private boolean hasQuery() { - return !(getCommand("search").getParameter("query") == null); + protected boolean hasQuery() { + return req.getSearch().getParameter("query") != null && req.getSearch().getParameter("query").getValueWithExpressions().length()>0; } public boolean hasRecords () { @@ -288,102 +311,153 @@ public class Pz2Session implements Pz2Interface { } public ResultsPager setPager (int pageRange) { - pager = new ResultsPager(this,pageRange); + pager = new ResultsPager(this,pageRange,req); return pager; } - private void handleQueryStateChanges (String commands) { - if (queryStates.hasPendingStateChange("search")) { - logger.debug("Found pending search change. Doing search before updating " + commands); + protected ErrorHelper getTroubleshooter() { + return errorHelper; + } + + protected void handleQueryStateChanges (String commands) { + if (stateMgr.hasPendingStateChange("search") && hasQuery()) { + logger.debug("Found pending search change. Doing search before updating " + commands); doSearch(); } - if (queryStates.hasPendingStateChange("record") && ! commands.equals("record")) { + if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) { logger.debug("Found pending record ID change. Doing record before updating " + commands); - queryStates.hasPendingStateChange("record",false); - if (getCommand("record").hasParameters()) { - updateRecord(getCommand("record").getParameter("id").getSimpleValue()); + stateMgr.hasPendingStateChange("record",false); + if (req.getCommandReadOnly("record").hasParameters()) { + update("record"); } else { removeCommand("record"); dataObjects.put("record", new RecordResponse()); } - } + } } - private String getActiveClients() { - logger.debug("Active clients: "+getShow().getActiveClients()); + protected String getActiveClients() { if (getShow()!=null) { + logger.debug("Active clients: "+getShow().getActiveClients()); return getShow().getActiveClients(); } else { return ""; } } - private Pazpar2Command getCommand(String name) { - return queryStates.getCurrentState().getCommand(name); + /** + * Returns a Pazpar2 command 'detached' from the current Pazpar2 state. + * + * 'Detached' is meant to imply that this is a copy of a command in the + * current state, detached so as to NOT change the current state if + * modified. It can be viewed and executed, however. + * + * In order to modify the command with effect for subsequent searches, + * it must be checked back into the StateManager, which will + * then create a new current Pazpar2 state as needed. + * + * @param name + * @return + */ + protected Pazpar2Command getCommand(String name) { + return req.getCommand(name); } - private void setCommandParameter(String commandName, CommandParameter parameter) { + /** + * Returns an interface to a Pazpar2Command with only String getters. + * + * Since the command cannot be modified (unless it is cast) we can avoid + * cloning it before returning it from the current state. + * It can be used for log statements, checks and for performing the + * actual pazpar2 request. + * + * @param name + * @return + */ + protected CommandReadOnly getCommandReadOnly(String name) { + return req.getCommandReadOnly(name); + } + + + protected void setCommandParameter(String commandName, CommandParameter parameter) { logger.debug("Setting parameter for " + commandName + ": " + parameter); - queryStates.getCurrentState().setCommandParameter(commandName, parameter, queryStates); + Pazpar2Command command = req.getCommand(commandName); + command.setParameter(parameter); + stateMgr.checkIn(command); } - private void removeCommandParameter(String commandName, String parameterName) { - queryStates.getCurrentState().removeCommandParameter(commandName,parameterName,queryStates); + protected void removeCommandParameter(String commandName, String parameterName) { + Pazpar2Command command = req.getCommand(commandName); + command.removeParameter(parameterName); + stateMgr.checkIn(command); } - private void removeCommand (String commandName) { - queryStates.getCurrentState().removeCommand(commandName, queryStates); + protected void removeCommand (String commandName) { + Pazpar2Command command = req.getCommand(commandName); + command.removeParameters(); + stateMgr.checkIn(command); } - private String getCommandParameterValue (String commandName, String parameterName, String defaultValue) { - Pazpar2Command command = getCommand(commandName); - if (command != null) { - CommandParameter parameter = command.getParameter(parameterName); - if (parameter != null) { - return parameter.getValueWithExpressions(); - } - } - return defaultValue; - } - - private String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) { - Pazpar2Command command = getCommand(commandName); + protected String getCommandParameterValue (String commandName, String parameterName, String defaultValue) { + CommandReadOnly command = req.getCommandReadOnly(commandName); if (command != null) { - CommandParameter parameter = command.getParameter(parameterName); + String parameter = command.getParameterValue(parameterName); if (parameter != null) { - return parameter.getSimpleValue(); + return parameter; } } return defaultValue; } - - - private int getCommandParameterValue (String commandName, String parameterName, int defaultValue) { - Pazpar2Command command = getCommand(commandName); + + protected int getCommandParameterValue (String commandName, String parameterName, int defaultValue) { + CommandReadOnly command = req.getCommandReadOnly(commandName); if (command != null) { - CommandParameter parameter = command.getParameter(parameterName); + String parameter = command.getParameterValue(parameterName); if (parameter != null) { - return Integer.parseInt(parameter.getSimpleValue()); + return Integer.parseInt(parameter); } } return defaultValue; } - private String doCommand(String commandName) { - Pazpar2Command command = getCommand(commandName); - logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString()); + protected String doCommand(String commandName) { + logger.debug(req.getCommandReadOnly(commandName).getEncodedQueryString() + ": Results for "+ req.getCommandReadOnly("search").getEncodedQueryString()); return update(commandName); } - private void resetDataObjects() { - logger.debug("Resetting show,stat,termlist,bytarget response objects."); + protected void resetDataObjects() { + logger.debug("Resetting show,stat,termlist,bytarget,search response objects."); dataObjects = new ConcurrentHashMap(); dataObjects.put("show", new ShowResponse()); dataObjects.put("stat", new StatResponse()); dataObjects.put("termlist", new TermListsResponse()); dataObjects.put("bytarget", new ByTarget()); dataObjects.put("record", new RecordResponse()); + dataObjects.put("search", new SearchResponse()); + } + + @Override + public void setFilter(String filterExpression) { + logger.debug("Setting filter to " + filterExpression); + setCommandParameter("search",new CommandParameter("filter","=",filterExpression)); + } + + public String getFilter() { + return getCommandParameterValue("search", "filter", ""); + } + + public boolean hasFilter () { + return getFilter().length()>0; } + @Override + public void stateUpdated(String commandName) { + logger.debug("State change reported for [" + commandName + "]"); + if (commandName.equals("show")) { + logger.debug("Updating show"); + update(commandName); + } + } + }