src/main/java/com/indexdata/mkjsf/pazpar2/ServiceProxyClient.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.BufferedReader;\r
   6 import java.io.File;\r
   7 import java.io.FileReader;\r
   8 import java.io.IOException;\r
   9 import java.util.ArrayList;\r
  10 import java.util.HashMap;\r
  11 import java.util.List;\r
  12 import java.util.Map;\r
  13 \r
  14 import org.apache.http.Header;\r
  15 import org.apache.http.HttpEntity;\r
  16 import org.apache.http.HttpResponse;\r
  17 import org.apache.http.StatusLine;\r
  18 import org.apache.http.client.ClientProtocolException;\r
  19 import org.apache.http.client.HttpClient;\r
  20 import org.apache.http.client.ResponseHandler;\r
  21 import org.apache.http.client.methods.HttpGet;\r
  22 import org.apache.http.client.methods.HttpPost;\r
  23 import org.apache.http.conn.ClientConnectionManager;\r
  24 import org.apache.http.conn.scheme.PlainSocketFactory;\r
  25 import org.apache.http.conn.scheme.Scheme;\r
  26 import org.apache.http.conn.scheme.SchemeRegistry;\r
  27 import org.apache.http.entity.ByteArrayEntity;\r
  28 import org.apache.http.entity.FileEntity;\r
  29 import org.apache.http.impl.client.DefaultHttpClient;\r
  30 import org.apache.http.impl.conn.PoolingClientConnectionManager;\r
  31 import org.apache.http.util.EntityUtils;\r
  32 import org.apache.log4j.Logger;\r
  33 \r
  34 import com.indexdata.mkjsf.config.Configuration;\r
  35 import com.indexdata.mkjsf.config.ConfigurationReader;\r
  36 import com.indexdata.mkjsf.errors.ConfigurationException;\r
  37 import com.indexdata.mkjsf.pazpar2.commands.CommandParameter;\r
  38 import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;\r
  39 import com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand;\r
  40 import com.indexdata.mkjsf.pazpar2.data.CommandError;\r
  41 import com.indexdata.mkjsf.utils.Utils;\r
  42 \r
  43 public class ServiceProxyClient implements SearchClient {\r
  44     \r
  45   private static final long serialVersionUID = -4031644009579840277L;\r
  46   private static Logger logger = Logger.getLogger(ServiceProxyClient.class);\r
  47   public static final String MODULENAME = "proxyclient";\r
  48   \r
  49   public static final String SP_INIT_DOC_PATHS = "SP_INIT_DOC_PATHS";\r
  50   private String serviceUrl = "";\r
  51   \r
  52   private List<String> initDocPaths = null;\r
  53   private Configuration config = null;\r
  54   \r
  55   ProxyPz2ResponseHandler handler = new ProxyPz2ResponseHandler();\r
  56   private transient HttpClient client;  \r
  57   private Pazpar2Command checkAuth = null;\r
  58   private Pazpar2Command ipAuth = null;\r
  59 \r
  60   public ServiceProxyClient () {\r
  61     SchemeRegistry schemeRegistry = new SchemeRegistry();\r
  62     schemeRegistry.register(new Scheme("http", 80, PlainSocketFactory.getSocketFactory()));\r
  63     ClientConnectionManager cm = new PoolingClientConnectionManager(schemeRegistry);\r
  64     client = new DefaultHttpClient(cm);\r
  65   }\r
  66     \r
  67   @Override\r
  68   public void configure (ConfigurationReader configReader) {\r
  69     logger.info(Utils.objectId(this) + " is configuring using the provided " + Utils.objectId(configReader));\r
  70     try {\r
  71       config = configReader.getConfiguration(this);      \r
  72       serviceUrl = config.get("SERVICE_PROXY_URL");\r
  73       this.initDocPaths = config.getMultiProperty(SP_INIT_DOC_PATHS,",");\r
  74       checkAuth = new AuthCommand(null);\r
  75       checkAuth.setParameterInState(new CommandParameter("action","=","check"));\r
  76       ipAuth = new AuthCommand(null);\r
  77       ipAuth.setParameterInState(new CommandParameter("action","=","ipauth"));\r
  78     } catch (ConfigurationException c) {\r
  79       // TODO: \r
  80       c.printStackTrace();\r
  81     }    \r
  82   }\r
  83     \r
  84   public boolean isAuthenticatingClient () {\r
  85     return true;\r
  86   }\r
  87     \r
  88   /**\r
  89    * Makes the request\r
  90    * @param request\r
  91    * @return HTTP response as a String\r
  92    * @throws ClientProtocolException\r
  93    * @throws IOException\r
  94    */\r
  95   public ClientCommandResponse send(Pazpar2Command command) {\r
  96     ClientCommandResponse commandResponse = null;\r
  97     String url = serviceUrl + "?" + command.getEncodedQueryString(); \r
  98     logger.info("Sending request "+url);    \r
  99     HttpGet httpget = new HttpGet(url);     \r
 100     byte[] response = null;\r
 101     try {\r
 102       response = client.execute(httpget, handler);\r
 103       if (handler.getStatusCode()==200 && handler.getContentType().contains("xml")) {\r
 104         commandResponse = new ClientCommandResponse(handler.getStatusCode(),response,handler.getContentType());\r
 105       } else {\r
 106         logger.error("Service Proxy status code: " + handler.getStatusCode());\r
 107         String errorXml = "";\r
 108         if (handler.getContentType().contains("xml")) {\r
 109           errorXml = CommandError.insertErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Service Proxy error: "+handler.getStatusCode(), new String(response,"UTF-8"));          \r
 110         } else {\r
 111           if (handler.getContentType().contains("html")) {\r
 112             String htmlStrippedOfTags = (new String(response,"UTF-8")).replaceAll("\\<[^>]*>","");\r
 113             if (htmlStrippedOfTags.toLowerCase().contains("domain")) {\r
 114               errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Error: Expected XML response from Service Proxy, got HTML with word 'domain' in, probably domain not found.", htmlStrippedOfTags);              \r
 115             } else {\r
 116               errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Error: Expected XML response from Service Proxy, got HTML", htmlStrippedOfTags);              \r
 117             }\r
 118           } else {\r
 119             errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Error: Expected XML response from Service Proxy, got: "+handler.getContentType(), new String(response,"UTF-8"));\r
 120           }\r
 121           commandResponse = new ClientCommandResponse(handler.getStatusCode(),errorXml,handler.getContentType());\r
 122         }\r
 123       }       \r
 124     } catch (Exception e) {\r
 125       e.printStackTrace();\r
 126       commandResponse = new ClientCommandResponse(handler.getStatusCode(),CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), e.getClass().getSimpleName(), (e.getMessage()!= null ? e.getMessage() : "") + (e.getCause()!=null ? e.getCause().getMessage() : "")),handler.getContentType());\r
 127     }\r
 128     return commandResponse; \r
 129   }\r
 130   \r
 131   public class ProxyPz2ResponseHandler implements ResponseHandler<byte[]> {\r
 132     private StatusLine statusLine = null;\r
 133     private Header contentType = null;\r
 134     public byte[] handleResponse(HttpResponse response) throws ClientProtocolException, IOException {\r
 135       byte[] resp = null;\r
 136       HttpEntity entity = response.getEntity();      \r
 137       statusLine = response.getStatusLine();\r
 138       if (entity != null) {        \r
 139         resp = EntityUtils.toByteArray(entity);        \r
 140         contentType = response.getEntity().getContentType();        \r
 141       }       \r
 142       EntityUtils.consume(entity);      \r
 143       return resp;\r
 144     }\r
 145     public int getStatusCode() {\r
 146       return statusLine.getStatusCode();\r
 147     }    \r
 148     public String getReasonPhrase() {\r
 149       return statusLine.getReasonPhrase();\r
 150     }\r
 151     public String getContentType () {\r
 152       return (contentType != null ? contentType.getValue() : "Content-Type not known"); \r
 153     }\r
 154   }\r
 155 \r
 156   public int getStatusCode () {\r
 157     return handler.getStatusCode();\r
 158   }\r
 159   \r
 160   public String getReasonPhrase() {\r
 161     return handler.getReasonPhrase();\r
 162   }\r
 163 \r
 164   @Override\r
 165   public void setSearchCommand(Pazpar2Command command) {\r
 166     // Do nothing, Service Proxy is handling this    \r
 167   }\r
 168 \r
 169   @Override\r
 170   public HttpResponseWrapper executeCommand(Pazpar2Command command) {\r
 171     return send(command);\r
 172   }\r
 173 \r
 174   public ServiceProxyClient cloneMe() {\r
 175     logger.debug("Cloning Pz2Client");\r
 176     ServiceProxyClient clone = new ServiceProxyClient();\r
 177     clone.client = this.client;\r
 178     clone.serviceUrl = this.serviceUrl;\r
 179     clone.initDocPaths = this.initDocPaths;\r
 180     return clone;\r
 181   }\r
 182 \r
 183   @Override\r
 184   public Map<String, String> getDefaults() {    \r
 185     return new HashMap<String,String>();\r
 186   }\r
 187 \r
 188   @Override\r
 189   public String getModuleName() {\r
 190     return MODULENAME;\r
 191   }\r
 192   \r
 193   @Override\r
 194   public List<String> documentConfiguration () {\r
 195     List<String> doc = new ArrayList<String>();\r
 196     doc.add(nl+ MODULENAME + " was configured to access the Pazpar2 service proxy at: " + (serviceUrl.length()>0 ? serviceUrl : "[not defined yet]"));\r
 197     return null;\r
 198   }\r
 199   \r
 200   public ClientCommandResponse postInitDoc (String filePath) throws IOException {\r
 201     logger.info("Looking to post the file in : [" + filePath +"]");\r
 202     HttpPost post = new HttpPost(serviceUrl+"?command=init&includeDebug=yes");\r
 203     File initDoc = new File(filePath);\r
 204     logger.info("Posting to SP: ");\r
 205     if (logger.isDebugEnabled()) {\r
 206       BufferedReader reader = new BufferedReader(new FileReader(initDoc));\r
 207       String line;\r
 208       while ( (line = reader.readLine()) != null) {\r
 209         System.out.println(line);\r
 210       }\r
 211       reader.close();\r
 212     }\r
 213     post.setEntity(new FileEntity(initDoc));\r
 214     byte[] response = client.execute(post, handler);\r
 215     logger.debug("Response on POST was: " + new String(response,"UTF-8"));    \r
 216     return new ClientCommandResponse(handler.getStatusCode(),response,handler.getContentType());    \r
 217   }\r
 218   \r
 219   public List<String> getInitDocPaths () {\r
 220     logger.debug("Get init doc paths ");\r
 221     logger.debug("length: " + initDocPaths.size());\r
 222     return initDocPaths;\r
 223   }\r
 224   \r
 225   public HttpResponseWrapper postInitDoc(byte[] initDoc, boolean includeDebug) {\r
 226     HttpPost post = new HttpPost(serviceUrl+"?command=init" + (includeDebug? "&includeDebug=yes" : ""));\r
 227     post.setEntity(new ByteArrayEntity(initDoc));\r
 228     ClientCommandResponse commandResponse = null;\r
 229     byte[] response;\r
 230     try {\r
 231       response = client.execute(post, handler);\r
 232       if (handler.getStatusCode()==200) {\r
 233         commandResponse = new ClientCommandResponse(handler.getStatusCode(),response,handler.getContentType());\r
 234       } else {\r
 235         logger.error("Service Proxy status code: " + handler.getStatusCode());\r
 236         commandResponse = new ClientCommandResponse(handler.getStatusCode(),CommandError.insertErrorXml("init", String.valueOf(handler.getStatusCode()), "Service Proxy error: "+handler.getStatusCode(), new String(response,"UTF-8")),"text/xml");                               \r
 237       }\r
 238     } catch (ClientProtocolException e) {\r
 239       logger.error(e.getMessage());\r
 240       e.printStackTrace();\r
 241       commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml("init", String.valueOf(handler.getStatusCode()), "client protocol exception", e.getMessage()),"text/xml");      \r
 242     } catch (IOException e) {\r
 243       logger.error(e.getMessage());\r
 244       e.printStackTrace();\r
 245       commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml("init", String.valueOf(handler.getStatusCode()), "IO", e.getMessage()),"text/xml");      \r
 246     }\r
 247     return commandResponse;    \r
 248   }\r
 249   \r
 250   public void setServiceUrl (String url) {    \r
 251     serviceUrl = url;\r
 252   }\r
 253           \r
 254   public Configuration getConfiguration () {\r
 255     return config;\r
 256   }\r
 257 \r
 258   @Override\r
 259   public String getServiceUrl() {    \r
 260     return serviceUrl;\r
 261   }\r
 262 \r
 263   @Override\r
 264   public boolean hasServiceUrl() {\r
 265     return serviceUrl != null && serviceUrl.length()>0;\r
 266   }\r
 267   \r
 268 }\r