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("PROXY_MODE","1");\r
  42     DEFAULTS.put("SERIALIZE_REQUESTS", "false");\r
  43     DEFAULTS.put("STREAMBUFF_SIZE", "4096");\r
  44     DEFAULTS.put("PARSE_RESPONSES", "true");    \r
  45   }\r
  46   \r
  47   public Pz2Client() {}\r
  48   \r
  49   @Override\r
  50   public void configure(ConfigurationReader configReader) throws ConfigurationException {    \r
  51     logger.info(Utils.objectId(this) + " is configuring using the provided " + Utils.objectId(configReader));\r
  52     try {\r
  53       config = configReader.getConfiguration(this);\r
  54       cfg = new Pazpar2ClientConfiguration(new ConfigurationGetter(config));\r
  55     } catch (ProxyErrorException pe) {\r
  56       logger.error("Could not configure Pazpar2 client: " + pe.getMessage());\r
  57       throw new ConfigurationException("Could not configure Pz2Client:  "+ pe.getMessage(),pe);\r
  58     } \r
  59     if (cfg != null) {\r
  60       try {\r
  61         client = new Pazpar2ClientGeneric(cfg);  \r
  62       } catch (ProxyErrorException pe) {\r
  63         logger.error("Could not configure Pazpar2 client: " + pe.getMessage());\r
  64         throw new ConfigurationException("Could not configure Pz2Client:  "+ pe.getMessage(),pe);\r
  65       }\r
  66     } else {\r
  67       logger.error("There was a problem creating Pz2Client. Client is null after configuration.");\r
  68       throw new ConfigurationException("Pazpar2Client is null after configuration");\r
  69     } \r
  70   }\r
  71   \r
  72   public boolean isAuthenticatingClient () {\r
  73     return false;\r
  74   }\r
  75   \r
  76   public boolean isAuthenticated() {\r
  77     return false;\r
  78   }\r
  79   \r
  80   public boolean authenticate() {\r
  81     throw new UnsupportedOperationException("No authentication mechanism for straight pazpar2 client");\r
  82   }\r
  83   \r
  84   @Override\r
  85   public void setSearchCommand(Pazpar2Command command) {\r
  86     ClientCommand clientCommand = new ClientCommand(command.getCommandName(), command.getEncodedQueryString());\r
  87     client.setSearchCommand(clientCommand);    \r
  88   }\r
  89 \r
  90   @Override\r
  91   public CommandResponse executeCommand(Pazpar2Command command) {\r
  92     Pz2CommandResponse commandResponse = null;\r
  93     ByteArrayOutputStream baos = new ByteArrayOutputStream();\r
  94     ClientCommand clientCommand = new ClientCommand(command.getCommandName(), command.getEncodedQueryString());\r
  95     Pazpar2HttpResponse pz2HttpResponse = null;\r
  96     long start = System.currentTimeMillis();\r
  97     try {\r
  98       pz2HttpResponse = client.executeCommand(clientCommand, baos);\r
  99       if (pz2HttpResponse.getStatusCode()==200) {\r
 100         commandResponse = new Pz2CommandResponse(pz2HttpResponse,baos);\r
 101       } else if (pz2HttpResponse.getStatusCode()==417) {\r
 102         logger.error("Pazpar2 status code 417: " + baos.toString("UTF-8"));\r
 103         commandResponse = new Pz2CommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertPazpar2ErrorXml(command.getCommandName(), "Pazpar2: Expectation failed (417)", baos.toString("UTF-8")),"text/xml");                       \r
 104       } else {\r
 105         String resp = baos.toString("UTF-8");\r
 106         logger.error("Pazpar2 status code was " + pz2HttpResponse.getStatusCode() + ": " + resp);\r
 107         commandResponse = new Pz2CommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertPazpar2ErrorXml(command.getCommandName(), "Pazpar2 error occurred", baos.toString("UTF-8")),"text/xml");\r
 108         throw new Pazpar2ErrorException(resp,pz2HttpResponse.getStatusCode(),resp,null);\r
 109       }       \r
 110     } catch (IOException e) {\r
 111       logger.error(e.getMessage());\r
 112       e.printStackTrace();\r
 113       commandResponse = new Pz2CommandResponse(-1,CommandError.createErrorXml(command.getCommandName(), "io", e.getMessage()),"text/xml");      \r
 114     } catch (Pazpar2ErrorException e) {\r
 115       logger.error(e.getMessage());\r
 116       e.printStackTrace();\r
 117       logger.error("Creating error XML");\r
 118       commandResponse = new Pz2CommandResponse(-1,CommandError.createErrorXml(command.getCommandName(), "io", e.getMessage()),"text/xml");\r
 119     }\r
 120     long end = System.currentTimeMillis();      \r
 121     logger.debug("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );\r
 122     return commandResponse;\r
 123   }\r
 124 \r
 125   public Pz2Client cloneMe() {\r
 126     logger.debug("Cloning Pz2Client");\r
 127     Pz2Client clone = new Pz2Client();\r
 128     clone.client = this.client;\r
 129     clone.cfg = this.cfg;\r
 130     return clone;\r
 131   }\r
 132 \r
 133   @Override\r
 134   public Map<String, String> getDefaults() {\r
 135     return DEFAULTS;\r
 136   }\r
 137 \r
 138   @Override\r
 139   public String getModuleName() {\r
 140     return MODULENAME;\r
 141   }\r
 142   \r
 143   class ConfigurationGetter implements ModuleConfigurationGetter {\r
 144     Configuration config = null;\r
 145     ConfigurationGetter(Configuration configuration) {\r
 146       config = configuration;\r
 147     }\r
 148     @Override\r
 149     public String get(String value) {\r
 150       return config.get(value);\r
 151     }\r
 152     @Override\r
 153     public String get(String value, String defaultValue) {\r
 154       return config.get(value,defaultValue);\r
 155     }\r
 156     @Override\r
 157     public String getMandatory(String name)\r
 158         throws MissingMandatoryParameterException {\r
 159       return config.getMandatory(name);\r
 160     }\r
 161     @Override\r
 162     public String getConfigFilePath() {\r
 163       return config.getConfigFilePath();\r
 164     }\r
 165   }\r
 166 \r
 167   @Override\r
 168   public List<String> documentConfiguration() {\r
 169     List<String> doc = new ArrayList<String>();\r
 170     doc.add(nl+ MODULENAME + " was configured to access Pazpar2 at : " + cfg.PAZPAR2_URL);    \r
 171     return new ArrayList<String>();\r
 172   }\r
 173   \r
 174   public Configuration getConfiguration () {\r
 175     return config;\r
 176   }\r
 177 \r
 178 }\r