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 req;\r
  43   @Inject Pazpar2Responses data;\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     data.reset();    \r
  86   }\r
  87 \r
  88     \r
  89   public void doSearch(String query) {\r
  90     req.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     data.reset();\r
  97     req.getRecord().removeParameters();\r
  98     req.getShow().setParameter(new CommandParameter("start","=",0));    \r
  99     logger.debug(Utils.objectId(this) + " is searching using "+req.getCommandReadOnly("search").getUrlEncodedParameterValue("query"));\r
 100     doCommand("search");    \r
 101   }\r
 102       \r
 103   /**\r
 104    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
 105    * \r
 106    * @return Number of activeclients at the time of the 'show' command.\r
 107    */\r
 108   public String update () {\r
 109     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
 110     return update("show,stat,termlist,bytarget");\r
 111   }\r
 112    \r
 113   /**\r
 114    * Refreshes the data objects listed in 'commands' from pazpar2\r
 115    * \r
 116    * @param commands\r
 117    * @return Number of activeclients at the time of the 'show' command\r
 118    */\r
 119   public String update (String commands) {\r
 120     if (! hasConfigurationErrors()) {\r
 121       if (hasQuery()) {\r
 122         handleQueryStateChanges(commands);\r
 123         logger.debug("Processing request for " + commands); \r
 124         List<CommandThread> threadList = new ArrayList<CommandThread>();\r
 125         StringTokenizer tokens = new StringTokenizer(commands,",");\r
 126         while (tokens.hasMoreElements()) {          \r
 127           threadList.add(new CommandThread(req.getCommandReadOnly(tokens.nextToken()),searchClient));            \r
 128         }\r
 129         for (CommandThread thread : threadList) {\r
 130           thread.start();\r
 131         }\r
 132         for (CommandThread thread : threadList) {\r
 133           try {\r
 134             thread.join();\r
 135           } catch (InterruptedException e) {\r
 136             e.printStackTrace();\r
 137           }\r
 138         }\r
 139         for (CommandThread thread : threadList) {\r
 140            String commandName = thread.getCommand().getName();\r
 141            String response = thread.getResponse();\r
 142            logger.debug("Response was: " + response);\r
 143            Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);\r
 144            data.put(commandName, responseObject);        \r
 145         }\r
 146         if (commands.equals("record")) {\r
 147           logger.debug("Record: Active clients: "+data.getRecord().getActiveClients());\r
 148           return data.getRecord().getActiveClients();\r
 149         } else {\r
 150           return data.getActiveClients();\r
 151         }  \r
 152       } else {\r
 153         logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
 154         data.reset();\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 String toggleRecord (String recId) {\r
 165     if (hasRecord(recId)) {\r
 166       req.getRecord().removeParameters();  \r
 167       data.put("record", new RecordResponse());\r
 168       return "";\r
 169     } else {\r
 170       req.getRecord().setRecordId(recId);\r
 171       return doCommand("record");\r
 172     }\r
 173   }\r
 174   \r
 175   @Override\r
 176   public boolean hasRecord (String recId) {\r
 177     return req.getCommandReadOnly("record").hasParameters() && data.getRecord().getRecId().equals(recId);\r
 178   }\r
 179         \r
 180   public String getCurrentStateKey () {    \r
 181     return stateMgr.getCurrentState().getKey();\r
 182   }\r
 183       \r
 184   public void setCurrentStateKey(String key) {       \r
 185     stateMgr.setCurrentStateKey(key);\r
 186   }\r
 187   \r
 188   public boolean hasConfigurationErrors () {\r
 189       return (configurationErrors.size()>0);      \r
 190   }\r
 191   \r
 192   public boolean hasCommandErrors () {\r
 193     return data.hasApplicationError();\r
 194   }\r
 195   \r
 196   /**\r
 197    * Returns true if application error found in any response data objects \r
 198    */\r
 199   public boolean hasErrors () {\r
 200     return hasConfigurationErrors() || hasCommandErrors();\r
 201   }\r
 202 \r
 203   public List<ErrorInterface> getConfigurationErrors() {    \r
 204     return configurationErrors;\r
 205   }\r
 206   \r
 207   \r
 208   protected boolean hasQuery() {    \r
 209     return req.getSearch().getParameter("query") != null && req.getSearch().getParameter("query").getValueWithExpressions().length()>0;\r
 210   }\r
 211     \r
 212     \r
 213   public ResultsPager getPager () {\r
 214     if (pager == null) {\r
 215       pager = new ResultsPager(data);      \r
 216     } \r
 217     return pager;      \r
 218   }\r
 219   \r
 220   public ResultsPager setPager (int pageRange) {\r
 221     pager =  new ResultsPager(data,pageRange,req);\r
 222     return pager;\r
 223   }\r
 224   \r
 225   protected ErrorHelper getTroubleshooter() {\r
 226     return errorHelper;\r
 227   }\r
 228   \r
 229   protected void handleQueryStateChanges (String commands) {\r
 230     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
 231       logger.debug("Found pending search change. Doing search before updating " + commands);      \r
 232       doSearch();\r
 233     } \r
 234     if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 235       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 236       stateMgr.hasPendingStateChange("record",false);\r
 237       if (req.getCommandReadOnly("record").hasParameters()) {\r
 238         update("record");\r
 239       } else {\r
 240         req.getRecord().removeParameters();  \r
 241         data.put("record", new RecordResponse());\r
 242       }\r
 243     }\r
 244   }\r
 245   \r
 246   protected String doCommand(String commandName) {             \r
 247     logger.debug(req.getCommandReadOnly(commandName).getEncodedQueryString() + ": Results for "+ req.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