Improve code documentation

Author: InterNetX-DL

sdk-client/src/main/java/org/domainrobot/sdk/client/Domainrobot.java

@@ -26,6 +26,8 @@ public class Domainrobot {
 	 */
 	public DomainStudioClient domainStudio;
 
+	private String version = "0.1.0";
+
 	/**
 	 * <p>
 	 * Creates a new instance of the domainrobot provider, that gives access to the
@@ -46,9 +48,8 @@ public class Domainrobot {
 	 * @param baseUrl  : The base url for the api
 	 */
 	public Domainrobot(String user, String context, String password, String baseUrl) {
-		String packageVersion = getClass().getPackage().getImplementationVersion();
-		certificate = new CertificateClient(user, context, password, baseUrl, packageVersion);
-		domainStudio = new DomainStudioClient(user, context, password, baseUrl, packageVersion, getRestTemplate());
+		certificate = new CertificateClient(user, context, password, baseUrl, version, getRestTemplate());
+		domainStudio = new DomainStudioClient(user, context, password, baseUrl, version, getRestTemplate());
 	}
 
 	public CertificateClient getCertificate() {

sdk-client/src/main/java/org/domainrobot/sdk/client/clients/AbstractClient.java

@@ -109,12 +109,19 @@ public <T> RequestEntity<T> buildRequestEntity(T body, HttpMethod method, String
 		}
 	}
 
-	public void handleException(HttpClientErrorException e) throws DomainrobotApiException, IOException {
+	public void handleException(HttpClientErrorException e) throws DomainrobotApiException {
 		String bodyAsString = e.getResponseBodyAsString();
-		JsonResponseData body = JsonUtils.deserialize(bodyAsString.getBytes(), JsonResponseData.class);
-		String message = body.getMessages().get(0).getText();
-		String errorCode = body.getMessages().get(0).getCode();
-		String stid = body.getStid();
+		String message = "";
+		String errorCode = "";
+		String stid = "";
+		try {
+			JsonResponseData body = JsonUtils.deserialize(bodyAsString.getBytes(), JsonResponseData.class);
+			message = body.getMessages().get(0).getText();
+			errorCode = body.getMessages().get(0).getCode();
+			stid = body.getStid();
+		} catch (IOException ioException) {
+			// Can't parse the response body to JsonResponseData model
+		}
 
 		throw new DomainrobotApiException(message, bodyAsString, errorCode, stid,
 				e.getResponseHeaders().toSingleValueMap());

sdk-client/src/main/java/org/domainrobot/sdk/client/clients/CertificateClient.java

@@ -1,6 +1,5 @@
 package org.domainrobot.sdk.client.clients;
 
-import java.io.IOException;
 import java.util.Map;
 
 import org.domainrobot.sdk.models.DomainrobotApiException;
@@ -23,22 +22,28 @@ public class CertificateClient extends AbstractClient {
 
 	RestTemplate template;
 
-	public CertificateClient(String userName, String context, String password, String baseUrl, String version) {
+	public CertificateClient(String userName, String context, String password, String baseUrl, String version,
+			RestTemplate template) {
 		this.userName = userName;
 		this.context = context;
 		this.password = password;
 		this.baseUrl = baseUrl;
 		this.version = version;
-		this.template = new RestTemplate();
+		this.template = template;
 	}
 
 	/**
 	 * 
-	 * @return
-	 * @throws IOException
+	 * Orders a certificate in realtime. The prepareOrder tasks should be called
+	 * before to generate the necessary DCV data. <br>
+	 * <br>
+	 * <b>Note:</b> This works only for certain DV certificate products and dcv
+	 * methods.
+	 * 
+	 * @return Certificate
+	 * @throws DomainrobotApiException
 	 */
-	public Certificate realtime(Certificate body, Map<String, String> customHeaders)
-			throws DomainrobotApiException, IOException {
+	public Certificate realtime(Certificate body, Map<String, String> customHeaders) throws DomainrobotApiException {
 		RequestEntity<Certificate> request = buildRequestEntity(body, HttpMethod.POST,
 				baseUrl + "/certificate/realtime", customHeaders);
 		ResponseEntity<JsonResponseDataCertificate> response = null;
@@ -52,11 +57,21 @@ public Certificate realtime(Certificate body, Map<String, String> customHeaders)
 
 	/**
 	 * 
-	 * @return
-	 * @throws IOException
+	 * Check the csr and generate DCV data for an order, renew and reissue. This
+	 * should be called everytime before the following tasks :
+	 * <ul>
+	 * <li>realtime</li>
+	 * <li>create</li>
+	 * <li>reissue</li>
+	 * <li>renew</li>
+	 * </ul>
+	 * <br>
+	 * 
+	 * @return CertificateData
+	 * @throws DomainrobotApiException
 	 */
 	public CertificateData prepareOrder(CertificateData body, Map<String, String> customHeaders)
-			throws DomainrobotApiException, IOException {
+			throws DomainrobotApiException {
 		RequestEntity<CertificateData> request = buildRequestEntity(body, HttpMethod.POST,
 				baseUrl + "/certificate/prepareOrder", customHeaders);
 		ResponseEntity<JsonResponseDataCertificateData> response = null;

sdk-client/src/main/java/org/domainrobot/sdk/client/clients/DomainStudioClient.java

@@ -1,6 +1,5 @@
 package org.domainrobot.sdk.client.clients;
 
-import java.io.IOException;
 import java.util.List;
 import java.util.Map;
 
@@ -35,12 +34,25 @@ public DomainStudioClient(String userName, String context, String password, Stri
 	}
 
 	/**
+	 * Sends a domainstudio search request. <br>
+	 * <br>
+	 * <b>Note:</b> By default, search results are provided synchronously: the
+	 * search response contains all the additional data for each domain name
+	 * created. With the following header the asynchronous mode can be activated:
+	 * <br>
+	 * <br>
+	 * <b>X-Domainrobot-WS : ASYNC</b> <br>
+	 * <br>
+	 * The additional domain data will then be delivered via websocket. <br>
+	 * See the official <a href=
+	 * "https://help.internetx.com/display/APIADDITIONALEN/DomainStudio+Guide">domainstudio
+	 * guide</a> for more information.
 	 * 
-	 * @return
-	 * @throws IOException
+	 * @return List of DomainEnvelope
+	 * @throws DomainrobotApiException
 	 */
 	public List<DomainEnvelope> search(DomainEnvelopeSearchRequest body, Map<String, String> customHeaders)
-			throws DomainrobotApiException, IOException {
+			throws DomainrobotApiException {
 		RequestEntity<DomainEnvelopeSearchRequest> request = buildRequestEntity(body, HttpMethod.POST,
 				baseUrl + "/domainstudio", customHeaders);
 		ResponseEntity<JsonResponseDataDomainEnvelope> response = null;