\r
import org.apache.log4j.Logger;\r
\r
-import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException;\r
-import com.indexdata.pz2utils4jsf.config.Pz2Configurator;\r
+import com.indexdata.pz2utils4jsf.config.ConfigurationReader;\r
import com.indexdata.pz2utils4jsf.controls.ResultsPager;\r
+import com.indexdata.pz2utils4jsf.errors.ConfigurationError;\r
+import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
+import com.indexdata.pz2utils4jsf.errors.ErrorHelper;\r
+import com.indexdata.pz2utils4jsf.errors.ErrorInterface;\r
import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget;\r
+import com.indexdata.pz2utils4jsf.pazpar2.data.CommandError;\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.pazpar2.state.StateManager;\r
+import com.indexdata.pz2utils4jsf.utils.Utils;\r
\r
-@Named\r
-@SessionScoped\r
+@Named @SessionScoped \r
public class Pz2Session implements Pz2Interface {\r
- \r
+ \r
+ private static final long serialVersionUID = 3947514708343320514L;\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
+ protected Map<String,Pazpar2ResponseData> dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
+ protected StateManager stateManager = new StateManager();\r
+ protected ErrorHelper errorHelper = null;\r
\r
- private static final long serialVersionUID = 3947514708343320514L; \r
- private com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration cfg = null;\r
- private com.indexdata.masterkey.pazpar2.client.Pazpar2Client client = null; \r
- private TargetFilter targetFilter = null; \r
- private ResultsPager pager = null; \r
- \r
+ protected List<ErrorInterface> configurationErrors = null;\r
+ protected SearchClient searchClient = null; \r
+ protected SingleTargetFilter singleTargetFilter = null; \r
+ protected ResultsPager pager = null; \r
+ \r
public Pz2Session () {\r
- logger.debug("Instantiating pz2 session object"); \r
+ logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]"); \r
}\r
\r
- public void init(Pz2Configurator pz2conf) {\r
- if (client==null) {\r
- logger.debug("Initiating a session holding object ");\r
+ public void configureClient(SearchClient searchClient, ConfigurationReader configReader) {\r
+ configurationErrors = new ArrayList<ErrorInterface>();\r
+ errorHelper = new ErrorHelper(configReader); \r
+ logger.debug(Utils.objectId(this) + " will configure search client for the session");\r
try {\r
- cfg = new com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration(pz2conf.getConfig());\r
- client = new com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric(cfg);\r
- resetDataObjects();\r
- } catch (ProxyErrorException e) {\r
- e.printStackTrace();\r
- } \r
- } else {\r
- logger.error("??? attempt to initiate session but already has a client");\r
- }\r
+ searchClient.configure(configReader); \r
+ // At the time of writing this search client is injected using Weld. \r
+ // However, the client is used for asynchronously sending off requests\r
+ // to the server AND propagation of context to threads is currently \r
+ // not supported. Trying to do so throws a WELD-001303 error. \r
+ // To avoid that, a context free client is cloned from the context \r
+ // dependent one. \r
+ // If propagation to threads gets supported, the cloning can go. \r
+ this.searchClient = searchClient.cloneMe(); \r
+ } catch (ConfigurationException e) {\r
+ configurationErrors.add(new ConfigurationError("Search Client","Configuration",e.getMessage(),new ErrorHelper(configReader))); \r
+ } \r
+ logger.info(configReader.document());\r
+ resetDataObjects();\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
+ stateManager.hasPendingStateChange("search",false);\r
resetDataObjects();\r
+ removeCommand("record");\r
setCommandParameter("show",new CommandParameter("start","=",0)); \r
- logger.info("Searching using "+getCommand("search").getParameter("query").getEncodedQueryString());\r
+ logger.debug(Utils.objectId(this) + " is searching using "+getCommand("search").getParameter("query").getEncodedQueryString());\r
doCommand("search"); \r
}\r
\r
* @return Number of activeclients at the time of the 'show' command.\r
*/\r
public String update () {\r
- logger.info("Updating show,stat,termlist, and bytarget data from pazpar2");\r
+ logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
return update("show,stat,termlist,bytarget");\r
}\r
- \r
+ \r
/**\r
* Refreshes the data objects listed in 'commands' from pazpar2\r
* \r
* @return Number of activeclients at the time of the 'show' command\r
*/\r
public String update (String commands) {\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
+ 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()),searchClient)); \r
}\r
- }\r
- for (CommandThread thread : threadList) {\r
- if (!thread.getCommand().getName().equals("search")) {\r
- dataObjects.put(thread.getCommand().getName(), new Pazpar2ResponseParser().getObject(thread.getResponse()));\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
+ String response = thread.getResponse();\r
+ logger.debug("Response was: " + response);\r
+ Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);\r
+ dataObjects.put(commandName, responseObject); \r
}\r
+ if (commands.equals("record")) {\r
+ logger.debug("Record: Active clients: "+getRecord().getActiveClients());\r
+ return getRecord().getActiveClients();\r
+ } else {\r
+ return getActiveClients();\r
+ } \r
+ } else {\r
+ logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
+ resetDataObjects();\r
+ return "0";\r
}\r
- return getActiveClients();\r
} else {\r
- logger.info("Skipped requests for " + commands + " as there's not yet a query."); \r
- resetDataObjects();\r
+ logger.error("Did not attempt to execute query since there are configuration errors.");\r
return "0";\r
}\r
\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
+ if (term != null && term.length()>0) { \r
+ Pazpar2Command command = getCommand("search");\r
+ command.getParameter("query").addExpression(new Expression(facetKey,"=",term));\r
+ stateManager.checkIn(command);\r
doSearch();\r
} \r
}\r
}\r
\r
public void removeFacet(String facetKey, String term) {\r
- queryStates.getCurrentState().removeCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
+ Pazpar2Command command = getCommand("search");\r
+ command.getParameter("query").removeExpression(new Expression(facetKey,"=",term));\r
+ stateManager.checkIn(command);\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
+ public void setSingleTargetFilter (String targetId, String targetName) { \r
+ if (hasSingleTargetFilter(new SingleTargetFilter(targetId,targetName))) {\r
+ logger.debug("Already using target filter " + this.singleTargetFilter.getFilterExpression());\r
} else { \r
- this.targetFilter = new TargetFilter(targetId,targetName);\r
- setCommandParameter("search",new CommandParameter("filter","=",this.targetFilter.getFilterExpression())); \r
+ this.singleTargetFilter = new SingleTargetFilter(targetId,targetName);\r
+ setCommandParameter("search",new CommandParameter("filter","=",this.singleTargetFilter.getFilterExpression())); \r
doSearch();\r
} \r
}\r
\r
- public TargetFilter getTargetFilter () {\r
- return targetFilter;\r
+ public SingleTargetFilter getSingleTargetFilter () {\r
+ return singleTargetFilter;\r
}\r
\r
- public void removeTargetFilter () {\r
- logger.debug("Removing target filter " + targetFilter.getFilterExpression());\r
- this.targetFilter = null;\r
+ public void removeSingleTargetFilter () {\r
+ logger.debug("Removing target filter " + singleTargetFilter.getFilterExpression());\r
+ this.singleTargetFilter = null;\r
removeCommandParameter("search","filter"); \r
doSearch();\r
}\r
\r
- public boolean hasTargetFilter() {\r
- return targetFilter != null; \r
+ public boolean hasSingleTargetFilter() {\r
+ return singleTargetFilter != null; \r
}\r
\r
public void setSort (String sortOption) {\r
public int getStart() {\r
return getCommandParameterValue("show","start",0);\r
}\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
+ setRecordId(recId);\r
+ return doCommand("record");\r
}\r
}\r
\r
- private String updateRecord(String recId) { \r
- setCommandParameter("record",new CommandParameter("id","=",recId)); \r
- return doCommand("record"); \r
+ @Override\r
+ public void setRecordId(String recId) {\r
+ setCommandParameter("record",new CommandParameter("id","=",recId));\r
}\r
\r
+ @Override\r
+ public String getRecordId () {\r
+ return getCommandParameterValue("record","recid","");\r
+ }\r
+ \r
+ @Override\r
public boolean hasRecord (String recId) {\r
return getCommand("record").hasParameters() && getRecord().getRecId().equals(recId);\r
}\r
\r
\r
public String getCurrentStateKey () { \r
- return queryStates.getCurrentStateKey();\r
+ return stateManager.getCurrentState().getKey();\r
}\r
\r
- public void setCurrentStateKey(String key) {\r
- logger.debug("************** request to set state key to: [" + key + "]"); \r
- queryStates.setCurrentStateKey(key);\r
+ public void setCurrentStateKey(String key) { \r
+ stateManager.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
+ protected boolean hasSingleTargetFilter(SingleTargetFilter targetFilter) {\r
+ return hasSingleTargetFilter() && targetFilter.equals(this.singleTargetFilter);\r
}\r
\r
- private boolean hasQuery() {\r
- return !(getCommand("search").getParameter("query") == null);\r
+ protected boolean hasQuery() {\r
+ return getCommand("search").getParameter("query") != null && getCommand("search").getParameter("query").getValueWithExpressions().length()>0;\r
}\r
\r
public boolean hasRecords () {\r
return pager;\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
+ protected ErrorHelper getTroubleshooter() {\r
+ return errorHelper;\r
+ }\r
+ \r
+ protected void handleQueryStateChanges (String commands) {\r
+ if (stateManager.hasPendingStateChange("search") && hasQuery()) { \r
+ logger.debug("Found pending search change. Doing search before updating " + commands); \r
doSearch();\r
} \r
- if (queryStates.hasPendingStateChange("record") && ! commands.equals("record")) { \r
+ if (stateManager.hasPendingStateChange("record") && ! commands.equals("record")) { \r
logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
- queryStates.hasPendingStateChange("record",false);\r
+ stateManager.hasPendingStateChange("record",false);\r
if (getCommand("record").hasParameters()) {\r
- updateRecord(getCommand("record").getParameter("id").getSimpleValue());\r
+ update("record");\r
} else {\r
removeCommand("record"); \r
dataObjects.put("record", new RecordResponse());\r
} \r
}\r
\r
- private String getActiveClients() {\r
- logger.debug("Active clients: "+getShow().getActiveClients());\r
+ protected 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
+ * Returns a Pazpar2 command 'detached' from the current Pazpar2 state.\r
+ * \r
+ * 'Detached' is meant to imply that this is a copy of a command in the \r
+ * current state, detached so as to NOT change the current state if \r
+ * modified. It can be viewed and executed, however. \r
+ * \r
+ * In order to modify the command with effect for subsequent searches,\r
+ * it must be checked back into the StateManager, which will\r
+ * then create a new current Pazpar2 state as needed.\r
+ * \r
+ * @param name\r
+ * @return\r
+ */\r
+ protected Pazpar2Command getCommand(String name) {\r
+ return stateManager.checkOut(name);\r
}\r
\r
- private void setCommandParameter(String commandName, CommandParameter parameter) {\r
+ protected void setCommandParameter(String commandName, CommandParameter parameter) {\r
logger.debug("Setting parameter for " + commandName + ": " + parameter);\r
- queryStates.getCurrentState().setCommandParameter(commandName, parameter, queryStates); \r
+ Pazpar2Command command = getCommand(commandName);\r
+ command.setParameter(parameter);\r
+ stateManager.checkIn(command); \r
}\r
\r
\r
- private void removeCommandParameter(String commandName, String parameterName) {\r
- queryStates.getCurrentState().removeCommandParameter(commandName,parameterName,queryStates); \r
+ protected void removeCommandParameter(String commandName, String parameterName) {\r
+ Pazpar2Command command = getCommand(commandName);\r
+ command.removeParameter(parameterName);\r
+ stateManager.checkIn(command); \r
}\r
\r
- private void removeCommand (String commandName) {\r
- queryStates.getCurrentState().removeCommand(commandName, queryStates);\r
+ protected void removeCommand (String commandName) {\r
+ Pazpar2Command command = getCommand(commandName);\r
+ command.removeParameters();\r
+ stateManager.checkIn(command);\r
}\r
\r
- private String getCommandParameterValue (String commandName, String parameterName, String defaultValue) { \r
+ protected String getCommandParameterValue (String commandName, String parameterName, String defaultValue) { \r
Pazpar2Command command = getCommand(commandName);\r
if (command != null) {\r
CommandParameter parameter = command.getParameter(parameterName);\r
return defaultValue; \r
}\r
\r
- private String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) { \r
+ protected String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) { \r
Pazpar2Command command = getCommand(commandName);\r
if (command != null) {\r
CommandParameter parameter = command.getParameter(parameterName);\r
}\r
\r
\r
- private int getCommandParameterValue (String commandName, String parameterName, int defaultValue) {\r
+ protected int getCommandParameterValue (String commandName, String parameterName, int defaultValue) {\r
Pazpar2Command command = getCommand(commandName);\r
if (command != null) {\r
CommandParameter parameter = command.getParameter(parameterName);\r
return defaultValue; \r
}\r
\r
- private String doCommand(String commandName) {\r
+ protected 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 response objects.");\r
+ protected 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
+ @Override\r
+ public void setFilter(String filterExpression) {\r
+ logger.debug("Setting filter to " + filterExpression);\r
+ setCommandParameter("search",new CommandParameter("filter","=",filterExpression)); \r
+ }\r
+ \r
+ public String getFilter() {\r
+ return getCommandParameterValueSimple("search", "filter", "");\r
+ }\r
+ \r
+ public boolean hasFilter () {\r
+ return getFilter().length()>0;\r
+ }\r
+ \r
}\r
projects / mkjsf-moved-to-github.git / blobdiff