added HTTPS support

Author: a-brandt

ChangeLog

@@ -2,6 +2,8 @@ v2.7.0 (????-??-??)
 ---------------------------
 * added document examples in src/test/java/com/arangodb/example/document/
 * added graph examples in src/test/java/com/arangodb/example/document/
+* new function executeAqlQueryJSON(): Executes an AQL query and returns the raw JSON response as a String
+* initial support of HTTPS connections. Examples src/test/java/com/arangodb/example/ssl/
 
 
 v2.6.9 (2015-10-16)

README.md

@@ -76,6 +76,9 @@ The driver is configured with some default values:
 <tr><th>retryCount</th><td>http retry count</td><td>3</td></tr>
 <tr><th>defaultDatabase</th><td>default database</td><td></td></tr>
 <tr><th>enableCURLLogger</th><td>logging flag by curl format for debug</td><td>false</td></tr>
+<tr><th>useSsl</th><td>use HTTPS connection</td><td>false</td></tr>
+<tr><th>sslTrustStore</th><td>path to a trust-store</td><td>false</td></tr>
+
 </table>
 
 Since 2.5.4 you can configure a default and a fallback database:

src/main/java/com/arangodb/ArangoConfigure.java

@@ -22,6 +22,8 @@
 import java.util.List;
 import java.util.Properties;
 
+import javax.net.ssl.SSLContext;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -52,48 +54,54 @@ public class ArangoConfigure {
 	/** default property file */
 	private static final String DEFAULT_PROPERTY_FILE = "/arangodb.properties";
 
-	List<ArangoHost> arangoHosts;
-	int currentArangoHost;
+	private List<ArangoHost> arangoHosts;
+	private int currentArangoHost;
 
 	/** connection timeout(ms) */
-	int connectionTimeout = -1;
+	private int connectionTimeout = -1;
 	/** socket read timeout(ms) */
-	int timeout = -1;
+	private int timeout = -1;
 
 	/** max connection per configure */
-	int maxTotalConnection;
+	private int maxTotalConnection;
 	/** max connection per host */
-	int maxPerConnection;
+	private int maxPerConnection;
 
 	/** Basic auth user */
-	String user;
+	private String user;
 	/** Basic auth password */
-	String password;
+	private String password;
 
 	/** proxy-host */
-	String proxyHost;
+	private String proxyHost;
 	/** proxy-port */
-	int proxyPort;
+	private int proxyPort;
 
 	/** http retry count */
-	int retryCount = 3;
+	private int retryCount = 3;
 
 	/**
 	 * number of connect retries (0 means infinite)
 	 */
-	int connectRetryCount = 3;
+	private int connectRetryCount = 3;
 
 	/**
 	 * milliseconds
 	 */
-	int connectRetryWait = 1000;
+	private int connectRetryWait = 1000;
 
 	/** Default Database */
 	String defaultDatabase;
 
-	boolean enableCURLLogger = false;
+	private boolean enableCURLLogger = false;
+
+	private boolean staleConnectionCheck = false;
+
+	private boolean useSsl = false;
+
+	private SSLContext sslContext = null;
 
-	boolean staleConnectionCheck = false;
+	private String sslTrustStore = null;
 
 	/**
 	 * the default ArangoDB cursor batch size
@@ -247,6 +255,16 @@ public void loadProperties(String propertyPath) {
 					setBatchSize(Integer.parseInt(batchSize));
 				}
 
+				String useSsl = prop.getProperty("useSsl");
+				if (useSsl != null) {
+					setUseSsl(Boolean.parseBoolean(useSsl));
+				}
+
+				String sslTrustStore = prop.getProperty("sslTrustStore");
+				if (sslTrustStore != null) {
+					setSslTrustStore(sslTrustStore);
+				}
+
 			}
 		} catch (IOException e) {
 			logger.warn("load property error", e);
@@ -285,13 +303,13 @@ public void shutdown() {
 	public String getBaseUrl() {
 		ArangoHost currentHost = getCurrentHost();
 
-		return "http://" + currentHost.getHost() + ":" + currentHost.getPort();
+		return (useSsl ? "https://" : "http://") + currentHost.getHost() + ":" + currentHost.getPort();
 	}
 
 	public String getEndpoint() {
 		ArangoHost currentHost = getCurrentHost();
 
-		return "tcp://" + currentHost.getHost() + ":" + currentHost.getPort();
+		return (useSsl ? "ssl://" : "tcp://") + currentHost.getHost() + ":" + currentHost.getPort();
 	}
 
 	private ArangoHost getCurrentHost() {
@@ -585,4 +603,48 @@ public void setBatchSize(int batchSize) {
 		this.batchSize = batchSize;
 	}
 
+	public boolean getUseSsl() {
+		return useSsl;
+	}
+
+	/**
+	 * Configure the client to use HTTPS or HTTP
+	 * 
+	 * @param useSsl
+	 *            set true to use HTTPS (default false)
+	 */
+	public void setUseSsl(boolean useSsl) {
+		this.useSsl = useSsl;
+	}
+
+	public SSLContext getSslContext() {
+		return sslContext;
+	}
+
+	/**
+	 * Set SSL contest for HTTPS connections.
+	 * 
+	 * (do not use setSslTrustStore() together with setSslContext())
+	 * 
+	 * @param sslContext
+	 */
+	public void setSslContext(SSLContext sslContext) {
+		this.sslContext = sslContext;
+	}
+
+	public String getSslTrustStore() {
+		return sslTrustStore;
+	}
+
+	/**
+	 * Set file name of trust store
+	 * 
+	 * (do not use setSslTrustStore() together with setSslContext())
+	 * 
+	 * @param sslTrustStore
+	 */
+	public void setSslTrustStore(String sslTrustStore) {
+		this.sslTrustStore = sslTrustStore;
+	}
+
 }

