26e4a4d36ed5eac51aa4df63bcb50b02e13e0ced
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / pz2utils4jsf / pazpar2 / Pz2Client.java
1 package com.indexdata.pz2utils4jsf.pazpar2;\r
2 \r
3 import static com.indexdata.pz2utils4jsf.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 javax.enterprise.context.SessionScoped;\r
13 import javax.inject.Named;\r
14 \r
15 import org.apache.log4j.Logger;\r
16 \r
17 import com.indexdata.masterkey.config.MissingMandatoryParameterException;\r
18 import com.indexdata.masterkey.config.ModuleConfigurationGetter;\r
19 import com.indexdata.masterkey.pazpar2.client.ClientCommand;\r
20 import com.indexdata.masterkey.pazpar2.client.Pazpar2Client;\r
21 import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration;\r
22 import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric;\r
23 import com.indexdata.masterkey.pazpar2.client.Pazpar2HttpResponse;\r
24 import com.indexdata.masterkey.pazpar2.client.exceptions.Pazpar2ErrorException;\r
25 import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException;\r
26 import com.indexdata.pz2utils4jsf.config.Configuration;\r
27 import com.indexdata.pz2utils4jsf.config.ConfigurationReader;\r
28 import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
29 import com.indexdata.pz2utils4jsf.utils.Utils;\r
30 \r
31 @Named @SessionScoped \r
32 public class Pz2Client implements SearchClient {\r
33 \r
34   private static final long serialVersionUID = 5414266730169982028L;\r
35   private static Logger logger = Logger.getLogger(Pz2Client.class);\r
36   private Pazpar2Client client = null;\r
37   private Pazpar2ClientConfiguration cfg = null;\r
38   public static final String MODULENAME = "pz2client";\r
39   public static Map<String,String> DEFAULTS = new HashMap<String,String>();\r
40   Configuration config = null;\r
41   \r
42   static {    \r
43     DEFAULTS.put("PROXY_MODE","1");\r
44     DEFAULTS.put("SERIALIZE_REQUESTS", "false");\r
45     DEFAULTS.put("STREAMBUFF_SIZE", "4096");\r
46     DEFAULTS.put("PARSE_RESPONSES", "true");    \r
47   }\r
48   \r
49   public Pz2Client() {}\r
50   \r
51   @Override\r
52   public void configure(ConfigurationReader configReader) throws ConfigurationException {    \r
53     logger.info(Utils.objectId(this) + " is configuring using the provided " + Utils.objectId(configReader));\r
54     try {\r
55       config = configReader.getConfiguration(this);\r
56       cfg = new Pazpar2ClientConfiguration(new ConfigurationGetter(config));\r
57     } catch (ProxyErrorException pe) {\r
58       logger.error("Could not configure Pazpar2 client: " + pe.getMessage());\r
59       throw new ConfigurationException("Could not configure Pz2Client:  "+ pe.getMessage(),pe);\r
60     } \r
61     if (cfg != null) {\r
62       try {\r
63         client = new Pazpar2ClientGeneric(cfg);  \r
64       } catch (ProxyErrorException pe) {\r
65         logger.error("Could not configure Pazpar2 client: " + pe.getMessage());\r
66         throw new ConfigurationException("Could not configure Pz2Client:  "+ pe.getMessage(),pe);\r
67       }\r
68     } else {\r
69       logger.error("There was a problem creating Pz2Client. Client is null after configuration.");\r
70       throw new ConfigurationException("Pazpar2Client is null after configuration");\r
71     } \r
72   }\r
73   \r
74   public boolean isAuthenticatingClient () {\r
75     return false;\r
76   }\r
77   \r
78   public boolean isAuthenticated() {\r
79     return false;\r
80   }\r
81   \r
82   public boolean authenticate() {\r
83     throw new UnsupportedOperationException("No authentication mechanism for straight pazpar2 client");\r
84   }\r
85   \r
86   @Override\r
87   public void setSearchCommand(Pazpar2Command command) {\r
88     ClientCommand clientCommand = new ClientCommand(command.getName(), command.getEncodedQueryString());\r
89     client.setSearchCommand(clientCommand);    \r
90   }\r
91 \r
92   @Override\r
93   public CommandResponse executeCommand(Pazpar2Command command, ByteArrayOutputStream baos) \r
94        throws Pazpar2ErrorException, IOException {\r
95     ClientCommand clientCommand = new ClientCommand(command.getName(), command.getEncodedQueryString());\r
96     Pazpar2HttpResponse pz2HttpResponse = client.executeCommand(clientCommand, baos);\r
97     return new Pz2CommandResponse(pz2HttpResponse,baos);\r
98   }\r
99 \r
100   public Pz2Client cloneMe() {\r
101     logger.debug("Cloning Pz2Client");\r
102     Pz2Client clone = new Pz2Client();\r
103     clone.client = this.client;\r
104     clone.cfg = this.cfg;\r
105     return clone;\r
106   }\r
107 \r
108   @Override\r
109   public Map<String, String> getDefaults() {\r
110     return DEFAULTS;\r
111   }\r
112 \r
113   @Override\r
114   public String getModuleName() {\r
115     return MODULENAME;\r
116   }\r
117   \r
118   class ConfigurationGetter implements ModuleConfigurationGetter {\r
119     Configuration config = null;\r
120     ConfigurationGetter(Configuration configuration) {\r
121       config = configuration;\r
122     }\r
123     @Override\r
124     public String get(String value) {\r
125       return config.get(value);\r
126     }\r
127     @Override\r
128     public String get(String value, String defaultValue) {\r
129       return config.get(value,defaultValue);\r
130     }\r
131     @Override\r
132     public String getMandatory(String name)\r
133         throws MissingMandatoryParameterException {\r
134       return config.getMandatory(name);\r
135     }\r
136     @Override\r
137     public String getConfigFilePath() {\r
138       return config.getConfigFilePath();\r
139     }\r
140   }\r
141 \r
142   @Override\r
143   public List<String> documentConfiguration() {\r
144     List<String> doc = new ArrayList<String>();\r
145     doc.add(nl+ MODULENAME + " was configured to access Pazpar2 at : " + cfg.PAZPAR2_URL);    \r
146     return new ArrayList<String>();\r
147   }\r
148   \r
149   public Configuration getConfiguration () {\r
150     return config;\r
151   }\r
152 \r
153 }\r