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