X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fpazpar2%2FPz2Client.java;h=3417a473693995055ee06a3aa3831330799a3d4d;hb=86f289cd42ba95846c80d22129ed565e4e9d6dde;hp=cbdcf6bd4a09814fd42f8145484f48b8d8460a4f;hpb=f8e3b4201cef8e9ce03109b17ce8047a98b43e39;p=mkjsf-moved-to-github.git

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java
index cbdcf6b..3417a47 100644
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java
@@ -27,6 +27,20 @@ import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;
 import com.indexdata.mkjsf.pazpar2.data.CommandError;
 import com.indexdata.mkjsf.utils.Utils;
 
+/**
+ * Search client handling straight Pazpar2 requests. 
+ * 
+ * <p>Although it is described here as straight Pazpar2, the client itself 
+ * actually represents a layer between Pazpar2 and the JSF application because it 
+ * uses the Pazpar2 client from the library masterkey-common.</p>
+ * That client, which is the one also used by the Service Proxy, does perform certain 
+ * types of session handling, bootstraps lost sessions, avoids repeating already 
+ * executed queries etc, so it is -- in other words -- still a mediated interaction 
+ * with Pazpar2 that takes place. At least for now.</p>  
+ *  
+ * @author Niels Erik
+ *
+ */
 public class Pz2Client implements SearchClient {
 
   private static final long serialVersionUID = 5414266730169982028L;
@@ -59,7 +73,7 @@ public class Pz2Client implements SearchClient {
     } 
     if (cfg != null) {
       try {
-        client = new Pazpar2ClientGeneric(cfg);  
+        client = new Pazpar2ClientGeneric(cfg);        
       } catch (ProxyErrorException pe) {
         logger.error("Could not configure Pazpar2 client: " + pe.getMessage());
         throw new ConfigurationException("Could not configure Pz2Client:  "+ pe.getMessage(),pe);
@@ -88,6 +102,13 @@ public class Pz2Client implements SearchClient {
     client.setSearchCommand(clientCommand);    
   }
 
+  /**
+   * Runs the give Pazpar2 command and returns a response wrapper with either the received response or 
+   * with some form of error message. 
+   * 
+   * It is intended that this method never throws an exception. All events are supposed to be captured and
+   * returned in some form of response. 
+   */
   @Override
   public HttpResponseWrapper executeCommand(Pazpar2Command command) {
     ClientCommandResponse commandResponse = null;
@@ -97,29 +118,42 @@ public class Pz2Client implements SearchClient {
     long start = System.currentTimeMillis();
     try {
       pz2HttpResponse = client.executeCommand(clientCommand, baos);
-      if (pz2HttpResponse.getStatusCode()==200) {
+      if (pz2HttpResponse.getStatusCode()==200 && pz2HttpResponse.getContentType().contains("xml")) {
         commandResponse = new ClientCommandResponse(pz2HttpResponse,baos);
+      } else if (pz2HttpResponse.getStatusCode()==200 && pz2HttpResponse.getContentType().contains("octet-stream")) {
+        commandResponse = new ClientCommandResponse(pz2HttpResponse,baos);
+        logger.info("Content type: " + commandResponse.getContentType() + ". isBinary?: " + commandResponse.isBinary());
       } else if (pz2HttpResponse.getStatusCode()==417) {
         logger.error("Pazpar2 status code 417: " + baos.toString("UTF-8"));
-        commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertPazpar2ErrorXml(command.getCommandName(), "Pazpar2: Expectation failed (417)", baos.toString("UTF-8")),"text/xml");                       
+        commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()) ,"Pazpar2: Expectation failed (417)", baos.toString("UTF-8")),"text/xml");                       
+      } else if (pz2HttpResponse.getContentType().contains("html")) {
+        String resp = baos.toString("UTF-8");
+        logger.error("HTML response where XML was expected. Status code was " + pz2HttpResponse.getStatusCode() + ": " + resp);
+        String htmlStrippedOfTags = resp.replaceAll("\\<[^>]*>","");
+        String errorXml = "";
+        if (htmlStrippedOfTags.toLowerCase().contains("domain")) {
+          errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "Unexpected response type from Pazpar2", "Error: Expected XML response from Pazpar2 but got HTML. The HTML contains the word domain suggesting that the Pazpar2 address was not found.", htmlStrippedOfTags);
+        } else {  
+          errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "Unexpected response type from Pazpar2: " + pz2HttpResponse.getContentType(),"Expected XML response from Pazpar2, got HTML", htmlStrippedOfTags);
+        } 
+        commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),errorXml,pz2HttpResponse.getContentType());        
       } else {
         String resp = baos.toString("UTF-8");
         logger.error("Pazpar2 status code was " + pz2HttpResponse.getStatusCode() + ": " + resp);
-        commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertPazpar2ErrorXml(command.getCommandName(), "Pazpar2 error occurred", baos.toString("UTF-8")),"text/xml");
-        throw new Pazpar2ErrorException(resp,pz2HttpResponse.getStatusCode(),resp,null);
+        commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "Pazpar2 error occurred", baos.toString("UTF-8")),"text/xml");        
       }       
     } catch (IOException e) {
       logger.error(e.getMessage());
       e.printStackTrace();
-      commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml(command.getCommandName(), "io", e.getMessage()),"text/xml");      
+      commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.createErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "IO exception", e.getMessage(), ""),"text/xml");      
     } catch (Pazpar2ErrorException e) {
       logger.error(e.getMessage());
       e.printStackTrace();
       logger.error("Creating error XML");
-      commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml(command.getCommandName(), "io", e.getMessage()),"text/xml");
+      commandResponse = new ClientCommandResponse(0,CommandError.createErrorXml(command.getCommandName(), "", "ServiceError", e.getMessage(),""),"text/xml");
     }
     long end = System.currentTimeMillis();      
