Permalink
Browse files

Update API docs

  • Loading branch information...
1 parent 9ef4533 commit 89ac7a077ca7a8ac478bcc517c69464e53405d96 @cch1 committed Aug 26, 2016
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>http.async.client.cert documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Http.async.client 1.0.1 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>http</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>async</span></div></div></li><li class="depth-3"><a href="http.async.client.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>client</span></div></a></li><li class="depth-4 branch current"><a href="http.async.client.cert.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cert</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.headers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>headers</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.part.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>part</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.request.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>request</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.status.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>status</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li><li class="depth-4"><a href="http.async.client.websocket.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>websocket</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="http.async.client.cert.html#var--.3EBlindTrustManager"><div class="inner"><span>-&gt;BlindTrustManager</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-add-x509-cert"><div class="inner"><span>add-x509-cert</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-key-manager-factory"><div class="inner"><span>key-manager-factory</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-load-embedded-resource"><div class="inner"><span>load-embedded-resource</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-load-keystore"><div class="inner"><span>load-keystore</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-load-x509-cert"><div class="inner"><span>load-x509-cert</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-map-.3EBlindTrustManager"><div class="inner"><span>map-&gt;BlindTrustManager</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-resource-stream"><div class="inner"><span>resource-stream</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-ssl-context"><div class="inner"><span>ssl-context</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">http.async.client.cert</h2><div class="doc"><pre class="plaintext">Asynchronous HTTP Client - Clojure - Utils
+<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>http.async.client.cert documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Http.async.client 1.2.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>http</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>async</span></div></div></li><li class="depth-3"><a href="http.async.client.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>client</span></div></a></li><li class="depth-4 branch current"><a href="http.async.client.cert.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cert</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.headers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>headers</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.part.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>part</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.request.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>request</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.status.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>status</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li><li class="depth-4"><a href="http.async.client.websocket.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>websocket</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="http.async.client.cert.html#var--.3EBlindTrustManager"><div class="inner"><span>-&gt;BlindTrustManager</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-add-x509-cert"><div class="inner"><span>add-x509-cert</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-key-manager-factory"><div class="inner"><span>key-manager-factory</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-load-embedded-resource"><div class="inner"><span>load-embedded-resource</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-load-keystore"><div class="inner"><span>load-keystore</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-load-x509-cert"><div class="inner"><span>load-x509-cert</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-map-.3EBlindTrustManager"><div class="inner"><span>map-&gt;BlindTrustManager</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-resource-stream"><div class="inner"><span>resource-stream</span></div></a></li><li class="depth-1"><a href="http.async.client.cert.html#var-ssl-context"><div class="inner"><span>ssl-context</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">http.async.client.cert</h2><div class="doc"><pre class="plaintext">Asynchronous HTTP Client - Clojure - Utils
</pre></div><div class="public anchor" id="var--.3EBlindTrustManager"><h3>-&gt;BlindTrustManager</h3><div class="usage"><code>(-&gt;BlindTrustManager)</code></div><div class="doc"><pre class="plaintext">Positional factory function for class http.async.client.cert.BlindTrustManager.
</pre></div><div class="src-link"><a href="http://github.com/cch1/http.async.client/blob/master/src/clj/http/async/client/cert.clj#L37">view source</a></div></div><div class="public anchor" id="var-add-x509-cert"><h3>add-x509-cert</h3><div class="usage"><code>(add-x509-cert keystore cert-alias certificate)</code></div><div class="doc"><pre class="plaintext">Adds the x509 certificate to the specified keystore. Param cert-alias
is a name for this cert. Returns KeyStore with the certificate loaded.</pre></div><div class="src-link"><a href="http://github.com/cch1/http.async.client/blob/master/src/clj/http/async/client/cert.clj#L94">view source</a></div></div><div class="public anchor" id="var-key-manager-factory"><h3>key-manager-factory</h3><div class="usage"><code>(key-manager-factory keystore password)</code></div><div class="doc"><pre class="plaintext">Returns a key manager for X509 certs using the speficied keystore.
@@ -9,7 +9,7 @@
the KeyStore. Password may be nil. If keystore-stream is nil, this
returns an empty default KeyStore.</pre></div><div class="src-link"><a href="http://github.com/cch1/http.async.client/blob/master/src/clj/http/async/client/cert.clj#L80">view source</a></div></div><div class="public anchor" id="var-load-x509-cert"><h3>load-x509-cert</h3><div class="usage"><code>(load-x509-cert path)</code></div><div class="doc"><pre class="plaintext">Loads an x509 certificate from the specified path, which may be either
a file system path or a path to an embedded resource in a jar file.
-Returns an instace of java.security.cert.X509Certificate.</pre></div><div class="src-link"><a href="http://github.com/cch1/http.async.client/blob/master/src/clj/http/async/client/cert.clj#L69">view source</a></div></div><div class="public anchor" id="var-map-.3EBlindTrustManager"><h3>map-&gt;BlindTrustManager</h3><div class="usage"><code>(map-&gt;BlindTrustManager m__6289__auto__)</code></div><div class="doc"><pre class="plaintext">Factory function for class http.async.client.cert.BlindTrustManager, taking a map of keywords to field values.
+Returns an instace of java.security.cert.X509Certificate.</pre></div><div class="src-link"><a href="http://github.com/cch1/http.async.client/blob/master/src/clj/http/async/client/cert.clj#L69">view source</a></div></div><div class="public anchor" id="var-map-.3EBlindTrustManager"><h3>map-&gt;BlindTrustManager</h3><div class="usage"><code>(map-&gt;BlindTrustManager m__6522__auto__)</code></div><div class="doc"><pre class="plaintext">Factory function for class http.async.client.cert.BlindTrustManager, taking a map of keywords to field values.
</pre></div><div class="src-link"><a href="http://github.com/cch1/http.async.client/blob/master/src/clj/http/async/client/cert.clj#L37">view source</a></div></div><div class="public anchor" id="var-resource-stream"><h3>resource-stream</h3><div class="usage"><code>(resource-stream path)</code></div><div class="doc"><pre class="plaintext">Loads the resource at the specified path, and returns it as an
InputStream. If there is no file at the specified path, and we
are running as a jar, we&apos;ll attempt to load the resource embedded
@@ -22,9 +22,9 @@
:keystore-file - Path to Java keystore containing any private keys and
trusted certificate authority certificates required for this connection.
-If this is empty, will use default keystore.
+If this is nil or missing, a default keystore will be used.
-:keystore-password - Password to unlock KeyStore.
+:keystore-password - Password to unlock KeyStore if keystore file is provided.
:certificate-file The path to the file containing an X509 certificate
(or certificate chain) to be used in the https connection
@@ -1,5 +1,5 @@
<!DOCTYPE html>
-<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>http.async.client.headers documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Http.async.client 1.0.1 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>http</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>async</span></div></div></li><li class="depth-3"><a href="http.async.client.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>client</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.cert.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cert</span></div></a></li><li class="depth-4 branch current"><a href="http.async.client.headers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>headers</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.part.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>part</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.request.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>request</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.status.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>status</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li><li class="depth-4"><a href="http.async.client.websocket.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>websocket</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="http.async.client.headers.html#var-convert-headers-to-map"><div class="inner"><span>convert-headers-to-map</span></div></a></li><li class="depth-1"><a href="http.async.client.headers.html#var-create-cookies"><div class="inner"><span>create-cookies</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">http.async.client.headers</h2><div class="doc"><pre class="plaintext">Asynchrounous HTTP Client - Clojure - Lazy headers
+<html><head><meta charset="UTF-8"><link href="css/default.css" rel="stylesheet" type="text/css"><script src="js/jquery.min.js" type="text/javascript"></script><script src="js/page_effects.js" type="text/javascript"></script><title>http.async.client.headers documentation</title></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html">Http.async.client 1.2.0 API documentation</a></h1></div><div class="sidebar" id="namespaces"><h3><a href="index.html"><span class="inner">Namespaces</span></a></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>http</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>async</span></div></div></li><li class="depth-3"><a href="http.async.client.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>client</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.cert.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cert</span></div></a></li><li class="depth-4 branch current"><a href="http.async.client.headers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>headers</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.part.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>part</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.request.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>request</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.status.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>status</span></div></a></li><li class="depth-4 branch"><a href="http.async.client.util.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>util</span></div></a></li><li class="depth-4"><a href="http.async.client.websocket.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>websocket</span></div></a></li></ul></div><div class="sidebar" id="vars"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="http.async.client.headers.html#var-convert-headers-to-map"><div class="inner"><span>convert-headers-to-map</span></div></a></li><li class="depth-1"><a href="http.async.client.headers.html#var-create-cookies"><div class="inner"><span>create-cookies</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h2 class="anchor" id="top">http.async.client.headers</h2><div class="doc"><pre class="plaintext">Asynchrounous HTTP Client - Clojure - Lazy headers
</pre></div><div class="public anchor" id="var-convert-headers-to-map"><h3>convert-headers-to-map</h3><div class="usage"><code>(convert-headers-to-map headers)</code></div><div class="doc"><pre class="plaintext">Converts Http Response Headers to lazy map.
</pre></div><div class="src-link"><a href="http://github.com/cch1/http.async.client/blob/master/src/clj/http/async/client/headers.clj#L31">view source</a></div></div><div class="public anchor" id="var-create-cookies"><h3>create-cookies</h3><div class="usage"><code>(create-cookies headers)</code></div><div class="doc"><pre class="plaintext">Creates cookies from headers.
</pre></div><div class="src-link"><a href="http://github.com/cch1/http.async.client/blob/master/src/clj/http/async/client/headers.clj#L63">view source</a></div></div></div></body></html>
Oops, something went wrong.

0 comments on commit 89ac7a0

Please sign in to comment.