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

   1 package com.indexdata.mkjsf.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.mkjsf.config.ConfigurationReader;\r
  17 import com.indexdata.mkjsf.controls.ResultsPager;\r
  18 import com.indexdata.mkjsf.errors.ConfigurationError;\r
  19 import com.indexdata.mkjsf.errors.ConfigurationException;\r
  20 import com.indexdata.mkjsf.errors.ErrorCentral;\r
  21 import com.indexdata.mkjsf.errors.ErrorHelper;\r
  22 import com.indexdata.mkjsf.pazpar2.commands.CommandParameter;\r
  23 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Commands;\r
  24 import com.indexdata.mkjsf.pazpar2.data.Pazpar2ResponseData;\r
  25 import com.indexdata.mkjsf.pazpar2.data.Pazpar2ResponseParser;\r
  26 import com.indexdata.mkjsf.pazpar2.data.Pazpar2Responses;\r
  27 import com.indexdata.mkjsf.pazpar2.data.RecordResponse;\r
  28 import com.indexdata.mkjsf.pazpar2.state.StateListener;\r
  29 import com.indexdata.mkjsf.pazpar2.state.StateManager;\r
  30 import com.indexdata.mkjsf.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.mkjsf.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   @Inject ErrorCentral errors;\r
  46   \r
  47   protected ResultsPager pager = null; \r
  48 \r
  49   \r
  50   protected ErrorHelper errorHelper = null;\r
  51               \r
  52   public Pz2Bean () {\r
  53     logger.info("Instantiating pz2 bean [" + Utils.objectId(this) + "]");    \r
  54   }\r
  55   \r
  56   @PostConstruct\r
  57   public void postConstruct() {    \r
  58     logger.debug("in start of Pz2Bean post-construct configurator is " + configurator);\r
  59     logger.debug(Utils.objectId(this) + " will instantiate a Pz2Client next.");\r
  60     searchClient = new Pz2Client();\r
  61     logger.info("Using [" + Utils.objectId(searchClient) + "] configured by [" \r
  62                           + Utils.objectId(configurator) + "]" );    \r
  63     configureClient(searchClient,configurator);    \r
  64     stateMgr.addStateListener(this);    \r
  65   }  \r
  66   \r
  67   public void configureClient(SearchClient searchClient, ConfigurationReader configReader) {\r
  68     logger.debug(Utils.objectId(this) + " will configure search client for the session");\r
  69     try {\r
  70       searchClient.configure(configReader);            \r
  71     } catch (ConfigurationException e) {\r
  72       logger.debug("Pz2Bean adding configuration error");\r
  73       errors.addConfigurationError(new ConfigurationError("Search Client","Configuration",e.getMessage()));                \r
  74     } \r
  75     logger.info(configReader.document());\r
  76     pzresp.reset();    \r
  77   }\r
  78 \r
  79     \r
  80   public void doSearch(String query) {\r
  81     pzreq.getSearch().setParameter(new CommandParameter("query","=",query));     \r
  82     doSearch();\r
  83   }\r
  84 \r
  85   public void doSearch() { \r
  86     stateMgr.hasPendingStateChange("search",false);\r
  87     pzresp.reset();\r
  88     // resets some record and show command parameters without \r
  89     // changing state or creating state change feedback\r
  90     pzreq.getRecord().removeParametersInState();        \r
  91     pzreq.getShow().setParameterInState(new CommandParameter("start","=",0));    \r
  92     logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommand("search").getUrlEncodedParameterValue("query"));\r
  93     doCommand("search");    \r
  94   }\r
  95       \r
  96   /**\r
  97    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
  98    * \r
  99    * @return Number of activeclients at the time of the 'show' command.\r
 100    */\r
 101   public String update () {\r
 102     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
 103     return update("show,stat,termlist,bytarget");\r
 104   }\r
 105    \r
 106   /**\r
 107    * Refreshes the data objects listed in 'commands' from pazpar2\r
 108    * \r
 109    * @param commands\r
 110    * @return Number of activeclients at the time of the 'show' command\r
 111    */\r
 112   public String update (String commands) {\r
 113     try {\r
 114     if (! errors.hasConfigurationErrors()) {\r
 115       if (commandsAreValid(commands)) {\r
 116         if (hasQuery() || (commands.equals("record") && pzreq.getCommand("record").hasParameterValue("recordquery"))) {\r
 117           handleQueryStateChanges(commands);\r
 118           logger.debug("Processing request for " + commands); \r
 119           List<CommandThread> threadList = new ArrayList<CommandThread>();\r
 120           StringTokenizer tokens = new StringTokenizer(commands,",");\r
 121           while (tokens.hasMoreElements()) {          \r
 122             threadList.add(new CommandThread(pzreq.getCommand(tokens.nextToken()),searchClient));            \r
 123           }\r
 124           for (CommandThread thread : threadList) {\r
 125             thread.start();\r
 126           }\r
 127           for (CommandThread thread : threadList) {\r
 128             try {\r
 129               thread.join();\r
 130             } catch (InterruptedException e) {\r
 131               e.printStackTrace();\r
 132             }\r
 133           }\r
 134           for (CommandThread thread : threadList) {\r
 135              String commandName = thread.getCommand().getName();\r
 136              String response = thread.getResponse();\r
 137              responseLogger.debug("Response was: " + response);\r
 138              Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);\r
 139              if (Pazpar2ResponseParser.docTypes.contains(responseObject.getType())) {\r
 140                pzresp.put(commandName, responseObject);\r
 141              } else {\r
 142                if (commandName.equals("record") && pzreq.getRecord().hasParameterValue("offset")) {\r
 143                  RecordResponse recordResponse = new RecordResponse();\r
 144                  recordResponse.setType("record");\r
 145                  recordResponse.setXml(responseObject.getXml());\r
 146                  recordResponse.setAttribute("activeclients", "0");\r
 147                  pzresp.put(commandName, recordResponse);\r
 148                }\r
 149              }\r
 150           }\r
 151           if (commands.equals("record")) {\r
 152             return pzresp.getRecord().getActiveClients();\r
 153           } else {\r
 154             return pzresp.getActiveClients();\r
 155           }  \r
 156         } else {\r
 157           logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
 158           pzresp.reset();\r
 159           return "0";\r
 160         }\r
 161       } else {\r
 162         logger.error("Did not attemt to run command(s) due to a validation error.");\r
 163         return "0";\r
 164       }\r
 165     } else {      \r
 166       logger.error("Did not attempt to execute query since there are configuration errors.");\r
 167       return "0";\r
 168     }\r
 169     } catch (ClassCastException cce) {\r
 170       cce.printStackTrace();    \r
 171       return "";\r
 172     } catch (NullPointerException npe) {\r
 173       npe.printStackTrace();\r
 174       return "";\r
 175     }\r
 176     \r
 177   }\r
 178   \r
 179   public boolean commandsAreValid(String commands) {\r
 180     if (commands.equals("record")) {\r
 181       if (!pzreq.getCommand("record").hasParameterValue("id")) {\r
 182         logger.error("Attempt to send record command without the id parameter");\r
 183         return false;\r
 184       }\r
 185     }\r
 186     return true;\r
 187   }\r
 188                                 \r
 189   public String toggleRecord (String recId) {\r
 190     if (hasRecord(recId)) {\r
 191       pzreq.getRecord().removeParameters();  \r
 192       pzresp.put("record", new RecordResponse());\r
 193       return "";\r
 194     } else {\r
 195       pzreq.getRecord().setId(recId);\r
 196       return doCommand("record");\r
 197     }\r
 198   }\r
 199   \r
 200   @Override\r
 201   public boolean hasRecord (String recId) {\r
 202     return pzreq.getCommand("record").hasParameters() && pzresp.getRecord().getRecId().equals(recId);\r
 203   }\r
 204         \r
 205   public String getCurrentStateKey () {    \r
 206     return stateMgr.getCurrentState().getKey();\r
 207   }\r
 208       \r
 209   public void setCurrentStateKey(String key) {       \r
 210     stateMgr.setCurrentStateKey(key);\r
 211   }\r
 212       \r
 213   protected boolean hasQuery() {        \r
 214     return pzreq.getCommand("search").hasParameterValue("query"); \r
 215   }\r
 216     \r
 217     \r
 218   @Override\r
 219   public ResultsPager getPager () {\r
 220     if (pager == null) {\r
 221       pager = new ResultsPager(pzresp);      \r
 222     } \r
 223     return pager;      \r
 224   }\r
 225   \r
 226   @Override\r
 227   public ResultsPager setPager (int pageRange) {\r
 228     pager =  new ResultsPager(pzresp,pageRange,pzreq);\r
 229     return pager;\r
 230   }\r
 231     \r
 232   protected void handleQueryStateChanges (String commands) {\r
 233     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
 234       logger.debug("Found pending search change. Doing search before updating " + commands);      \r
 235       doSearch();\r
 236     } \r
 237     if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 238       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 239       stateMgr.hasPendingStateChange("record",false);\r
 240       if (pzreq.getCommand("record").hasParameterValue("id")) {\r
 241         update("record");\r
 242       } else {         \r
 243         pzresp.put("record", new RecordResponse());\r
 244       }\r
 245     }\r
 246   }\r
 247   \r
 248   protected String doCommand(String commandName) {             \r
 249     logger.debug(pzreq.getCommand(commandName).getEncodedQueryString() + ": Results for "+ pzreq.getCommand("search").getEncodedQueryString());\r
 250     return update(commandName);\r
 251   }\r
 252   \r
 253   @Override\r
 254   public void stateUpdated(String commandName) {\r
 255     logger.debug("State change reported for [" + commandName + "]");\r
 256     if (commandName.equals("show")) {\r
 257       logger.debug("Updating show");\r
 258       update(commandName);\r
 259     } \r
 260   }\r
 261   \r
 262   @Override\r
 263   public boolean getAuthenticationRequired () {\r
 264     return searchClient.isAuthenticatingClient();\r
 265   }\r
 266 \r
 267   @Override\r
 268   public String getCheckHistory () {\r
 269     return ":pz2watch:stateForm:windowlocationhash";\r
 270   }\r
 271     \r
 272   @Override\r
 273   public String getWatchActiveclients () {\r
 274     return ":pz2watch:activeclientsForm:activeclientsField";\r
 275   }\r
 276   \r
 277   @Override\r
 278   public String getWatchActiveclientsRecord () {\r
 279     return ":pz2watch:activeclientsForm:activeclientsFieldRecord";\r
 280   }\r
 281   \r
 282 }\r