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