X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fpazpar2%2FPz2Client.java;h=9e02137d14a54bfa19860f16218afe8ca2e2ed0c;hb=74ea81b22375676bf687d614161c19f268289e39;hp=78627d996a7131fe3926039f0614a8f6beffdffe;hpb=290b089e0e807f4d54c13eb0b309fe41ff78d89b;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 78627d9..9e02137 100644
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java
@@ -24,8 +24,38 @@ import com.indexdata.mkjsf.config.Configuration;
 import com.indexdata.mkjsf.config.ConfigurationReader;
 import com.indexdata.mkjsf.errors.ConfigurationException;
 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>  
+ * 
+ * <h3>Configuration</h3>
+ *
+ * Configuration name: pz2client.
+ *  
+ * <p>When configuring the client using the Mk2Config scheme, this is the prefix to
+ * use in the .properties file. When using web.xml context parameters for configuration
+ * the configuration name has no effect.</p> 
+ * 
+ * <p>Pz2Client will acknowledge following configuration parameters:
+ * 
+ * <ul>
+ *  <li>(pz2client.)PAZPAR2_URL</li>
+ *  <li>(pz2client.)SERVICE_ID</li>
+ * </ul> 
+ *  
+ * @author Niels Erik
+ *
+ */
 public class Pz2Client implements SearchClient {
 
   private static final long serialVersionUID = 5414266730169982028L;
@@ -33,10 +63,15 @@ public class Pz2Client implements SearchClient {
   private transient Pazpar2Client client = null;
   private Pazpar2ClientConfiguration cfg = null;
   public static final String MODULENAME = "pz2client";
+  
+  /**
+   * PAZPAR2_URL=none, PROXY_MODE=1, SERIALIZE_REQUESTS=false, STREAMBUFF_SIZE=4096, PARSE_RESPONSES=true
+   */
   public static Map<String,String> DEFAULTS = new HashMap<String,String>();
-  Configuration config = null;
+  Configuration config = null;  
   
   static {    
+    DEFAULTS.put("PAZPAR2_URL", "");
     DEFAULTS.put("PROXY_MODE","1");
     DEFAULTS.put("SERIALIZE_REQUESTS", "false");
     DEFAULTS.put("STREAMBUFF_SIZE", "4096");
@@ -49,7 +84,7 @@ public class Pz2Client implements SearchClient {
   public void configure(ConfigurationReader configReader) throws ConfigurationException {    
     logger.info(Utils.objectId(this) + " is configuring using the provided " + Utils.objectId(configReader));
     try {
-      config = configReader.getConfiguration(this);
+      config = configReader.getConfiguration(this);      
       cfg = new Pazpar2ClientConfiguration(new ConfigurationGetter(config));
     } catch (ProxyErrorException pe) {
       logger.error("Could not configure Pazpar2 client: " + pe.getMessage());
@@ -57,7 +92,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);
@@ -82,16 +117,63 @@ public class Pz2Client implements SearchClient {
   
   @Override
   public void setSearchCommand(Pazpar2Command command) {
-    ClientCommand clientCommand = new ClientCommand(command.getName(), command.getEncodedQueryString());
+    ClientCommand clientCommand = new ClientCommand(command.getCommandName(), command.getEncodedQueryString());
     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 CommandResponse executeCommand(Pazpar2Command command, ByteArrayOutputStream baos) 
-       throws Pazpar2ErrorException, IOException {
-    ClientCommand clientCommand = new ClientCommand(command.getName(), command.getEncodedQueryString());
-    Pazpar2HttpResponse pz2HttpResponse = client.executeCommand(clientCommand, baos);
-    return new Pz2CommandResponse(pz2HttpResponse,baos);
+  public HttpResponseWrapper executeCommand(Pazpar2Command command) {
+    ClientCommandResponse commandResponse = null;
+    ByteArrayOutputStream baos = new ByteArrayOutputStream();
+    ClientCommand clientCommand = new ClientCommand(command.getCommandName(), command.getEncodedQueryString());
+    Pazpar2HttpResponse pz2HttpResponse = null;
+    long start = System.currentTimeMillis();
+    try {
+      pz2HttpResponse = client.executeCommand(clientCommand, baos);
+      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.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.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(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(0,CommandError.createErrorXml(command.getCommandName(), "", "ServiceError", e.getMessage(),""),"text/xml");
+    }
+    long end = System.currentTimeMillis();      
+    logger.info("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );
+    return commandResponse;
   }
 
   public Pz2Client cloneMe() {
@@ -102,11 +184,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;
@@ -136,6 +224,9 @@ public class Pz2Client implements SearchClient {
     }
   }
 
+  /**
+   * Provides configuration documentation -- mostly for diagnosing problems   
+   */
   @Override
   public List<String> documentConfiguration() {
     List<String> doc = new ArrayList<String>();
@@ -147,4 +238,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;    
+  }
+  
+  /**
+   * 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());      
+    }
+  }
+
 }