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