-    logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );
+    logger.info("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );
     return commandResponse;
   }
 
@@ -131,11 +165,17 @@ public class Pz2Client implements SearchClient {
     return clone;
   }
 
+  /**
+   * Returns default configuration parameters for the client.
+   */
   @Override
   public Map<String, String> getDefaults() {
     return DEFAULTS;
   }
 
+  /**
+   * Returns the configuration name of the client
+   */
   @Override
   public String getModuleName() {
     return MODULENAME;
@@ -165,6 +205,9 @@ public class Pz2Client implements SearchClient {
     }
   }
 
+  /**
+   * Provides configuration documentation -- mostly for diagnosing problems   
+   */
   @Override
   public List<String> documentConfiguration() {
     List<String> doc = new ArrayList<String>();
@@ -176,20 +219,48 @@ public class Pz2Client implements SearchClient {
     return config;
   }
 
+  /**
+   * Returns the currently configured Papzar2 URL.
+   */
   @Override
   public String getServiceUrl() {
     return cfg.PAZPAR2_URL;    
   }
 
+  /**
+   * Returns true if a Papzar2 URL was defined yet. 
+   */
   @Override
   public boolean hasServiceUrl() {
     return cfg.PAZPAR2_URL != null && cfg.PAZPAR2_URL.length()>0;
   }
   
+  /**
+   * Sets the Pazpar2 URL to use for requests. 
+   */
   @Override 
   public void setServiceUrl (String serviceUrl) {    
-    cfg.PAZPAR2_URL = serviceUrl;
-    
+    cfg.PAZPAR2_URL = serviceUrl;    
+  }
+  
+  /**
+   * Returns the Pazpar2 Service ID 
+   */
+  public String getServiceId () {
+    return cfg.PAZPAR2_SERVICE_ID;
+  }
+  
+  /**
+   * Sets the service ID that Pazpar2 should use when servicing requests
+   * @param serviceId
+   */
+  public void setServiceId(String serviceId) {
+    cfg.PAZPAR2_SERVICE_ID = serviceId;
+    try {
+      client = new Pazpar2ClientGeneric(cfg);  
+    } catch (ProxyErrorException pe) {
+      logger.error("Could not configure Pazpar2 client: " + pe.getMessage());      
+    }
   }
 
 }