import com.indexdata.mkjsf.config.Configuration;\r
import com.indexdata.mkjsf.config.ConfigurationReader;\r
import com.indexdata.mkjsf.errors.ConfigurationException;\r
+import com.indexdata.mkjsf.errors.MissingConfigurationContextException;\r
import com.indexdata.mkjsf.pazpar2.commands.CommandParameter;\r
import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;\r
import com.indexdata.mkjsf.pazpar2.commands.sp.AuthCommand;\r
import com.indexdata.mkjsf.pazpar2.data.CommandError;\r
-import com.indexdata.mkjsf.pazpar2.sp.auth.ServiceProxyUser;\r
import com.indexdata.mkjsf.utils.Utils;\r
\r
+/**\r
+ * Search client handling Service Proxy requests. \r
+ * \r
+ * <h3>Configuration</h3>\r
+ *\r
+ * Configuration name: proxyclient\r
+ * \r
+ * <p>When configuring the client using the Mk2Config scheme, this is the prefix to\r
+ * use in the .properties file. When using web.xml context parameters for configuration\r
+ * the configuration name has no effect.</p> \r
+ * \r
+ * <p>ServiceProxyClient will acknowledge following configuration parameters:\r
+ * \r
+ * <ul>\r
+ * <li>(proxyclient.)SERVICE_PROXY_URL</li>\r
+ * </ul> \r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
public class ServiceProxyClient implements SearchClient {\r
\r
private static final long serialVersionUID = -4031644009579840277L;\r
public static final String MODULENAME = "proxyclient";\r
\r
public static final String SP_INIT_DOC_PATHS = "SP_INIT_DOC_PATHS";\r
- private String selectedServiceUrl = "";\r
+ private String serviceUrl = "";\r
\r
private List<String> initDocPaths = null;\r
private Configuration config = null;\r
}\r
\r
@Override\r
- public void configure (ConfigurationReader configReader) {\r
+ public void configure (ConfigurationReader configReader) throws MissingConfigurationContextException {\r
logger.info(Utils.objectId(this) + " is configuring using the provided " + Utils.objectId(configReader));\r
try {\r
config = configReader.getConfiguration(this); \r
- selectedServiceUrl = config.get("SERVICE_PROXY_URL");\r
+ serviceUrl = config.get("SERVICE_PROXY_URL");\r
this.initDocPaths = config.getMultiProperty(SP_INIT_DOC_PATHS,",");\r
- checkAuth = new AuthCommand(null);\r
+ checkAuth = new AuthCommand();\r
checkAuth.setParameterInState(new CommandParameter("action","=","check"));\r
- ipAuth = new AuthCommand(null);\r
+ ipAuth = new AuthCommand();\r
ipAuth.setParameterInState(new CommandParameter("action","=","ipauth"));\r
- } catch (ConfigurationException c) {\r
- // TODO: \r
- c.printStackTrace();\r
- } \r
- }\r
- \r
- \r
- public boolean authenticate (ServiceProxyUser user) {\r
- logger.info("Authenticating [" + user.getProperty("name") + "]"); \r
- Pazpar2Command auth = new AuthCommand(null);\r
- auth.setParametersInState(new CommandParameter("action","=","login"), \r
- new CommandParameter("username","=",user.getProperty("name")), \r
- new CommandParameter("password","=",user.getProperty("password"))); \r
- ClientCommandResponse commandResponse = send(auth);\r
- String responseStr = commandResponse.getResponseString();\r
- logger.info(responseStr); \r
- if (responseStr.contains("FAIL")) {\r
- user.credentialsAuthenticationSucceeded(false);\r
- return false;\r
- } else {\r
- user.credentialsAuthenticationSucceeded(true);\r
- return true;\r
- } \r
- }\r
- \r
- public boolean checkAuthentication (ServiceProxyUser user) { \r
- ClientCommandResponse commandResponse = send(checkAuth); \r
- String responseStr = commandResponse.getResponseString(); \r
- logger.info(responseStr);\r
- if (responseStr.contains("FAIL")) { \r
- user.authenticationCheckFailed();\r
- return false;\r
- } else { \r
- return true;\r
- } \r
- }\r
- \r
- public boolean ipAuthenticate (ServiceProxyUser user) {\r
- ClientCommandResponse commandResponse = send(ipAuth); \r
- String responseStr = commandResponse.getResponseString();\r
- logger.info(responseStr);\r
- if (responseStr.contains("FAIL")) {\r
- user.ipAuthenticationSucceeded(false); \r
- return false;\r
- } else {\r
- user.ipAuthenticationSucceeded(true);\r
- return true;\r
- } \r
+ } catch (MissingConfigurationContextException mcce) {\r
+ throw mcce;\r
+ } catch (ConfigurationException ce) {\r
+ logger.error("Failed to configure Service Proxy client");\r
+ ce.printStackTrace();\r
+ }\r
}\r
- \r
+ \r
public boolean isAuthenticatingClient () {\r
return true;\r
}\r
- \r
- public boolean isAuthenticated (ServiceProxyUser user) {\r
- if (user.getProperty("name") != null && user.getProperty("password") != null) {\r
- return checkAuthentication(user);\r
- } else {\r
- return false;\r
- }\r
- }\r
- \r
+ \r
/**\r
* Makes the request\r
* @param request\r
* @throws ClientProtocolException\r
* @throws IOException\r
*/\r
- private ClientCommandResponse send(Pazpar2Command command) {\r
+ public ClientCommandResponse send(Pazpar2Command command) {\r
ClientCommandResponse commandResponse = null;\r
- String url = selectedServiceUrl + "?" + command.getEncodedQueryString(); \r
+ String url = serviceUrl + "?" + command.getEncodedQueryString(); \r
logger.info("Sending request "+url); \r
HttpGet httpget = new HttpGet(url); \r
byte[] response = null;\r
try {\r
response = client.execute(httpget, handler);\r
- if (handler.getStatusCode()==200) {\r
+ if (handler.getStatusCode()==200 && (handler.getContentType().contains("xml") || handler.getContentType().contains("octet-stream"))) {\r
+ logger.trace("Creating command response holding content of type " + handler.getContentType());\r
commandResponse = new ClientCommandResponse(handler.getStatusCode(),response,handler.getContentType());\r
} else {\r
logger.error("Service Proxy status code: " + handler.getStatusCode());\r
- commandResponse = new ClientCommandResponse(handler.getStatusCode(),CommandError.insertPazpar2ErrorXml(command.getCommandName(), "Service Proxy error occurred", new String(response,"UTF-8")),"text/xml"); \r
+ String errorXml = "";\r
+ if (handler.getContentType().contains("xml")) {\r
+ errorXml = CommandError.insertErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Service Proxy error: "+handler.getStatusCode(), new String(response,"UTF-8")); \r
+ } else {\r
+ if (handler.getContentType().contains("html")) {\r
+ String htmlStrippedOfTags = (new String(response,"UTF-8")).replaceAll("\\<[^>]*>","");\r
+ if (htmlStrippedOfTags.toLowerCase().contains("domain")) {\r
+ 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
+ } else {\r
+ errorXml = CommandError.createErrorXml(command.getCommandName(), String.valueOf(handler.getStatusCode()), "Unexpected response type from Service Proxy", "Expected XML from SP but got HTML", htmlStrippedOfTags); \r
+ }\r
+ } else {\r
+ 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
+ } \r
+ }\r
+ commandResponse = new ClientCommandResponse(handler.getStatusCode(),errorXml,handler.getContentType());\r
} \r
} catch (Exception e) {\r
e.printStackTrace();\r
- commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml(command.getCommandName(), e.getClass().getSimpleName(), (e.getMessage()!= null ? e.getMessage() : "") + (e.getCause()!=null ? e.getCause().getMessage() : "")),"text/xml");\r
+ 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
}\r
return commandResponse; \r
}\r
return handler.getReasonPhrase();\r
}\r
\r
+ /**\r
+ * Does nothing in Service Proxy context\r
+ */\r
@Override\r
public void setSearchCommand(Pazpar2Command command) {\r
// Do nothing, Service Proxy is handling this \r
logger.debug("Cloning Pz2Client");\r
ServiceProxyClient clone = new ServiceProxyClient();\r
clone.client = this.client;\r
- clone.selectedServiceUrl = this.selectedServiceUrl;\r
+ clone.serviceUrl = this.serviceUrl;\r
clone.initDocPaths = this.initDocPaths;\r
return clone;\r
}\r
\r
+ /**\r
+ * Returns default configuration parameters for the client.\r
+ */\r
@Override\r
public Map<String, String> getDefaults() { \r
return new HashMap<String,String>();\r
}\r
\r
+ /**\r
+ * Returns the configuration name of the client\r
+ */\r
@Override\r
public String getModuleName() {\r
return MODULENAME;\r
@Override\r
public List<String> documentConfiguration () {\r
List<String> doc = new ArrayList<String>();\r
- doc.add(nl+ MODULENAME + " was configured to access the Pazpar2 service proxy at: " + (selectedServiceUrl.length()>0 ? selectedServiceUrl : "[not defined yet]"));\r
+ doc.add(nl+ MODULENAME + " was configured to access the Pazpar2 service proxy at: " + (serviceUrl.length()>0 ? serviceUrl : "[not defined yet]"));\r
return null;\r
}\r
\r
public ClientCommandResponse postInitDoc (String filePath) throws IOException {\r
logger.info("Looking to post the file in : [" + filePath +"]");\r
- HttpPost post = new HttpPost(selectedServiceUrl+"?command=init&includeDebug=yes");\r
+ HttpPost post = new HttpPost(serviceUrl+"?command=init&includeDebug=yes");\r
File initDoc = new File(filePath);\r
logger.info("Posting to SP: ");\r
if (logger.isDebugEnabled()) {\r
return initDocPaths;\r
}\r
\r
- public ClientCommandResponse postInitDoc(byte[] initDoc, boolean includeDebug) throws IOException {\r
- HttpPost post = new HttpPost(selectedServiceUrl+"?command=init" + (includeDebug? "&includeDebug=yes" : ""));\r
+ public HttpResponseWrapper postInitDoc(byte[] initDoc, Pazpar2Command command) {\r
+ String requestParameters = command.getEncodedQueryString();\r
+ logger.info("Initiating session with init doc and [" + requestParameters +"]");\r
+ HttpPost post = new HttpPost(serviceUrl+"?" + requestParameters);\r
post.setEntity(new ByteArrayEntity(initDoc));\r
- byte[] response = client.execute(post, handler);\r
- logger.debug("Response on POST was: " + new String(response,"UTF-8")); \r
- return new ClientCommandResponse(handler.getStatusCode(),response,handler.getContentType()); \r
+ ClientCommandResponse commandResponse = null;\r
+ byte[] response;\r
+ try {\r
+ response = client.execute(post, handler);\r
+ if (handler.getStatusCode()==200) {\r
+ commandResponse = new ClientCommandResponse(handler.getStatusCode(),response,handler.getContentType());\r
+ } else {\r
+ logger.error("Service Proxy status code: " + handler.getStatusCode());\r
+ 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
+ }\r
+ } catch (ClientProtocolException e) {\r
+ logger.error(e.getMessage());\r
+ e.printStackTrace();\r
+ commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml("init", String.valueOf(handler.getStatusCode()), "Client protocol exception", e.getMessage(), e.getStackTrace().toString()),"text/xml"); \r
+ } catch (IOException e) {\r
+ logger.error(e.getMessage());\r
+ e.printStackTrace();\r
+ commandResponse = new ClientCommandResponse(-1,CommandError.createErrorXml("init", String.valueOf(handler.getStatusCode()), "IO exception", e.getMessage(),e.getStackTrace().toString()),"text/xml"); \r
+ }\r
+ return commandResponse; \r
}\r
\r
+ /**\r
+ * Sets the URL of the Service Proxy that should service requests. \r
+ */\r
public void setServiceUrl (String url) { \r
- selectedServiceUrl = url;\r
+ serviceUrl = url;\r
}\r
\r
public Configuration getConfiguration () {\r
\r
@Override\r
public String getServiceUrl() { \r
- return selectedServiceUrl;\r
+ return serviceUrl;\r
}\r
\r
+ /**\r
+ * Returns true if a Service Proxy URL was defined yet.\r
+ */\r
@Override\r
public boolean hasServiceUrl() {\r
- return selectedServiceUrl != null && selectedServiceUrl.length()>0;\r
+ return serviceUrl != null && serviceUrl.length()>0;\r
}\r
\r
}\r
projects / mkjsf-moved-to-github.git / blobdiff