diff --git a/code/src/main/java/com/scientiamobile/wurflcloud/CloudClient.java b/code/src/main/java/com/scientiamobile/wurflcloud/CloudClient.java index 7d1756b..fe920d0 100755 --- a/code/src/main/java/com/scientiamobile/wurflcloud/CloudClient.java +++ b/code/src/main/java/com/scientiamobile/wurflcloud/CloudClient.java @@ -98,13 +98,14 @@ public class CloudClient extends Loggable implements ICloudClientRequest, Consta /** * Construct a new CloudClient object * - * @param request - * @param response - * @param cfg - * @param searchCapabilities - * @param credentials - * @param cache - * @param clientManager + * @param request the HTTP servlet request object + * @param response HTTP servlet response object + * @param cfg cloud clinet configuration + * @param searchCapabilities list of capabilities to get + * @param credentials wurfl cloud credentials + * @param cache cache implementation + * @param clientManager cloud client manager + * @param proxy proxy to use for connections */ protected CloudClient(HttpServletRequest request, HttpServletResponse response, CloudClientConfig cfg, String[] searchCapabilities, Credentials credentials, IWurflCloudCache cache, CloudClientManager clientManager, Proxy proxy) { this.response = response; @@ -546,9 +547,9 @@ private long updateListeners(CloudResponse cloudResponse) { /** * Reads response from cloud. * - * @param connection - * @return - * @throws IOException + * @param connection the HTTP connection object + * @return the content from cloud response + * @throws IOException in case of connection issues */ private String processContent(URLConnection connection) throws IOException { final char[] buffer = new char[0x10000]; diff --git a/code/src/main/java/com/scientiamobile/wurflcloud/CloudClientLoader.java b/code/src/main/java/com/scientiamobile/wurflcloud/CloudClientLoader.java index 8cb40a5..84956d3 100755 --- a/code/src/main/java/com/scientiamobile/wurflcloud/CloudClientLoader.java +++ b/code/src/main/java/com/scientiamobile/wurflcloud/CloudClientLoader.java @@ -44,7 +44,7 @@ public class CloudClientLoader extends Loggable implements Constants, Serializab /** * Constructs a CloudClientLoader by reading all the configuration properties (including the API Key) from the configuration file. - * @throws Exception + * @throws Exception if any error loading cloud configuration occurs */ public CloudClientLoader() throws Exception { this (null, null, null); @@ -53,7 +53,7 @@ public CloudClientLoader() throws Exception { /** * Constructs a CloudClientLoader with proxy configuration represented by a {@link Proxy} object * @param apiKey required key for Cloud Client use. - * @throws Exception + * @throws Exception if any error loading cloud configuration occurs */ public CloudClientLoader(String apiKey) throws Exception { this(apiKey, null, null); @@ -65,7 +65,7 @@ public CloudClientLoader(String apiKey) throws Exception { * @param proxyIp the proxy IP * @param proxyPort the proxy port * @param proxyType the {Proxy.Type representing the proxy protocol - * @throws Exception + * @throws Exception if any error loading cloud configuration occurs */ public CloudClientLoader(String apiKey, String proxyIp, int proxyPort, Proxy.Type proxyType) throws Exception { this(apiKey, new Proxy(proxyType, new InetSocketAddress(proxyIp, proxyPort))); @@ -76,7 +76,7 @@ public CloudClientLoader(String apiKey, String proxyIp, int proxyPort, Proxy.Typ * @param proxyIp the proxy IP * @param proxyPort the proxy port * @param proxyType the Proxy.Type representing the proxy protocol - * @throws Exception + * @throws Exception if any error loading cloud configuration occurs */ public CloudClientLoader(String proxyIp, int proxyPort, Proxy.Type proxyType) throws Exception { this(null, new Proxy(proxyType, new InetSocketAddress(proxyIp, proxyPort))); @@ -85,7 +85,7 @@ public CloudClientLoader(String proxyIp, int proxyPort, Proxy.Type proxyType) th /** * Constructs a CloudClientLoader without specific proxy configuration * @param proxy Proxy class to be used to connect to cloud server - * @throws Exception + * @throws Exception if any error loading cloud configuration occurs */ public CloudClientLoader(Proxy proxy) throws Exception { this(null, null, proxy); @@ -95,7 +95,7 @@ public CloudClientLoader(Proxy proxy) throws Exception { * Constructs a CloudClientLoader without specific proxy configuration * @param apiKey required key for Cloud Client use. * @param proxy Proxy class to be used to connect to cloud server - * @throws Exception + * @throws Exception if any error loading cloud configuration occurs */ public CloudClientLoader(String apiKey, Proxy proxy) throws Exception { this(apiKey, null, proxy); @@ -105,7 +105,7 @@ public CloudClientLoader(String apiKey, Proxy proxy) throws Exception { * Constructs a CloudClientLoader with proxy configuration represented by a {@link Proxy} object * @param apiKey required key for Cloud Client use. * @param propertiesFile .properties file path to be used - * @throws Exception + * @throws Exception if any error loading cloud configuration occurs */ public CloudClientLoader(String apiKey, String propertiesFile) throws Exception { this(apiKey, propertiesFile, null); @@ -118,7 +118,7 @@ public CloudClientLoader(String apiKey, String propertiesFile) throws Exception * @param proxyIp the proxy IP * @param proxyPort the proxy port * @param proxyType the Proxy.Type representing the proxy protocol - * @throws Exception + * @throws Exception if any error loading cloud configuration occurs */ public CloudClientLoader(String apiKey, String propertiesFile, String proxyIp, int proxyPort, Proxy.Type proxyType) throws Exception { this(apiKey, propertiesFile, new Proxy(proxyType, new InetSocketAddress(proxyIp, proxyPort))); @@ -129,7 +129,7 @@ public CloudClientLoader(String apiKey, String propertiesFile, String proxyIp, i * @param apiKey required key for Cloud Client use. * @param propertiesFile the .properties file path to be used * @param proxy the Proxy class to be used to connect to cloud server - * @throws Exception + * @throws Exception if any error loading cloud configuration occurs */ public CloudClientLoader(String apiKey, String propertiesFile, Proxy proxy) throws Exception {