X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fpazpar2%2FPz2Client.java;fp=src%2Fmain%2Fjava%2Fcom%2Findexdata%2Fmkjsf%2Fpazpar2%2FPz2Client.java;h=3417a473693995055ee06a3aa3831330799a3d4d;hb=cd63f324cf98a553f9cea33c50b0d68985552a8d;hp=0000000000000000000000000000000000000000;hpb=0bd75b32a504b9e04c4ebc901b075a2be89ee359;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
new file mode 100644
index 0000000..3417a47
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java
@@ -0,0 +1,266 @@
+package com.indexdata.mkjsf.pazpar2;
+
+import static com.indexdata.mkjsf.utils.Utils.nl;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.log4j.Logger;
+
+import com.indexdata.masterkey.config.MissingMandatoryParameterException;
+import com.indexdata.masterkey.config.ModuleConfigurationGetter;
+import com.indexdata.masterkey.pazpar2.client.ClientCommand;
+import com.indexdata.masterkey.pazpar2.client.Pazpar2Client;
+import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration;
+import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric;
+import com.indexdata.masterkey.pazpar2.client.Pazpar2HttpResponse;
+import com.indexdata.masterkey.pazpar2.client.exceptions.Pazpar2ErrorException;
+import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException;
+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>  
+ *  
+ * @author Niels Erik
+ *
+ */
+public class Pz2Client implements SearchClient {
+
+  private static final long serialVersionUID = 5414266730169982028L;
+  private static Logger logger = Logger.getLogger(Pz2Client.class);
+  private transient Pazpar2Client client = null;
+  private Pazpar2ClientConfiguration cfg = null;
+  public static final String MODULENAME = "pz2client";
+  public static Map<String,String> DEFAULTS = new HashMap<String,String>();
+  Configuration config = null;  
+  
+  static {    
+    DEFAULTS.put("PAZPAR2_URL", "");
+    DEFAULTS.put("PROXY_MODE","1");
+    DEFAULTS.put("SERIALIZE_REQUESTS", "false");
+    DEFAULTS.put("STREAMBUFF_SIZE", "4096");
+    DEFAULTS.put("PARSE_RESPONSES", "true");    
+  }
+  
+  public Pz2Client() {}
+  
+  @Override
+  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);      
+      cfg = new Pazpar2ClientConfiguration(new ConfigurationGetter(config));
+    } catch (ProxyErrorException pe) {
+      logger.error("Could not configure Pazpar2 client: " + pe.getMessage());
+      throw new ConfigurationException("Could not configure Pz2Client:  "+ pe.getMessage(),pe);
+    } 
+    if (cfg != null) {
+      try {
+        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);
+      }
+    } else {
+      logger.error("There was a problem creating Pz2Client. Client is null after configuration.");
+      throw new ConfigurationException("Pazpar2Client is null after configuration");
+    } 
+  }
+  
+  public boolean isAuthenticatingClient () {
+    return false;
+  }
+  
+  public boolean isAuthenticated() {
+    return false;
+  }
+  
+  public boolean authenticate() {
+    throw new UnsupportedOperationException("No authentication mechanism for straight pazpar2 client");
+  }
+  
+  @Override
+  public void setSearchCommand(Pazpar2Command command) {
+    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 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() {
+    logger.debug("Cloning Pz2Client");
+    Pz2Client clone = new Pz2Client();
+    clone.client = this.client;
+    clone.cfg = this.cfg;
+    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;
+  }
+  
+  class ConfigurationGetter implements ModuleConfigurationGetter {
+    Configuration config = null;
+    ConfigurationGetter(Configuration configuration) {
+      config = configuration;
+    }
+    @Override
+    public String get(String value) {
+      return config.get(value);
+    }
+    @Override
+    public String get(String value, String defaultValue) {
+      return config.get(value,defaultValue);
+    }
+    @Override
+    public String getMandatory(String name)
+        throws MissingMandatoryParameterException {
+      return config.getMandatory(name);
+    }
+    @Override
+    public String getConfigFilePath() {
+      return config.getConfigFilePath();
+    }
+  }
+
+  /**
+   * Provides configuration documentation -- mostly for diagnosing problems   
+   */
+  @Override
+  public List<String> documentConfiguration() {
+    List<String> doc = new ArrayList<String>();
+    doc.add(nl+ MODULENAME + " was configured to access Pazpar2 at : " + cfg.PAZPAR2_URL);    
+    return new ArrayList<String>();
+  }
+  
+  public Configuration getConfiguration () {
+    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());      
+    }
+  }
+
+}