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