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()==200 && pz2HttpResponse.getContentType().contains("octet-stream")) {\r
 103         commandResponse = new ClientCommandResponse(pz2HttpResponse,baos);\r
 104         logger.info("Content type: " + commandResponse.getContentType() + ". isBinary?: " + commandResponse.isBinary());\r
 105       } else if (pz2HttpResponse.getStatusCode()==417) {\r
 106         logger.error("Pazpar2 status code 417: " + baos.toString("UTF-8"));\r
 107         commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()) ,"Pazpar2: Expectation failed (417)", baos.toString("UTF-8")),"text/xml");                       \r
 108       } else if (pz2HttpResponse.getContentType().contains("html")) {\r
 109         String resp = baos.toString("UTF-8");\r
 110         logger.error("HTML response where XML was expected. Status code was " + pz2HttpResponse.getStatusCode() + ": " + resp);\r
 111         String htmlStrippedOfTags = resp.replaceAll("\\<[^>]*>","");\r
 112         String errorXml = "";\r
 113         if (htmlStrippedOfTags.toLowerCase().contains("domain")) {\r
 114           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);\r
 115         } else {  \r
 116           errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "Unexpected response type from Pazpar2: " + pz2HttpResponse.getContentType(),"Expected XML response from Pazpar2, got HTML", htmlStrippedOfTags);\r
 117         } \r
 118         commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),errorXml,pz2HttpResponse.getContentType());        \r
 119       } else {\r
 120         String resp = baos.toString("UTF-8");\r
 121         logger.error("Pazpar2 status code was " + pz2HttpResponse.getStatusCode() + ": " + resp);\r
 122         commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "Pazpar2 error occurred", baos.toString("UTF-8")),"text/xml");        \r
 123       }       \r
 124     } catch (IOException e) {\r
 125       logger.error(e.getMessage());\r
 126       e.printStackTrace();\r
 127       commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.createErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "IO exception", e.getMessage(), ""),"text/xml");      \r
 128     } catch (Pazpar2ErrorException e) {\r
 129       logger.error(e.getMessage());\r
 130       e.printStackTrace();\r
 131       logger.error("Creating error XML");\r
 132       commandResponse = new ClientCommandResponse(0,CommandError.createErrorXml(command.getCommandName(), "", "ServiceError", e.getMessage(),""),"text/xml");\r
 133     }\r
 134     long end = System.currentTimeMillis();      \r
 135     logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );\r
 136     return commandResponse;\r
 137   }\r
 138 \r
 139   public Pz2Client cloneMe() {\r
 140     logger.debug("Cloning Pz2Client");\r
 141     Pz2Client clone = new Pz2Client();\r
 142     clone.client = this.client;\r
 143     clone.cfg = this.cfg;\r
 144     return clone;\r
 145   }\r
 146 \r
 147   @Override\r
 148   public Map<String, String> getDefaults() {\r
 149     return DEFAULTS;\r
 150   }\r
 151 \r
 152   @Override\r
 153   public String getModuleName() {\r
 154     return MODULENAME;\r
 155   }\r
 156   \r
 157   class ConfigurationGetter implements ModuleConfigurationGetter {\r
 158     Configuration config = null;\r
 159     ConfigurationGetter(Configuration configuration) {\r
 160       config = configuration;\r
 161     }\r
 162     @Override\r
 163     public String get(String value) {\r
 164       return config.get(value);\r
 165     }\r
 166     @Override\r
 167     public String get(String value, String defaultValue) {\r
 168       return config.get(value,defaultValue);\r
 169     }\r
 170     @Override\r
 171     public String getMandatory(String name)\r
 172         throws MissingMandatoryParameterException {\r
 173       return config.getMandatory(name);\r
 174     }\r
 175     @Override\r
 176     public String getConfigFilePath() {\r
 177       return config.getConfigFilePath();\r
 178     }\r
 179   }\r
 180 \r
 181   @Override\r
 182   public List<String> documentConfiguration() {\r
 183     List<String> doc = new ArrayList<String>();\r
 184     doc.add(nl+ MODULENAME + " was configured to access Pazpar2 at : " + cfg.PAZPAR2_URL);    \r
 185     return new ArrayList<String>();\r
 186   }\r
 187   \r
 188   public Configuration getConfiguration () {\r
 189     return config;\r
 190   }\r
 191 \r
 192   @Override\r
 193   public String getServiceUrl() {\r
 194     return cfg.PAZPAR2_URL;    \r
 195   }\r
 196 \r
 197   @Override\r
 198   public boolean hasServiceUrl() {\r
 199     return cfg.PAZPAR2_URL != null && cfg.PAZPAR2_URL.length()>0;\r
 200   }\r
 201   \r
 202   @Override \r
 203   public void setServiceUrl (String serviceUrl) {    \r
 204     cfg.PAZPAR2_URL = serviceUrl;    \r
 205   }\r
 206   \r
 207   public String getServiceId () {\r
 208     return cfg.PAZPAR2_SERVICE_ID;\r
 209   }\r
 210   \r
 211   public void setServiceId(String serviceId) {\r
 212     cfg.PAZPAR2_SERVICE_ID = serviceId;\r
 213     try {\r
 214       client = new Pazpar2ClientGeneric(cfg);  \r
 215     } catch (ProxyErrorException pe) {\r
 216       logger.error("Could not configure Pazpar2 client: " + pe.getMessage());      \r
 217     }\r
 218   }\r
 219 \r
 220 }\r