Various fixes, clean-up, logs, documentation

 Reinstates error helper that went missing during refactoring

 Removes XML declaration from pazpar2 error responses in order to
 inject the XML itself into an application error XML document.

 Straightens some log statements

 Moves WELD-001303 error documentation aside (as it is not relevant
 with current approach)

diff --git a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Bean.java b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Bean.java
index 3d7d79c..5a07794 100644 (file)
--- a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Bean.java
+++ b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Bean.java
@@ -59,26 +59,18 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
     searchClient = new Pz2Client();\r
     logger.info("Using [" + Utils.objectId(searchClient) + "] configured by [" \r
                           + Utils.objectId(configurator) + "]" );    \r
-    configureClient(searchClient,configurator);\r
-    stateMgr.addStateListener(this);\r
+    configureClient(searchClient,configurator);    \r
+    stateMgr.addStateListener(this);    \r
   }  \r
   \r
   public void configureClient(SearchClient searchClient, ConfigurationReader configReader) {\r
-    configurationErrors = new ArrayList<ErrorInterface>();\r
-    errorHelper = new ErrorHelper(configReader);    \r
+    errorHelper = new ErrorHelper(configurator);\r
+    logger.info("pz2 " + Utils.objectId(this) + " sets error helper " + Utils.objectId(errorHelper) + " on pzresp " + Utils.objectId(pzresp));\r
+    pzresp.setErrorHelper(errorHelper);\r
+    configurationErrors = new ArrayList<ErrorInterface>();        \r
     logger.debug(Utils.objectId(this) + " will configure search client for the session");\r
     try {\r
       searchClient.configure(configReader);            \r
-      // At the time of writing this search client is injected using Weld. \r
-      // However, the client is used for asynchronously sending off requests\r
-      // to the server AND propagation of context to threads is currently \r
-      // not supported. Trying to do so throws a WELD-001303 error. \r
-      // To avoid that, a context free client is cloned from the context \r
-      // dependent one. \r
-      // If propagation to threads gets supported, the cloning can go.\r
-      //\r
-      // Commented as I'm trying with regular instantiation instead\r
-      // this.searchClient = searchClient.cloneMe();         \r
     } catch (ConfigurationException e) {\r
       configurationErrors.add(new ConfigurationError("Search Client","Configuration",e.getMessage(),new ErrorHelper(configReader)));          \r
     } \r
@@ -215,6 +207,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
    * Returns true if application error found in any response data objects \r
    */\r
   public boolean hasErrors () {\r
+    logger.debug("Checking for configuration errors or command errors.");\r
     return hasConfigurationErrors() || hasCommandErrors();\r
   }\r
 \r
@@ -239,11 +232,7 @@ public class Pz2Bean implements Pz2Interface, StateListener, Serializable {
     pager =  new ResultsPager(pzresp,pageRange,pzreq);\r
     return pager;\r
   }\r
-  \r
-  protected ErrorHelper getTroubleshooter() {\r
-    return errorHelper;\r
-  }\r
-  \r
+    \r
   protected void handleQueryStateChanges (String commands) {\r
     if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
       logger.debug("Found pending search change. Doing search before updating " + commands);      \r

diff --git a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/SearchClient.java b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/SearchClient.java
index c7d0cf9..54b1648 100644 (file)
--- a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/SearchClient.java
+++ b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/SearchClient.java
@@ -13,7 +13,14 @@ public interface SearchClient extends Configurable, Serializable {
   \r
   public void setSearchCommand(Pazpar2Command command);\r
   public CommandResponse executeCommand(Pazpar2Command command, ByteArrayOutputStream baos) throws Pazpar2ErrorException, IOException;\r
+  \r
+  // Use cloneMe() method if injecting the client with CDI.\r
+  // The client is used for asynchronously sending off requests\r
+  // to the server AND propagation of context to threads is currently \r
+  // not supported. Trying to do so throws a WELD-001303 error. \r
+  // If propagation to threads gets supported, the cloning can go.\r
   public SearchClient cloneMe();\r
+  \r
   public boolean isAuthenticatingClient();  \r
   public Configuration getConfiguration();\r
 }\r

diff --git a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/commands/CommandParameter.java b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/commands/CommandParameter.java
index c8f2201..7630ecd 100644 (file)
--- a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/commands/CommandParameter.java
+++ b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/commands/CommandParameter.java
@@ -21,12 +21,12 @@ public class CommandParameter implements Serializable {
   Map<String,Expression> expressions = new HashMap<String,Expression>();\r
   \r
   public CommandParameter (String name) {\r
-    logger.debug("Instantiating command parameter (1) " + name);\r
+    logger.debug("Instantiating command parameter '" + name + "'");\r
     this.name = name;\r
   }\r
   \r
   public CommandParameter (String name, String operator, String value, Expression... expressions) {\r
-    logger.debug("Instantiating command parameter (2) " + name + " with " + expressions);\r
+    logger.debug("Instantiating command parameter " + name + " with expressions: [" + expressions + "]");\r
     this.name = name;\r
     this.operator = operator;\r
     this.value = value;\r
@@ -36,14 +36,14 @@ public class CommandParameter implements Serializable {
   }\r
 \r
   public CommandParameter (String name, String operator, String value) {\r
-    logger.debug("Instantiating command parameter (3) " + name + " ("+this+") with " + value);\r
+    logger.debug("Instantiating command parameter '" + name + "' with String: [" + value + "]");\r
     this.name = name;\r
     this.operator = operator;\r
     this.value = value;    \r
   }\r
   \r
   public CommandParameter (String name, String operator, int value) {\r
-    logger.debug("Instantiating command parameter (4) " + name + " ("+this+") with " + value);\r
+    logger.debug("Instantiating command parameter '" + name + "' with int: [" + value + "]");\r
     this.name = name;\r
     this.operator = operator;\r
     this.value = value+"";    \r
@@ -59,7 +59,7 @@ public class CommandParameter implements Serializable {
   }\r
   \r
   public void addExpression(Expression expression) {\r
-    logger.debug("Adding expression [" + expression + "] to " + this.getName() + " ("+this+")");\r
+    logger.debug("Adding expression [" + expression + "] to '" + name + "'");\r
     this.expressions.put(expression.toString(),expression);\r
   }\r
   \r
@@ -111,6 +111,7 @@ public class CommandParameter implements Serializable {
   }\r
   \r
   public CommandParameter copy() {\r
+    logger.debug("Copying parameter '"+ name + "' for modification");\r
     CommandParameter newParam = new CommandParameter(name);\r
     newParam.value = this.value;\r
     newParam.operator = this.operator;\r

diff --git a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/commands/Pazpar2Command.java b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/commands/Pazpar2Command.java
index b4f67e9..7ef96bd 100644 (file)
--- a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/commands/Pazpar2Command.java
+++ b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/commands/Pazpar2Command.java
@@ -20,7 +20,7 @@ public class Pazpar2Command implements Serializable  {
   public Pazpar2Command (String name, StateManager stateMgr) {\r
     this.name = name;\r
     if (stateMgr == null) {\r
-      // Set one-off dummy state mgr\r
+      // Sets throw-away state\r
       this.stateMgr = new StateManager();\r
     } else {\r
       this.stateMgr = stateMgr;\r
@@ -40,30 +40,30 @@ public class Pazpar2Command implements Serializable  {
   }\r
     \r
   public void setParameter (CommandParameter parameter) {\r
-    Pazpar2Command thisCommand = this.copy();\r
-    logger.debug(name + " setting parameter " + parameter.getName() + "=" + parameter.getValueWithExpressions() + " to " + this.getName());\r
-    thisCommand.parameters.put(parameter.getName(),parameter);\r
-    stateMgr.checkIn(thisCommand);\r
+    Pazpar2Command copy = this.copy();\r
+    logger.debug(name + " command: setting parameter [" + parameter.getName() + "=" + parameter.getValueWithExpressions() + "]");\r
+    copy.parameters.put(parameter.getName(),parameter);\r
+    stateMgr.checkIn(copy);\r
   }\r
   \r
   public void setParameters (CommandParameter... params) {\r
-    Pazpar2Command thisCommand = this.copy();\r
+    Pazpar2Command copy = this.copy();\r
     for (CommandParameter param : params) {\r
-      logger.debug(name + " setting parameter " + param.getName() + "=" + param.getValueWithExpressions() + " to " + this.getName());\r
-      thisCommand.parameters.put(param.getName(),param);\r
+      logger.debug(name + " command: setting parameter [" + param.getName() + "=" + param.getValueWithExpressions() + "]");\r
+      copy.parameters.put(param.getName(),param);\r
     }\r
-    stateMgr.checkIn(thisCommand);\r
+    stateMgr.checkIn(copy);\r
   }\r
   \r
   public void setParametersInState (CommandParameter... params) {    \r
     for (CommandParameter param : params) {\r
-      logger.debug(name + " setting parameter " + param.getName() + "=" + param.getValueWithExpressions() + " to " + this.getName());\r
+      logger.debug(name + " command: setting parameter [" + param.getName() + "=" + param.getValueWithExpressions() + "] silently");\r
       parameters.put(param.getName(),param);\r
     }    \r
   }\r
     \r
   public void setParameterInState (CommandParameter parameter) {\r
-    logger.debug(name + " setting parameter silently " + parameter.getName() + "=" + parameter.getValueWithExpressions() + " to " + this.getName());\r
+    logger.debug(name + " command: setting parameter [" + parameter.getName() + "=" + parameter.getValueWithExpressions() + "] silently");\r
     parameters.put(parameter.getName(),parameter);    \r
   }\r
   \r
@@ -73,15 +73,15 @@ public class Pazpar2Command implements Serializable  {
   }\r
   \r
   public void removeParameter (String name) {\r
-    Pazpar2Command thisCommand = this.copy();\r
-    thisCommand.parameters.remove(name);\r
-    stateMgr.checkIn(thisCommand);\r
+    Pazpar2Command copy = this.copy();\r
+    copy.parameters.remove(name);\r
+    stateMgr.checkIn(copy);\r
   }\r
   \r
   public void removeParameters() {\r
-    Pazpar2Command thisCommand = this.copy();\r
-    thisCommand.parameters = new HashMap<String,CommandParameter>();\r
-    stateMgr.checkIn(thisCommand);\r
+    Pazpar2Command copy = this.copy();\r
+    copy.parameters = new HashMap<String,CommandParameter>();\r
+    stateMgr.checkIn(copy);\r
   }\r
   \r
   public void removeParametersInState() {\r

diff --git a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/data/CommandError.java b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/data/CommandError.java
index 05cd506..64080e3 100644 (file)
--- a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/data/CommandError.java
+++ b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/data/CommandError.java
@@ -4,6 +4,7 @@ import static com.indexdata.pz2utils4jsf.utils.Utils.nl;
 \r
 import java.util.ArrayList;\r
 import java.util.List;\r
+import java.util.regex.Pattern;\r
 \r
 import com.indexdata.pz2utils4jsf.errors.ErrorInterface;\r
 import com.indexdata.pz2utils4jsf.errors.ErrorHelper;\r
@@ -27,6 +28,7 @@ import com.indexdata.utils.XmlUtils;
 public class CommandError extends Pazpar2ResponseData implements ErrorInterface {\r
 \r
   private static final long serialVersionUID = 8878776025779714122L;\r
+  private static Pattern xmlDeclaration = Pattern.compile("<\\?xml.*\\?>");\r
   private ErrorCode applicationErrorCode;\r
   private ErrorHelper errorHelper = null;\r
   \r
@@ -98,7 +100,7 @@ public class CommandError extends Pazpar2ResponseData implements ErrorInterface
     errorXml.append(" <applicationerror>"+nl);\r
     errorXml.append("  <commandname>" + commandName + "</commandname>"+nl);\r
     errorXml.append("  <exception>" + XmlUtils.escape(exceptionName) + "</exception>"+nl);    \r
-    errorXml.append(pazpar2ErrorXml+nl);    \r
+    errorXml.append(xmlDeclaration.matcher(pazpar2ErrorXml).replaceAll("")+nl);    \r
     errorXml.append(" </applicationerror>"+nl);\r
     errorXml.append("</" + commandName + ">"+nl);\r
     return errorXml.toString(); \r

diff --git a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/data/Pazpar2Responses.java b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/data/Pazpar2Responses.java
index 4f0daa1..b9da841 100644 (file)
--- a/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/data/Pazpar2Responses.java
+++ b/src/main/java/com/indexdata/pz2utils4jsf/pazpar2/data/Pazpar2Responses.java
@@ -10,14 +10,17 @@ import javax.inject.Named;
 \r
 import org.apache.log4j.Logger;\r
 \r
+import com.indexdata.pz2utils4jsf.errors.ErrorHelper;\r
 import com.indexdata.pz2utils4jsf.errors.ErrorInterface;\r
+import com.indexdata.pz2utils4jsf.utils.Utils;\r
 \r
 @Named("pzresp") @SessionScoped\r
 public class Pazpar2Responses implements Serializable {\r
-  \r
+    \r
   private static final long serialVersionUID = -7543231258346154642L;\r
   protected Map<String,Pazpar2ResponseData> dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
   private static Logger logger = Logger.getLogger(Pazpar2Responses.class);\r
+  private ErrorHelper errorHelper = null;\r
 \r
   public Pazpar2Responses() {    \r
   }\r
@@ -26,6 +29,10 @@ public class Pazpar2Responses implements Serializable {
     dataObjects.put(name, responseData);\r
   }\r
   \r
+  public void setErrorHelper(ErrorHelper helper) {    \r
+    this.errorHelper = helper;\r
+  }\r
+  \r
   public boolean hasApplicationError () {\r
     if (getSearch().hasApplicationError()) {\r
       logger.info("Error detected in search");\r
@@ -46,18 +53,19 @@ public class Pazpar2Responses implements Serializable {
    * an empty dummy error. \r
    */    \r
   public ErrorInterface getCommandError() {\r
-    CommandError error = new CommandError();    \r
+    CommandError error = new CommandError();\r
     if (dataObjects.get("search").hasApplicationError()) {\r
-      error = dataObjects.get("search").getApplicationError();                        \r
+      error = dataObjects.get("search").getApplicationError();\r
+      error.setErrorHelper(errorHelper);\r
     } else {\r
       for (String name : dataObjects.keySet()) {     \r
         if (dataObjects.get(name).hasApplicationError()) {     \r
-          error = dataObjects.get(name).getApplicationError(); \r
+          error = dataObjects.get(name).getApplicationError();\r
+          error.setErrorHelper(errorHelper);\r
           break;\r
         } \r
       }\r
     }\r
-    // TODO error.setErrorHelper(errorHelper);\r
     return error;         \r
   }\r
   \r