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   \r
  38   protected SearchClient searchClient = null;\r
  39   \r
  40   @Inject ConfigurationReader configurator;\r
  41   @Inject StateManager stateMgr;\r
  42   @Inject Pazpar2Commands pzreq;\r
  43   @Inject Pazpar2Responses pzresp;\r
  44   \r
  45   protected ResultsPager pager = null; \r
  46 \r
  47   protected List<ErrorInterface> configurationErrors = null;\r
  48   protected ErrorHelper errorHelper = null;\r
  49               \r
  50   public Pz2Bean () {\r
  51     logger.info("Instantiating pz2 bean [" + Utils.objectId(this) + "]");    \r
  52   }\r
  53   \r
  54   @PostConstruct\r
  55   public void postConstruct() {    \r
  56     logger.debug("in start of Pz2Bean post-construct configurator is " + configurator);\r
  57     logger.debug(Utils.objectId(this) + " will instantiate a Pz2Client next.");\r
  58     searchClient = new Pz2Client();\r
  59     logger.info("Using [" + Utils.objectId(searchClient) + "] configured by [" \r
  60                           + Utils.objectId(configurator) + "]" );    \r
  61     configureClient(searchClient,configurator);\r
  62     stateMgr.addStateListener(this);\r
  63   }  \r
  64   \r
  65   public void configureClient(SearchClient searchClient, ConfigurationReader configReader) {\r
  66     configurationErrors = new ArrayList<ErrorInterface>();\r
  67     errorHelper = new ErrorHelper(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       // At the time of writing this search client is injected using Weld. \r
  72       // However, the client is used for asynchronously sending off requests\r
  73       // to the server AND propagation of context to threads is currently \r
  74       // not supported. Trying to do so throws a WELD-001303 error. \r
  75       // To avoid that, a context free client is cloned from the context \r
  76       // dependent one. \r
  77       // If propagation to threads gets supported, the cloning can go.\r
  78       //\r
  79       // Commented as I'm trying with regular instantiation instead\r
  80       // this.searchClient = searchClient.cloneMe();         \r
  81     } catch (ConfigurationException e) {\r
  82       configurationErrors.add(new ConfigurationError("Search Client","Configuration",e.getMessage(),new ErrorHelper(configReader)));          \r
  83     } \r
  84     logger.info(configReader.document());\r
  85     pzresp.reset();    \r
  86   }\r
  87 \r
  88     \r
  89   public void doSearch(String query) {\r
  90     pzreq.getSearch().setParameter(new CommandParameter("query","=",query));     \r
  91     doSearch();\r
  92   }\r
  93 \r
  94   public void doSearch() { \r
  95     stateMgr.hasPendingStateChange("search",false);\r
  96     pzresp.reset();\r
  97     // TODO: avoid state proliferation here:\r
  98     pzreq.getRecord().removeParameters();\r
  99     pzreq.getShow().setParameter(new CommandParameter("start","=",0));    \r
 100     logger.debug(Utils.objectId(this) + " is searching using "+pzreq.getCommandReadOnly("search").getUrlEncodedParameterValue("query"));\r
 101     doCommand("search");    \r
 102   }\r
 103       \r
 104   /**\r
 105    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
 106    * \r
 107    * @return Number of activeclients at the time of the 'show' command.\r
 108    */\r
 109   public String update () {\r
 110     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
 111     return update("show,stat,termlist,bytarget");\r
 112   }\r
 113    \r
 114   /**\r
 115    * Refreshes the data objects listed in 'commands' from pazpar2\r
 116    * \r
 117    * @param commands\r
 118    * @return Number of activeclients at the time of the 'show' command\r
 119    */\r
 120   public String update (String commands) {\r
 121     if (! hasConfigurationErrors()) {\r
 122       if (hasQuery()) {\r
 123         handleQueryStateChanges(commands);\r
 124         logger.debug("Processing request for " + commands); \r
 125         List<CommandThread> threadList = new ArrayList<CommandThread>();\r
 126         StringTokenizer tokens = new StringTokenizer(commands,",");\r
 127         while (tokens.hasMoreElements()) {          \r
 128           threadList.add(new CommandThread(pzreq.getCommandReadOnly(tokens.nextToken()),searchClient));            \r
 129         }\r
 130         for (CommandThread thread : threadList) {\r
 131           thread.start();\r
 132         }\r
 133         for (CommandThread thread : threadList) {\r
 134           try {\r
 135             thread.join();\r
 136           } catch (InterruptedException e) {\r
 137             e.printStackTrace();\r
 138           }\r
 139         }\r
 140         for (CommandThread thread : threadList) {\r
 141            String commandName = thread.getCommand().getName();\r
 142            String response = thread.getResponse();\r
 143            logger.debug("Response was: " + response);\r
 144            Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);\r
 145            pzresp.put(commandName, responseObject);        \r
 146         }\r
 147         if (commands.equals("record")) {\r
 148           logger.debug("Record: Active clients: "+pzresp.getRecord().getActiveClients());\r
 149           return pzresp.getRecord().getActiveClients();\r
 150         } else {\r
 151           return pzresp.getActiveClients();\r
 152         }  \r
 153       } else {\r
 154         logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
 155         pzresp.reset();\r
 156         return "0";\r
 157       }\r
 158     } else {\r
 159       logger.error("Did not attempt to execute query since there are configuration errors.");\r
 160       return "0";\r
 161     }\r
 162     \r
 163   }\r
 164                                 \r
 165   public String toggleRecord (String recId) {\r
 166     if (hasRecord(recId)) {\r
 167       pzreq.getRecord().removeParameters();  \r
 168       pzresp.put("record", new RecordResponse());\r
 169       return "";\r
 170     } else {\r
 171       pzreq.getRecord().setId(recId);\r
 172       return doCommand("record");\r
 173     }\r
 174   }\r
 175   \r
 176   @Override\r
 177   public boolean hasRecord (String recId) {\r
 178     return pzreq.getCommandReadOnly("record").hasParameters() && pzresp.getRecord().getRecId().equals(recId);\r
 179   }\r
 180         \r
 181   public String getCurrentStateKey () {    \r
 182     return stateMgr.getCurrentState().getKey();\r
 183   }\r
 184       \r
 185   public void setCurrentStateKey(String key) {       \r
 186     stateMgr.setCurrentStateKey(key);\r
 187   }\r
 188   \r
 189   public boolean hasConfigurationErrors () {\r
 190       return (configurationErrors.size()>0);      \r
 191   }\r
 192   \r
 193   public boolean hasCommandErrors () {\r
 194     return pzresp.hasApplicationError();\r
 195   }\r
 196   \r
 197   /**\r
 198    * Returns true if application error found in any response data objects \r
 199    */\r
 200   public boolean hasErrors () {\r
 201     return hasConfigurationErrors() || hasCommandErrors();\r
 202   }\r
 203 \r
 204   public List<ErrorInterface> getConfigurationErrors() {    \r
 205     return configurationErrors;\r
 206   }\r
 207   \r
 208   \r
 209   protected boolean hasQuery() {        \r
 210     return pzreq.getCommandReadOnly("search").hasParameterSet("query"); \r
 211   }\r
 212     \r
 213     \r
 214   public ResultsPager getPager () {\r
 215     if (pager == null) {\r
 216       pager = new ResultsPager(pzresp);      \r
 217     } \r
 218     return pager;      \r
 219   }\r
 220   \r
 221   public ResultsPager setPager (int pageRange) {\r
 222     pager =  new ResultsPager(pzresp,pageRange,pzreq);\r
 223     return pager;\r
 224   }\r
 225   \r
 226   protected ErrorHelper getTroubleshooter() {\r
 227     return errorHelper;\r
 228   }\r
 229   \r
 230   protected void handleQueryStateChanges (String commands) {\r
 231     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
 232       logger.debug("Found pending search change. Doing search before updating " + commands);      \r
 233       doSearch();\r
 234     } \r
 235     if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 236       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 237       stateMgr.hasPendingStateChange("record",false);\r
 238       if (pzreq.getCommandReadOnly("record").hasParameters()) {\r
 239         update("record");\r
 240       } else {         \r
 241         pzresp.put("record", new RecordResponse());\r
 242       }\r
 243     }\r
 244   }\r
 245   \r
 246   protected String doCommand(String commandName) {             \r
 247     logger.debug(pzreq.getCommandReadOnly(commandName).getEncodedQueryString() + ": Results for "+ pzreq.getCommandReadOnly("search").getEncodedQueryString());\r
 248     return update(commandName);\r
 249   }\r
 250   \r
 251   @Override\r
 252   public void stateUpdated(String commandName) {\r
 253     logger.debug("State change reported for [" + commandName + "]");\r
 254     if (commandName.equals("show")) {\r
 255       logger.debug("Updating show");\r
 256       update(commandName);\r
 257     } \r
 258   }\r
 259 \r
 260 \r
 261 }\r