Adds windowid parameter to SP init command
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / ServiceProxyClient.java
index 51afab2..26e5c9a 100644 (file)
@@ -34,12 +34,20 @@ import org.apache.log4j.Logger;
 import com.indexdata.mkjsf.config.Configuration;\r
 import com.indexdata.mkjsf.config.ConfigurationReader;\r
 import com.indexdata.mkjsf.errors.ConfigurationException;\r
+import com.indexdata.mkjsf.errors.MissingConfigurationContextException;\r
 import com.indexdata.mkjsf.pazpar2.commands.CommandParameter;\r
 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;\r
 import com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand;\r
+import com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommand;\r
 import com.indexdata.mkjsf.pazpar2.data.CommandError;\r
 import com.indexdata.mkjsf.utils.Utils;\r
 \r
+/**\r
+ * Search client handling Service Proxy requests. \r
+ *   \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class ServiceProxyClient implements SearchClient {\r
     \r
   private static final long serialVersionUID = -4031644009579840277L;\r
@@ -65,20 +73,22 @@ public class ServiceProxyClient implements SearchClient {
   }\r
     \r
   @Override\r
-  public void configure (ConfigurationReader configReader) {\r
+  public void configure (ConfigurationReader configReader) throws MissingConfigurationContextException {\r
     logger.info(Utils.objectId(this) + " is configuring using the provided " + Utils.objectId(configReader));\r
     try {\r
       config = configReader.getConfiguration(this);      \r
       serviceUrl = config.get("SERVICE_PROXY_URL");\r
       this.initDocPaths = config.getMultiProperty(SP_INIT_DOC_PATHS,",");\r
-      checkAuth = new AuthCommand(null);\r
+      checkAuth = new AuthCommand();\r
       checkAuth.setParameterInState(new CommandParameter("action","=","check"));\r
-      ipAuth = new AuthCommand(null);\r
+      ipAuth = new AuthCommand();\r
       ipAuth.setParameterInState(new CommandParameter("action","=","ipauth"));\r
-    } catch (ConfigurationException c) {\r
-      // TODO: \r
-      c.printStackTrace();\r
-    }    \r
+    } catch (MissingConfigurationContextException mcce) {\r
+      throw mcce;\r
+    } catch (ConfigurationException ce) {\r
+      logger.error("Failed to configure Service Proxy client");\r
+      ce.printStackTrace();\r
+    }\r
   }\r
     \r
   public boolean isAuthenticatingClient () {\r
@@ -100,30 +110,31 @@ public class ServiceProxyClient implements SearchClient {
     byte[] response = null;\r
     try {\r
       response = client.execute(httpget, handler);\r
-      if (handler.getStatusCode()==200 && handler.getContentType().contains("xml")) {\r
+      if (handler.getStatusCode()==200 && (handler.getContentType().contains("xml") || handler.getContentType().contains("octet-stream"))) {\r
+        logger.trace("Creating command response holding content of type " + handler.getContentType());\r
         commandResponse = new ClientCommandResponse(handler.getStatusCode(),response,handler.getContentType());\r
       } else {\r
         logger.error("Service Proxy status code: " + handler.getStatusCode());\r
         String errorXml = "";\r
         if (handler.getContentType().contains("xml")) {\r
-          errorXml = CommandError.insertErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Service Proxy error: "+handler.getStatusCode(), new String(response,"UTF-8"));          \r
+          errorXml = CommandError.insertErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Service Proxy error: "+handler.getStatusCode(), new String(response,"UTF-8"));        \r
         } else {\r
           if (handler.getContentType().contains("html")) {\r
             String htmlStrippedOfTags = (new String(response,"UTF-8")).replaceAll("\\<[^>]*>","");\r
             if (htmlStrippedOfTags.toLowerCase().contains("domain")) {\r
-              errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Error: Expected XML response from Service Proxy, got HTML with word 'domain' in, probably domain not found.", htmlStrippedOfTags);              \r
+              errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Unexpected response type from Service Proxy", "Expected XML from SP but got HTML. It contains the word domain suggesting that the service address was not found.", htmlStrippedOfTags);              \r
             } else {\r
-              errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Error: Expected XML response from Service Proxy, got HTML", htmlStrippedOfTags);              \r
+              errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Unexpected response type from Service Proxy", "Expected XML from SP but got HTML", htmlStrippedOfTags);              \r
             }\r
           } else {\r
-            errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Error: Expected XML response from Service Proxy, got: "+handler.getContentType(), new String(response,"UTF-8"));\r
-          }\r
-          commandResponse = new ClientCommandResponse(handler.getStatusCode(),errorXml,handler.getContentType());\r
+            errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Unexpected response type from Service Proxy: "+handler.getContentType(), "Could not process non-XML response from Service Proxy", new String(response,"UTF-8"));\r
+          }          \r
         }\r
+        commandResponse = new ClientCommandResponse(handler.getStatusCode(),errorXml,handler.getContentType());\r
       }       \r
     } catch (Exception e) {\r
       e.printStackTrace();\r
-      commandResponse = new ClientCommandResponse(handler.getStatusCode(),CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), e.getClass().getSimpleName(), (e.getMessage()!= null ? e.getMessage() : "") + (e.getCause()!=null ? e.getCause().getMessage() : "")),handler.getContentType());\r
+      commandResponse = new ClientCommandResponse(handler.getStatusCode(),CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), e.getClass().getSimpleName(), (e.getMessage()!= null ? e.getMessage() : "") + (e.getCause()!=null ? e.getCause().getMessage() : ""), e.getStackTrace().toString()),handler.getContentType());\r
     }\r
     return commandResponse; \r
   }\r
@@ -161,6 +172,9 @@ public class ServiceProxyClient implements SearchClient {
     return handler.getReasonPhrase();\r
   }\r
 \r
+  /**\r
+   * Does nothing in Service Proxy context\r
+   */\r
   @Override\r
   public void setSearchCommand(Pazpar2Command command) {\r
     // Do nothing, Service Proxy is handling this    \r
@@ -180,11 +194,17 @@ public class ServiceProxyClient implements SearchClient {
     return clone;\r
   }\r
 \r
+  /**\r
+   * Returns default configuration parameters for the client.\r
+   */\r
   @Override\r
   public Map<String, String> getDefaults() {    \r
     return new HashMap<String,String>();\r
   }\r
 \r
+  /**\r
+   * Returns the configuration name of the client\r
+   */\r
   @Override\r
   public String getModuleName() {\r
     return MODULENAME;\r
@@ -222,8 +242,10 @@ public class ServiceProxyClient implements SearchClient {
     return initDocPaths;\r
   }\r
   \r
-  public HttpResponseWrapper postInitDoc(byte[] initDoc, boolean includeDebug) {\r
-    HttpPost post = new HttpPost(serviceUrl+"?command=init" + (includeDebug? "&includeDebug=yes" : ""));\r
+  public HttpResponseWrapper postInitDoc(byte[] initDoc, Pazpar2Command command) {\r
+    String requestParameters = command.getEncodedQueryString();\r
+    logger.info("Initiating session with init doc and [" + requestParameters +"]");\r
+    HttpPost post = new HttpPost(serviceUrl+"?" + requestParameters);\r
     post.setEntity(new ByteArrayEntity(initDoc));\r
     ClientCommandResponse commandResponse = null;\r
     byte[] response;\r
@@ -238,15 +260,18 @@ public class ServiceProxyClient implements SearchClient {
     } catch (ClientProtocolException e) {\r
       logger.error(e.getMessage());\r
       e.printStackTrace();\r
-      commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml("init", String.valueOf(handler.getStatusCode()), "client protocol exception", e.getMessage()),"text/xml");      \r
+      commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml("init", String.valueOf(handler.getStatusCode()), "Client protocol exception", e.getMessage(), e.getStackTrace().toString()),"text/xml");      \r
     } catch (IOException e) {\r
       logger.error(e.getMessage());\r
       e.printStackTrace();\r
-      commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml("init", String.valueOf(handler.getStatusCode()), "IO", e.getMessage()),"text/xml");      \r
+      commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml("init", String.valueOf(handler.getStatusCode()), "IO exception", e.getMessage(),e.getStackTrace().toString()),"text/xml");      \r
     }\r
     return commandResponse;    \r
   }\r
   \r
+  /**\r
+   * Sets the URL of the Service Proxy that should service requests. \r
+   */\r
   public void setServiceUrl (String url) {    \r
     serviceUrl = url;\r
   }\r
@@ -260,6 +285,9 @@ public class ServiceProxyClient implements SearchClient {
     return serviceUrl;\r
   }\r
 \r
+  /**\r
+   * Returns true if a Service Proxy URL was defined yet.\r
+   */\r
   @Override\r
   public boolean hasServiceUrl() {\r
     return serviceUrl != null && serviceUrl.length()>0;\r