src/main/java/com/indexdata/mkjsf/pazpar2/Pz2Client.java

   1 package com.indexdata.mkjsf.pazpar2;\r
   2 \r
   3 import static com.indexdata.mkjsf.utils.Utils.nl;\r
   4 \r
   5 import java.io.ByteArrayOutputStream;\r
   6 import java.io.IOException;\r
   7 import java.util.ArrayList;\r
   8 import java.util.HashMap;\r
   9 import java.util.List;\r
  10 import java.util.Map;\r
  11 \r
  12 import org.apache.log4j.Logger;\r
  13 \r
  14 import com.indexdata.masterkey.config.MissingMandatoryParameterException;\r
  15 import com.indexdata.masterkey.config.ModuleConfigurationGetter;\r
  16 import com.indexdata.masterkey.pazpar2.client.ClientCommand;\r
  17 import com.indexdata.masterkey.pazpar2.client.Pazpar2Client;\r
  18 import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration;\r
  19 import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric;\r
  20 import com.indexdata.masterkey.pazpar2.client.Pazpar2HttpResponse;\r
  21 import com.indexdata.masterkey.pazpar2.client.exceptions.Pazpar2ErrorException;\r
  22 import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException;\r
  23 import com.indexdata.mkjsf.config.Configuration;\r
  24 import com.indexdata.mkjsf.config.ConfigurationReader;\r
  25 import com.indexdata.mkjsf.errors.ConfigurationException;\r
  26 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;\r
  27 import com.indexdata.mkjsf.pazpar2.data.CommandError;\r
  28 import com.indexdata.mkjsf.utils.Utils;\r
  29 \r
  30 public class Pz2Client implements SearchClient {\r
  31 \r
  32   private static final long serialVersionUID = 5414266730169982028L;\r
  33   private static Logger logger = Logger.getLogger(Pz2Client.class);\r
  34   private transient Pazpar2Client client = null;\r
  35   private Pazpar2ClientConfiguration cfg = null;\r
  36   public static final String MODULENAME = "pz2client";\r
  37   public static Map<String,String> DEFAULTS = new HashMap<String,String>();\r
  38   Configuration config = null;  \r
  39   \r
  40   static {    \r
  41     DEFAULTS.put("PAZPAR2_URL", "");\r
  42     DEFAULTS.put("PROXY_MODE","1");\r
  43     DEFAULTS.put("SERIALIZE_REQUESTS", "false");\r
  44     DEFAULTS.put("STREAMBUFF_SIZE", "4096");\r
  45     DEFAULTS.put("PARSE_RESPONSES", "true");    \r
  46   }\r
  47   \r
  48   public Pz2Client() {}\r
  49   \r
  50   @Override\r
  51   public void configure(ConfigurationReader configReader) throws ConfigurationException {    \r
  52     logger.info(Utils.objectId(this) + " is configuring using the provided " + Utils.objectId(configReader));\r
  53     try {\r
  54       config = configReader.getConfiguration(this);      \r
  55       cfg = new Pazpar2ClientConfiguration(new ConfigurationGetter(config));\r
  56     } catch (ProxyErrorException pe) {\r
  57       logger.error("Could not configure Pazpar2 client: " + pe.getMessage());\r
  58       throw new ConfigurationException("Could not configure Pz2Client:  "+ pe.getMessage(),pe);\r
  59     } \r
  60     if (cfg != null) {\r
  61       try {\r
  62         client = new Pazpar2ClientGeneric(cfg);  \r
  63       } catch (ProxyErrorException pe) {\r
  64         logger.error("Could not configure Pazpar2 client: " + pe.getMessage());\r
  65         throw new ConfigurationException("Could not configure Pz2Client:  "+ pe.getMessage(),pe);\r
  66       }\r
  67     } else {\r
  68       logger.error("There was a problem creating Pz2Client. Client is null after configuration.");\r
  69       throw new ConfigurationException("Pazpar2Client is null after configuration");\r
  70     } \r
  71   }\r
  72   \r
  73   public boolean isAuthenticatingClient () {\r
  74     return false;\r
  75   }\r
  76   \r
  77   public boolean isAuthenticated() {\r
  78     return false;\r
  79   }\r
  80   \r
  81   public boolean authenticate() {\r
  82     throw new UnsupportedOperationException("No authentication mechanism for straight pazpar2 client");\r
  83   }\r
  84   \r
  85   @Override\r
  86   public void setSearchCommand(Pazpar2Command command) {\r
  87     ClientCommand clientCommand = new ClientCommand(command.getCommandName(), command.getEncodedQueryString());\r
  88     client.setSearchCommand(clientCommand);    \r
  89   }\r
  90 \r
  91   @Override\r
  92   public HttpResponseWrapper executeCommand(Pazpar2Command command) {\r
  93     ClientCommandResponse commandResponse = null;\r
  94     ByteArrayOutputStream baos = new ByteArrayOutputStream();\r
  95     ClientCommand clientCommand = new ClientCommand(command.getCommandName(), command.getEncodedQueryString());\r
  96     Pazpar2HttpResponse pz2HttpResponse = null;\r
  97     long start = System.currentTimeMillis();\r
  98     try {\r
  99       pz2HttpResponse = client.executeCommand(clientCommand, baos);\r
 100       if (pz2HttpResponse.getStatusCode()==200 && pz2HttpResponse.getContentType().contains("xml")) {\r
 101         commandResponse = new ClientCommandResponse(pz2HttpResponse,baos);\r
 102       } else if (pz2HttpResponse.getStatusCode()==417) {\r
 103         logger.error("Pazpar2 status code 417: " + baos.toString("UTF-8"));\r
 104         commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()) ,"Pazpar2: Expectation failed (417)", baos.toString("UTF-8")),"text/xml");                       \r
 105       } else if (pz2HttpResponse.getContentType().contains("html")) {\r
 106         String resp = baos.toString("UTF-8");\r
 107         logger.error("HTML response where XML was expected. Status code was " + pz2HttpResponse.getStatusCode() + ": " + resp);\r
 108         String htmlStrippedOfTags = resp.replaceAll("\\<[^>]*>","");\r
 109         String errorXml = "";\r
 110         if (htmlStrippedOfTags.toLowerCase().contains("domain")) {\r
 111           errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "Error: Expected XML response from Pazpar2, got HTML with the word domain. Could be unrecognized address for Pazpar2.", htmlStrippedOfTags);\r
 112         } else {  \r
 113           errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "Error: Expected XML response from Pazpar2, got HTML", htmlStrippedOfTags);\r
 114         } \r
 115         commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),errorXml,"text/xml");        \r
 116       } else {\r
 117         String resp = baos.toString("UTF-8");\r
 118         logger.error("Pazpar2 status code was " + pz2HttpResponse.getStatusCode() + ": " + resp);\r
 119         commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "Pazpar2 error occurred", baos.toString("UTF-8")),"text/xml");        \r
 120       }       \r
 121     } catch (IOException e) {\r
 122       logger.error(e.getMessage());\r
 123       e.printStackTrace();\r
 124       commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.createErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "io", e.getMessage()),"text/xml");      \r
 125     } catch (Pazpar2ErrorException e) {\r
 126       logger.error(e.getMessage());\r
 127       e.printStackTrace();\r
 128       logger.error("Creating error XML");\r
 129       commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml(command.getCommandName(), "-1", "Pazpar2Error", e.getMessage()),"text/xml");\r
 130     }\r
 131     long end = System.currentTimeMillis();      \r
 132     logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );\r
 133     return commandResponse;\r
 134   }\r
 135 \r
 136   public Pz2Client cloneMe() {\r
 137     logger.debug("Cloning Pz2Client");\r
 138     Pz2Client clone = new Pz2Client();\r
 139     clone.client = this.client;\r
 140     clone.cfg = this.cfg;\r
 141     return clone;\r
 142   }\r
 143 \r
 144   @Override\r
 145   public Map<String, String> getDefaults() {\r
 146     return DEFAULTS;\r
 147   }\r
 148 \r
 149   @Override\r
 150   public String getModuleName() {\r
 151     return MODULENAME;\r
 152   }\r
 153   \r
 154   class ConfigurationGetter implements ModuleConfigurationGetter {\r
 155     Configuration config = null;\r
 156     ConfigurationGetter(Configuration configuration) {\r
 157       config = configuration;\r
 158     }\r
 159     @Override\r
 160     public String get(String value) {\r
 161       return config.get(value);\r
 162     }\r
 163     @Override\r
 164     public String get(String value, String defaultValue) {\r
 165       return config.get(value,defaultValue);\r
 166     }\r
 167     @Override\r
 168     public String getMandatory(String name)\r
 169         throws MissingMandatoryParameterException {\r
 170       return config.getMandatory(name);\r
 171     }\r
 172     @Override\r
 173     public String getConfigFilePath() {\r
 174       return config.getConfigFilePath();\r
 175     }\r
 176   }\r
 177 \r
 178   @Override\r
 179   public List<String> documentConfiguration() {\r
 180     List<String> doc = new ArrayList<String>();\r
 181     doc.add(nl+ MODULENAME + " was configured to access Pazpar2 at : " + cfg.PAZPAR2_URL);    \r
 182     return new ArrayList<String>();\r
 183   }\r
 184   \r
 185   public Configuration getConfiguration () {\r
 186     return config;\r
 187   }\r
 188 \r
 189   @Override\r
 190   public String getServiceUrl() {\r
 191     return cfg.PAZPAR2_URL;    \r
 192   }\r
 193 \r
 194   @Override\r
 195   public boolean hasServiceUrl() {\r
 196     return cfg.PAZPAR2_URL != null && cfg.PAZPAR2_URL.length()>0;\r
 197   }\r
 198   \r
 199   @Override \r
 200   public void setServiceUrl (String serviceUrl) {    \r
 201     cfg.PAZPAR2_URL = serviceUrl;\r
 202     \r
 203   }\r
 204 \r
 205 }\r