src/main/java/com/arangodb/ArangoDriver.java

@@ -2471,25 +2471,26 @@ public <T> CursorResult<T> executeAqlQuery(
 
 	/**
 	 * Executes an AQL query and returns the raw JSON response
-	 * @param query an AQL query as string
-	 * @param bindVars a map containing all bind variables,
-	 * @param aqlQueryOptions AQL query options
+	 * 
+	 * @param query
+	 *            an AQL query as string
+	 * @param bindVars
+	 *            a map containing all bind variables,
+	 * @param aqlQueryOptions
+	 *            AQL query options
 	 * @return A JSON string with the results from server
 	 * @throws ArangoException
 	 */
-	public String executeAqlQueryJSON(
-			String query,
-			Map<String, Object> bindVars,
-			AqlQueryOptions aqlQueryOptions
-			) throws ArangoException {
-
-			if (aqlQueryOptions == null) {
-				aqlQueryOptions = getDefaultAqlQueryOptions();
-			}
+	public String executeAqlQueryJSON(String query, Map<String, Object> bindVars, AqlQueryOptions aqlQueryOptions)
+			throws ArangoException {
 
-			return cursorDriver.executeAqlQueryJSON(getDefaultDatabase(), query, bindVars, aqlQueryOptions);
+		if (aqlQueryOptions == null) {
+			aqlQueryOptions = getDefaultAqlQueryOptions();
 		}
 
+		return cursorDriver.executeAqlQueryJSON(getDefaultDatabase(), query, bindVars, aqlQueryOptions);
+	}
+
 	/**
 	 * This method executes an AQL query and returns a DocumentCursorResult
 	 *
@@ -5756,4 +5757,12 @@ public DefaultEntity killQuery(String database, String id) throws ArangoExceptio
 		return this.cursorDriver.killQuery(database, id);
 	}
 
+	/**
+	 * Returns the HTTP manager of the driver
+	 * 
+	 * @return httpManager
+	 */
+	public HttpManager getHttpManager() {
+		return httpManager;
+	}
 }

src/main/java/com/arangodb/http/HttpManager.java

@@ -49,7 +49,12 @@
 import org.apache.http.client.methods.HttpPut;
 import org.apache.http.client.methods.HttpRequestBase;
 import org.apache.http.client.utils.URLEncodedUtils;
+import org.apache.http.config.Registry;
+import org.apache.http.config.RegistryBuilder;
 import org.apache.http.conn.ConnectionKeepAliveStrategy;
+import org.apache.http.conn.socket.ConnectionSocketFactory;
+import org.apache.http.conn.socket.PlainConnectionSocketFactory;
+import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
 import org.apache.http.entity.ContentType;
 import org.apache.http.entity.StringEntity;
 import org.apache.http.impl.auth.BasicScheme;
@@ -62,6 +67,7 @@
 import org.apache.http.message.BasicNameValuePair;
 import org.apache.http.protocol.HTTP;
 import org.apache.http.protocol.HttpContext;
+import org.apache.http.ssl.SSLContexts;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -95,9 +101,7 @@ public class HttpManager {
 	private Map<String, InvocationObject> jobs = new HashMap<String, InvocationObject>();
 
 	public static enum HttpMode {
-		SYNC,
-		ASYNC,
-		FIREANDFORGET
+		SYNC, ASYNC, FIREANDFORGET
 	}
 
 	public HttpManager(ArangoConfigure configure) {
@@ -109,8 +113,23 @@ public ArangoConfigure getConfiguration() {
 	}
 
 	public void init() {
+		// socket factory for HTTP
+		ConnectionSocketFactory plainsf = new PlainConnectionSocketFactory();
+
+		// socket factory for HTTPS
+		SSLConnectionSocketFactory sslsf = null;
+		if (configure.getSslContext() != null) {
+			sslsf = new SSLConnectionSocketFactory(configure.getSslContext());
+		} else {
+			sslsf = new SSLConnectionSocketFactory(SSLContexts.createSystemDefault());
+		}
+
+		// register socket factories
+		Registry<ConnectionSocketFactory> r = RegistryBuilder.<ConnectionSocketFactory> create()
+				.register("http", plainsf).register("https", sslsf).build();
+
 		// ConnectionManager
-		cm = new PoolingHttpClientConnectionManager();
+		cm = new PoolingHttpClientConnectionManager(r);
 		cm.setDefaultMaxPerRoute(configure.getMaxPerConnection());
 		cm.setMaxTotal(configure.getMaxTotalConnection());
 
@@ -137,7 +156,8 @@ public void init() {
 			@Override
 			public long getKeepAliveDuration(HttpResponse response, HttpContext context) {
 				// Honor 'keep-alive' header
-				HeaderElementIterator it = new BasicHeaderElementIterator(response.headerIterator(HTTP.CONN_KEEP_ALIVE));
+				HeaderElementIterator it = new BasicHeaderElementIterator(
+						response.headerIterator(HTTP.CONN_KEEP_ALIVE));
 				while (it.hasNext()) {
 					HeaderElement he = it.nextElement();
 					String param = he.getName();
@@ -281,8 +301,11 @@ public HttpResponseEntity doPostWithHeaders(
 		return doPostPutPatch(RequestType.POST, url, headers, params, body, entity);
 	}
 
-	public HttpResponseEntity doPut(String url, Map<String, Object> headers, Map<String, Object> params, String bodyText)
-			throws ArangoException {
+	public HttpResponseEntity doPut(
+		String url,
+		Map<String, Object> headers,
+		Map<String, Object> params,
+		String bodyText) throws ArangoException {
 		return doPostPutPatch(RequestType.PUT, url, headers, params, bodyText, null);
 	}
 
@@ -365,19 +388,19 @@ public HttpResponseEntity execute(HttpRequestEntity requestEntity) throws Arango
 	 * @return the response of the request
 	 * @throws ArangoException
 	 */
-	private HttpResponseEntity executeInternal(String baseUrl, HttpRequestEntity requestEntity) throws ArangoException,
-			SocketException {
+	private HttpResponseEntity executeInternal(String baseUrl, HttpRequestEntity requestEntity)
+			throws ArangoException, SocketException {
 
 		String url = buildUrl(baseUrl, requestEntity);
 
 		if (logger.isDebugEnabled()) {
 			if (requestEntity.type == RequestType.POST || requestEntity.type == RequestType.PUT
 					|| requestEntity.type == RequestType.PATCH) {
-				logger.debug("[REQ]http-{}: url={}, headers={}, body={}", new Object[] { requestEntity.type, url,
-						requestEntity.headers, requestEntity.bodyText });
+				logger.debug("[REQ]http-{}: url={}, headers={}, body={}",
+					new Object[] { requestEntity.type, url, requestEntity.headers, requestEntity.bodyText });
 			} else {
-				logger.debug("[REQ]http-{}: url={}, headers={}", new Object[] { requestEntity.type, url,
-						requestEntity.headers });
+				logger.debug("[REQ]http-{}: url={}, headers={}",
+					new Object[] { requestEntity.type, url, requestEntity.headers });
 			}
 		}