1 package com.indexdata.mkjsf.pazpar2;
\r
3 import static com.indexdata.mkjsf.utils.Utils.nl;
\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
12 import org.apache.log4j.Logger;
\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
31 * Search client handling straight Pazpar2 requests.
\r
33 * <p>Although it is described here as straight Pazpar2, the client itself
\r
34 * actually represents a layer between Pazpar2 and the JSF application because it
\r
35 * uses the Pazpar2 client from the library masterkey-common.</p>
\r
36 * That client, which is the one also used by the Service Proxy, does perform certain
\r
37 * types of session handling, bootstraps lost sessions, avoids repeating already
\r
38 * executed queries etc, so it is -- in other words -- still a mediated interaction
\r
39 * with Pazpar2 that takes place. At least for now.</p>
\r
41 * @author Niels Erik
\r
44 public class Pz2Client implements SearchClient {
\r
46 private static final long serialVersionUID = 5414266730169982028L;
\r
47 private static Logger logger = Logger.getLogger(Pz2Client.class);
\r
48 private transient Pazpar2Client client = null;
\r
49 private Pazpar2ClientConfiguration cfg = null;
\r
50 public static final String MODULENAME = "pz2client";
\r
51 public static Map<String,String> DEFAULTS = new HashMap<String,String>();
\r
52 Configuration config = null;
\r
55 DEFAULTS.put("PAZPAR2_URL", "");
\r
56 DEFAULTS.put("PROXY_MODE","1");
\r
57 DEFAULTS.put("SERIALIZE_REQUESTS", "false");
\r
58 DEFAULTS.put("STREAMBUFF_SIZE", "4096");
\r
59 DEFAULTS.put("PARSE_RESPONSES", "true");
\r
62 public Pz2Client() {}
\r
65 public void configure(ConfigurationReader configReader) throws ConfigurationException {
\r
66 logger.info(Utils.objectId(this) + " is configuring using the provided " + Utils.objectId(configReader));
\r
68 config = configReader.getConfiguration(this);
\r
69 cfg = new Pazpar2ClientConfiguration(new ConfigurationGetter(config));
\r
70 } catch (ProxyErrorException pe) {
\r
71 logger.error("Could not configure Pazpar2 client: " + pe.getMessage());
\r
72 throw new ConfigurationException("Could not configure Pz2Client: "+ pe.getMessage(),pe);
\r
76 client = new Pazpar2ClientGeneric(cfg);
\r
77 } catch (ProxyErrorException pe) {
\r
78 logger.error("Could not configure Pazpar2 client: " + pe.getMessage());
\r
79 throw new ConfigurationException("Could not configure Pz2Client: "+ pe.getMessage(),pe);
\r
82 logger.error("There was a problem creating Pz2Client. Client is null after configuration.");
\r
83 throw new ConfigurationException("Pazpar2Client is null after configuration");
\r
87 public boolean isAuthenticatingClient () {
\r
91 public boolean isAuthenticated() {
\r
95 public boolean authenticate() {
\r
96 throw new UnsupportedOperationException("No authentication mechanism for straight pazpar2 client");
\r
100 public void setSearchCommand(Pazpar2Command command) {
\r
101 ClientCommand clientCommand = new ClientCommand(command.getCommandName(), command.getEncodedQueryString());
\r
102 client.setSearchCommand(clientCommand);
\r
106 * Runs the give Pazpar2 command and returns a response wrapper with either the received response or
\r
107 * with some form of error message.
\r
109 * It is intended that this method never throws an exception. All events are supposed to be captured and
\r
110 * returned in some form of response.
\r
113 public HttpResponseWrapper executeCommand(Pazpar2Command command) {
\r
114 ClientCommandResponse commandResponse = null;
\r
115 ByteArrayOutputStream baos = new ByteArrayOutputStream();
\r
116 ClientCommand clientCommand = new ClientCommand(command.getCommandName(), command.getEncodedQueryString());
\r
117 Pazpar2HttpResponse pz2HttpResponse = null;
\r
118 long start = System.currentTimeMillis();
\r
120 pz2HttpResponse = client.executeCommand(clientCommand, baos);
\r
121 if (pz2HttpResponse.getStatusCode()==200 && pz2HttpResponse.getContentType().contains("xml")) {
\r
122 commandResponse = new ClientCommandResponse(pz2HttpResponse,baos);
\r
123 } else if (pz2HttpResponse.getStatusCode()==200 && pz2HttpResponse.getContentType().contains("octet-stream")) {
\r
124 commandResponse = new ClientCommandResponse(pz2HttpResponse,baos);
\r
125 logger.info("Content type: " + commandResponse.getContentType() + ". isBinary?: " + commandResponse.isBinary());
\r
126 } else if (pz2HttpResponse.getStatusCode()==417) {
\r
127 logger.error("Pazpar2 status code 417: " + baos.toString("UTF-8"));
\r
128 commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()) ,"Pazpar2: Expectation failed (417)", baos.toString("UTF-8")),"text/xml");
\r
129 } else if (pz2HttpResponse.getContentType().contains("html")) {
\r
130 String resp = baos.toString("UTF-8");
\r
131 logger.error("HTML response where XML was expected. Status code was " + pz2HttpResponse.getStatusCode() + ": " + resp);
\r
132 String htmlStrippedOfTags = resp.replaceAll("\\<[^>]*>","");
\r
133 String errorXml = "";
\r
134 if (htmlStrippedOfTags.toLowerCase().contains("domain")) {
\r
135 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
137 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
139 commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),errorXml,pz2HttpResponse.getContentType());
\r
141 String resp = baos.toString("UTF-8");
\r
142 logger.error("Pazpar2 status code was " + pz2HttpResponse.getStatusCode() + ": " + resp);
\r
143 commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.insertErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "Pazpar2 error occurred", baos.toString("UTF-8")),"text/xml");
\r
145 } catch (IOException e) {
\r
146 logger.error(e.getMessage());
\r
147 e.printStackTrace();
\r
148 commandResponse = new ClientCommandResponse(pz2HttpResponse.getStatusCode(),CommandError.createErrorXml(command.getCommandName(), String.valueOf(pz2HttpResponse.getStatusCode()), "IO exception", e.getMessage(), ""),"text/xml");
\r
149 } catch (Pazpar2ErrorException e) {
\r
150 logger.error(e.getMessage());
\r
151 e.printStackTrace();
\r
152 logger.error("Creating error XML");
\r
153 commandResponse = new ClientCommandResponse(0,CommandError.createErrorXml(command.getCommandName(), "", "ServiceError", e.getMessage(),""),"text/xml");
\r
155 long end = System.currentTimeMillis();
\r
156 logger.info("Executed " + command.getCommandName() + " in " + (end-start) + " ms." );
\r
157 return commandResponse;
\r
160 public Pz2Client cloneMe() {
\r
161 logger.debug("Cloning Pz2Client");
\r
162 Pz2Client clone = new Pz2Client();
\r
163 clone.client = this.client;
\r
164 clone.cfg = this.cfg;
\r
169 * Returns default configuration parameters for the client.
\r
172 public Map<String, String> getDefaults() {
\r
177 * Returns the configuration name of the client
\r
180 public String getModuleName() {
\r
184 class ConfigurationGetter implements ModuleConfigurationGetter {
\r
185 Configuration config = null;
\r
186 ConfigurationGetter(Configuration configuration) {
\r
187 config = configuration;
\r
190 public String get(String value) {
\r
191 return config.get(value);
\r
194 public String get(String value, String defaultValue) {
\r
195 return config.get(value,defaultValue);
\r
198 public String getMandatory(String name)
\r
199 throws MissingMandatoryParameterException {
\r
200 return config.getMandatory(name);
\r
203 public String getConfigFilePath() {
\r
204 return config.getConfigFilePath();
\r
209 * Provides configuration documentation -- mostly for diagnosing problems
\r
212 public List<String> documentConfiguration() {
\r
213 List<String> doc = new ArrayList<String>();
\r
214 doc.add(nl+ MODULENAME + " was configured to access Pazpar2 at : " + cfg.PAZPAR2_URL);
\r
215 return new ArrayList<String>();
\r
218 public Configuration getConfiguration () {
\r
223 * Returns the currently configured Papzar2 URL.
\r
226 public String getServiceUrl() {
\r
227 return cfg.PAZPAR2_URL;
\r
231 * Returns true if a Papzar2 URL was defined yet.
\r
234 public boolean hasServiceUrl() {
\r
235 return cfg.PAZPAR2_URL != null && cfg.PAZPAR2_URL.length()>0;
\r
239 * Sets the Pazpar2 URL to use for requests.
\r
242 public void setServiceUrl (String serviceUrl) {
\r
243 cfg.PAZPAR2_URL = serviceUrl;
\r
247 * Returns the Pazpar2 Service ID
\r
249 public String getServiceId () {
\r
250 return cfg.PAZPAR2_SERVICE_ID;
\r
254 * Sets the service ID that Pazpar2 should use when servicing requests
\r
257 public void setServiceId(String serviceId) {
\r
258 cfg.PAZPAR2_SERVICE_ID = serviceId;
\r
260 client = new Pazpar2ClientGeneric(cfg);
\r
261 } catch (ProxyErrorException pe) {
\r
262 logger.error("Could not configure Pazpar2 client: " + pe.getMessage());
\r