Documentation
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / pz2utils4jsf / pazpar2 / StraightPz2Client.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.enterprise.inject.Alternative;\r
14 import javax.inject.Named;\r
15 \r
16 import org.apache.log4j.Logger;\r
17 \r
18 import com.indexdata.masterkey.config.MissingMandatoryParameterException;\r
19 import com.indexdata.masterkey.config.ModuleConfigurationGetter;\r
20 import com.indexdata.masterkey.pazpar2.client.ClientCommand;\r
21 import com.indexdata.masterkey.pazpar2.client.Pazpar2Client;\r
22 import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration;\r
23 import com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric;\r
24 import com.indexdata.masterkey.pazpar2.client.Pazpar2HttpResponse;\r
25 import com.indexdata.masterkey.pazpar2.client.exceptions.Pazpar2ErrorException;\r
26 import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException;\r
27 import com.indexdata.pz2utils4jsf.config.Configuration;\r
28 import com.indexdata.pz2utils4jsf.config.ConfigurationReader;\r
29 import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
30 import com.indexdata.pz2utils4jsf.utils.Utils;\r
31 \r
32 @Named @SessionScoped @Alternative\r
33 public class StraightPz2Client implements SearchClient {\r
34 \r
35   private static final long serialVersionUID = 5414266730169982028L;\r
36   private static Logger logger = Logger.getLogger(StraightPz2Client.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   \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 StraightPz2Client() {}\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       Configuration 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 StraightPz2Client:  "+ 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 StraightPz2Client:  "+ pe.getMessage(),pe);\r
67       }\r
68     } else {\r
69       logger.error("There was a problem creating StraightPz2Client. Client is null after configuration.");\r
70       throw new ConfigurationException("Pazpar2Client is null after configuration");\r
71     } \r
72   }\r
73   \r
74   \r
75   @Override\r
76   public void setSearchCommand(Pazpar2Command command) {\r
77     ClientCommand clientCommand = new ClientCommand(command.getName(), command.getEncodedQueryString());\r
78     client.setSearchCommand(clientCommand);    \r
79   }\r
80 \r
81   @Override\r
82   public CommandResponse executeCommand(Pazpar2Command command, ByteArrayOutputStream baos) \r
83        throws Pazpar2ErrorException, IOException {\r
84     ClientCommand clientCommand = new ClientCommand(command.getName(), command.getEncodedQueryString());\r
85     Pazpar2HttpResponse pz2HttpResponse = client.executeCommand(clientCommand, baos);\r
86     return new StraightPz2CommandResponse(pz2HttpResponse,baos);\r
87   }\r
88 \r
89   public StraightPz2Client cloneMe() {\r
90     logger.debug("Cloning StraightPz2Client");\r
91     StraightPz2Client clone = new StraightPz2Client();\r
92     clone.client = this.client;\r
93     clone.cfg = this.cfg;\r
94     return clone;\r
95   }\r
96 \r
97   @Override\r
98   public Map<String, String> getDefaults() {\r
99     return DEFAULTS;\r
100   }\r
101 \r
102   @Override\r
103   public String getModuleName() {\r
104     return MODULENAME;\r
105   }\r
106   \r
107   class ConfigurationGetter implements ModuleConfigurationGetter {\r
108     Configuration config = null;\r
109     ConfigurationGetter(Configuration configuration) {\r
110       config = configuration;\r
111     }\r
112     @Override\r
113     public String get(String value) {\r
114       return config.get(value);\r
115     }\r
116     @Override\r
117     public String get(String value, String defaultValue) {\r
118       return config.get(value,defaultValue);\r
119     }\r
120     @Override\r
121     public String getMandatory(String name)\r
122         throws MissingMandatoryParameterException {\r
123       return config.getMandatory(name);\r
124     }\r
125     @Override\r
126     public String getConfigFilePath() {\r
127       return config.getConfigFilePath();\r
128     }\r
129   }\r
130 \r
131   @Override\r
132   public List<String> documentConfiguration() {\r
133     List<String> doc = new ArrayList<String>();\r
134     doc.add(nl+ MODULENAME + " was configured to access Pazpar2 at : " + cfg.PAZPAR2_URL);    \r
135     return new ArrayList<String>();\r
136   }\r
137 \r
138 }\r