src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Bean.java

   1 package com.indexdata.pz2utils4jsf.pazpar2;\r
   2 \r
   3 import java.io.Serializable;\r
   4 import java.util.ArrayList;\r
   5 import java.util.List;\r
   6 import java.util.StringTokenizer;\r
   7 \r
   8 import javax.annotation.PostConstruct;\r
   9 import javax.enterprise.context.SessionScoped;\r
  10 import javax.enterprise.inject.Alternative;\r
  11 import javax.inject.Inject;\r
  12 import javax.inject.Named;\r
  13 \r
  14 import org.apache.log4j.Logger;\r
  15 \r
  16 import com.indexdata.pz2utils4jsf.config.ConfigurationReader;\r
  17 import com.indexdata.pz2utils4jsf.controls.ResultsPager;\r
  18 import com.indexdata.pz2utils4jsf.errors.ConfigurationError;\r
  19 import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
  20 import com.indexdata.pz2utils4jsf.errors.ErrorHelper;\r
  21 import com.indexdata.pz2utils4jsf.errors.ErrorInterface;\r
  22 import com.indexdata.pz2utils4jsf.pazpar2.commands.CommandParameter;\r
  23 import com.indexdata.pz2utils4jsf.pazpar2.commands.Pazpar2Commands;\r
  24 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseData;\r
  25 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseParser;\r
  26 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2Responses;\r
  27 import com.indexdata.pz2utils4jsf.pazpar2.data.RecordResponse;\r
  28 import com.indexdata.pz2utils4jsf.pazpar2.state.StateListener;\r
  29 import com.indexdata.pz2utils4jsf.pazpar2.state.StateManager;\r
  30 import com.indexdata.pz2utils4jsf.utils.Utils;\r
  31 \r
  32 @Named("pz2") @SessionScoped @Alternative\r
  33 public class Pz2Bean implements Pz2Interface, StateListener, Serializable {\r
  34 \r
  35   private static final long serialVersionUID = 3440277287081557861L;\r
  36   private static Logger logger = Logger.getLogger(Pz2Bean.class);\r
  37   private static Logger responseLogger = Logger.getLogger("com.indexdata.pz2utils4jsf.pazpar2.responses");\r
  38   \r
  39   protected SearchClient searchClient = null;\r
  40   \r
  41   @Inject ConfigurationReader configurator;\r
  42   @Inject StateManager stateMgr;\r
  43   @Inject Pazpar2Commands pzreq;\r
  44   @Inject Pazpar2Responses pzresp;\r
  45   \r
  46   protected ResultsPager pager = null; \r
  47 \r
  48   protected List<ErrorInterface> configurationErrors = null;\r
  49   protected ErrorHelper errorHelper = null;\r
  50               \r
  51   public Pz2Bean () {\r
  52     logger.info("Instantiating pz2 bean [" + Utils.objectId(this) + "]");    \r
  53   }\r
  54   \r
  55   @PostConstruct\r
  56   public void postConstruct() {    \r
  57     logger.debug("in start of Pz2Bean post-construct configurator is " + configurator);\r
  58     logger.debug(Utils.objectId(this) + " will instantiate a Pz2Client next.");\r
  59     searchClient = new Pz2Client();\r
  60     logger.info("Using [" + Utils.objectId(searchClient) + "] configured by [" \r
  61                           + Utils.objectId(configurator) + "]" );    \r
  62     configureClient(searchClient,configurator);    \r
  63     stateMgr.addStateListener(this);    \r
  64   }  \r
  65   \r
  66   public void configureClient(SearchClient searchClient, ConfigurationReader configReader) {\r
  67     errorHelper = new ErrorHelper(configurator);\r
  68     logger.info("pz2 " + Utils.objectId(this) + " sets error helper " + Utils.objectId(errorHelper) + " on pzresp " + Utils.objectId(pzresp));\r
  69     pzresp.setErrorHelper(errorHelper);\r
  70     configurationErrors = new ArrayList<ErrorInterface>();        \r
  71     logger.debug(Utils.objectId(this) + " will configure search client for the session");\r
  72     try {\r
  73       searchClient.configure(configReader);            \r
  74     } catch (ConfigurationException e) {\r
  75       configurationErrors.add(new ConfigurationError("Search Client","Configuration",e.getMessage(),new ErrorHelper(configReader)));          \r
  76     } \r
  77     logger.info(configReader.document());\r
  78     pzresp.reset();    \r
  79   }\r
  80 \r
  81     \r
  82   public void doSearch(String query) {\r
  83     pzreq.getSearch().setParameter(new CommandParameter("query","=",query));     \r
  84     doSearch();\r
  85   }\r
  86 \r
  87   public void doSearch() { \r
  88     stateMgr.hasPendingStateChange("search",false);\r
  89     pzresp.reset();\r
  90     // resets some record and show command parameters without \r
  91     // changing state or creating state change feedback\r
  92     pzreq.getRecord().removeParametersInState();        \r
  93     pzreq.getShow().setParameterInState(new CommandParameter("start","=",0));    \r
  94     logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommand("search").getUrlEncodedParameterValue("query"));\r
  95     doCommand("search");    \r
  96   }\r
  97       \r
  98   /**\r
  99    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
 100    * \r
 101    * @return Number of activeclients at the time of the 'show' command.\r
 102    */\r
 103   public String update () {\r
 104     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
 105     return update("show,stat,termlist,bytarget");\r
 106   }\r
 107    \r
 108   /**\r
 109    * Refreshes the data objects listed in 'commands' from pazpar2\r
 110    * \r
 111    * @param commands\r
 112    * @return Number of activeclients at the time of the 'show' command\r
 113    */\r
 114   public String update (String commands) {\r
 115     if (! hasConfigurationErrors()) {\r
 116       if (commandsAreValid(commands)) {\r
 117         if (hasQuery()) {\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(pzreq.getCommand(tokens.nextToken()),searchClient));            \r
 124           }\r
 125           for (CommandThread thread : threadList) {\r
 126             thread.start();\r
 127           }\r
 128           for (CommandThread thread : threadList) {\r
 129             try {\r
 130               thread.join();\r
 131             } catch (InterruptedException e) {\r
 132               e.printStackTrace();\r
 133             }\r
 134           }\r
 135           for (CommandThread thread : threadList) {\r
 136              String commandName = thread.getCommand().getName();\r
 137              String response = thread.getResponse();\r
 138              responseLogger.debug("Response was: " + response);\r
 139              Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);\r
 140              pzresp.put(commandName, responseObject);        \r
 141           }\r
 142           if (commands.equals("record")) {\r
 143             logger.debug("Record: Active clients: "+pzresp.getRecord().getActiveClients());\r
 144             return pzresp.getRecord().getActiveClients();\r
 145           } else {\r
 146             return pzresp.getActiveClients();\r
 147           }  \r
 148         } else {\r
 149           logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
 150           pzresp.reset();\r
 151           return "0";\r
 152         }\r
 153       } else {\r
 154         logger.error("Did not attemt to run command(s) due to a validation error.");\r
 155         return "0";\r
 156       }\r
 157     } else {      \r
 158       logger.error("Did not attempt to execute query since there are configuration errors.");\r
 159       return "0";\r
 160     }\r
 161     \r
 162   }\r
 163   \r
 164   public boolean commandsAreValid(String commands) {\r
 165     if (commands.equals("record")) {\r
 166       if (!pzreq.getCommand("record").hasParameterSet("id")) {\r
 167         logger.error("Attempt to send record command without the id parameter");\r
 168         return false;\r
 169       }\r
 170     }\r
 171     return true;\r
 172   }\r
 173                                 \r
 174   public String toggleRecord (String recId) {\r
 175     if (hasRecord(recId)) {\r
 176       pzreq.getRecord().removeParameters();  \r
 177       pzresp.put("record", new RecordResponse());\r
 178       return "";\r
 179     } else {\r
 180       pzreq.getRecord().setId(recId);\r
 181       return doCommand("record");\r
 182     }\r
 183   }\r
 184   \r
 185   @Override\r
 186   public boolean hasRecord (String recId) {\r
 187     return pzreq.getCommand("record").hasParameters() && pzresp.getRecord().getRecId().equals(recId);\r
 188   }\r
 189         \r
 190   public String getCurrentStateKey () {    \r
 191     return stateMgr.getCurrentState().getKey();\r
 192   }\r
 193       \r
 194   public void setCurrentStateKey(String key) {       \r
 195     stateMgr.setCurrentStateKey(key);\r
 196   }\r
 197   \r
 198   public boolean hasConfigurationErrors () {\r
 199       return (configurationErrors.size()>0);      \r
 200   }\r
 201   \r
 202   public boolean hasCommandErrors () {\r
 203     return pzresp.hasApplicationError();\r
 204   }\r
 205   \r
 206   /**\r
 207    * Returns true if application error found in any response data objects \r
 208    */\r
 209   public boolean hasErrors () {\r
 210     logger.debug("Checking for configuration errors or command errors.");\r
 211     return hasConfigurationErrors() || hasCommandErrors();\r
 212   }\r
 213 \r
 214   public List<ErrorInterface> getConfigurationErrors() {    \r
 215     return configurationErrors;\r
 216   }\r
 217   \r
 218   \r
 219   protected boolean hasQuery() {        \r
 220     return pzreq.getCommand("search").hasParameterSet("query"); \r
 221   }\r
 222     \r
 223     \r
 224   public ResultsPager getPager () {\r
 225     if (pager == null) {\r
 226       pager = new ResultsPager(pzresp);      \r
 227     } \r
 228     return pager;      \r
 229   }\r
 230   \r
 231   public ResultsPager setPager (int pageRange) {\r
 232     pager =  new ResultsPager(pzresp,pageRange,pzreq);\r
 233     return pager;\r
 234   }\r
 235     \r
 236   protected void handleQueryStateChanges (String commands) {\r
 237     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
 238       logger.debug("Found pending search change. Doing search before updating " + commands);      \r
 239       doSearch();\r
 240     } \r
 241     if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 242       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 243       stateMgr.hasPendingStateChange("record",false);\r
 244       if (pzreq.getCommand("record").hasParameterSet("id")) {\r
 245         update("record");\r
 246       } else {         \r
 247         pzresp.put("record", new RecordResponse());\r
 248       }\r
 249     }\r
 250   }\r
 251   \r
 252   protected String doCommand(String commandName) {             \r
 253     logger.debug(pzreq.getCommand(commandName).getEncodedQueryString() + ": Results for "+ pzreq.getCommand("search").getEncodedQueryString());\r
 254     return update(commandName);\r
 255   }\r
 256   \r
 257   @Override\r
 258   public void stateUpdated(String commandName) {\r
 259     logger.debug("State change reported for [" + commandName + "]");\r
 260     if (commandName.equals("show")) {\r
 261       logger.debug("Updating show");\r
 262       update(commandName);\r
 263     } \r
 264   }\r
 265 \r
 266 \r
 267 }\r