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