diff options
| author | Robert Jaros <rjaros@finn.pl> | 2018-10-22 00:01:39 +0200 |
|---|---|---|
| committer | Robert Jaros <rjaros@finn.pl> | 2018-10-22 00:01:39 +0200 |
| commit | eb930482e9972a21d39f2aea8b813acf58ff5b64 (patch) | |
| tree | 1c64052b39527aca51793860894baa37791cc94f /api/pl.treksoft.kvision.remote/-security-mgr | |
| parent | 7c2850063697f94a0d8b8d8f8588136dd4b3d05e (diff) | |
| download | kvision-eb930482e9972a21d39f2aea8b813acf58ff5b64.tar.gz kvision-eb930482e9972a21d39f2aea8b813acf58ff5b64.tar.bz2 kvision-eb930482e9972a21d39f2aea8b813acf58ff5b64.zip | |
API documentation for KVision 0.0.19
Diffstat (limited to 'api/pl.treksoft.kvision.remote/-security-mgr')
6 files changed, 152 insertions, 0 deletions
diff --git a/api/pl.treksoft.kvision.remote/-security-mgr/-init-.html b/api/pl.treksoft.kvision.remote/-security-mgr/-init-.html new file mode 100644 index 00000000..4e31e55d --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-security-mgr/-init-.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>SecurityMgr.<init> - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="index.html">SecurityMgr</a> / <a href="./-init-.html"><init></a><br/> +<br/> +<h1><init></h1> +<a name="pl.treksoft.kvision.remote.SecurityMgr$<init>()"></a> +<code><span class="identifier">SecurityMgr</span><span class="symbol">(</span><span class="symbol">)</span></code> +<p>Pac4j form login dispatcher.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.remote/-security-mgr/after-error.html b/api/pl.treksoft.kvision.remote/-security-mgr/after-error.html new file mode 100644 index 00000000..68c357da --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-security-mgr/after-error.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>SecurityMgr.afterError - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="index.html">SecurityMgr</a> / <a href="./after-error.html">afterError</a><br/> +<br/> +<h1>afterError</h1> +<a name="pl.treksoft.kvision.remote.SecurityMgr$afterError()"></a> +<code><span class="keyword">open</span> <span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">afterError</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Method called after error.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.remote/-security-mgr/after-login.html b/api/pl.treksoft.kvision.remote/-security-mgr/after-login.html new file mode 100644 index 00000000..f018290f --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-security-mgr/after-login.html @@ -0,0 +1,15 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>SecurityMgr.afterLogin - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="index.html">SecurityMgr</a> / <a href="./after-login.html">afterLogin</a><br/> +<br/> +<h1>afterLogin</h1> +<a name="pl.treksoft.kvision.remote.SecurityMgr$afterLogin()"></a> +<code><span class="keyword">open</span> <span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">afterLogin</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Method called after successful login.</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.remote/-security-mgr/index.html b/api/pl.treksoft.kvision.remote/-security-mgr/index.html new file mode 100644 index 00000000..2c1b3d96 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-security-mgr/index.html @@ -0,0 +1,69 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>SecurityMgr - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="./index.html">SecurityMgr</a><br/> +<br/> +<h1>SecurityMgr</h1> +<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">SecurityMgr</span></code> +<p>Pac4j form login dispatcher.</p> +<h3>Constructors</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="-init-.html"><init></a></p> +</td> +<td> +<code><span class="identifier">SecurityMgr</span><span class="symbol">(</span><span class="symbol">)</span></code> +<p>Pac4j form login dispatcher.</p> +</td> +</tr> +</tbody> +</table> +<h3>Functions</h3> +<table> +<tbody> +<tr> +<td> +<p><a href="after-error.html">afterError</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">afterError</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Method called after error.</p> +</td> +</tr> +<tr> +<td> +<p><a href="after-login.html">afterLogin</a></p> +</td> +<td> +<code><span class="keyword">open</span> <span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">afterLogin</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html"><span class="identifier">Unit</span></a></code> +<p>Method called after successful login.</p> +</td> +</tr> +<tr> +<td> +<p><a href="login.html">login</a></p> +</td> +<td> +<code><span class="keyword">abstract</span> <span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">login</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> +<p>Login user.</p> +</td> +</tr> +<tr> +<td> +<p><a href="with-auth.html">withAuth</a></p> +</td> +<td> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">withAuth</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.SecurityMgr$withAuth(kotlin.SuspendFunction0((pl.treksoft.kvision.remote.SecurityMgr.withAuth.T)))/block">block</span><span class="symbol">:</span> <span class="keyword">suspend </span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="with-auth.html#T"><span class="identifier">T</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="with-auth.html#T"><span class="identifier">T</span></a></code> +<p>Executes given block of code after successful authentication.</p> +</td> +</tr> +</tbody> +</table> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.remote/-security-mgr/login.html b/api/pl.treksoft.kvision.remote/-security-mgr/login.html new file mode 100644 index 00000000..a859fdd1 --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-security-mgr/login.html @@ -0,0 +1,20 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>SecurityMgr.login - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="index.html">SecurityMgr</a> / <a href="./login.html">login</a><br/> +<br/> +<h1>login</h1> +<a name="pl.treksoft.kvision.remote.SecurityMgr$login()"></a> +<code><span class="keyword">abstract</span> <span class="keyword">suspend</span> <span class="keyword">fun </span><span class="identifier">login</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html"><span class="identifier">Boolean</span></a></code> +<p>Login user.</p> +<h3>Exceptions</h3> +<p><a name="SecurityException"></a> +<code>SecurityException</code> - if login is not successful</p> +<p><strong>Return</strong><br/> +true if login is successful</p> +</BODY> +</HTML> diff --git a/api/pl.treksoft.kvision.remote/-security-mgr/with-auth.html b/api/pl.treksoft.kvision.remote/-security-mgr/with-auth.html new file mode 100644 index 00000000..cf76923e --- /dev/null +++ b/api/pl.treksoft.kvision.remote/-security-mgr/with-auth.html @@ -0,0 +1,18 @@ +<HTML> +<HEAD> +<meta charset="UTF-8"> +<title>SecurityMgr.withAuth - kvision</title> +<link rel="stylesheet" href="../../../style.css"> +</HEAD> +<BODY> +<a href="../../index.html">kvision</a> / <a href="../index.html">pl.treksoft.kvision.remote</a> / <a href="index.html">SecurityMgr</a> / <a href="./with-auth.html">withAuth</a><br/> +<br/> +<h1>withAuth</h1> +<a name="pl.treksoft.kvision.remote.SecurityMgr$withAuth(kotlin.SuspendFunction0((pl.treksoft.kvision.remote.SecurityMgr.withAuth.T)))"></a> +<code><span class="keyword">suspend</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">withAuth</span><span class="symbol">(</span><span class="identifier" id="pl.treksoft.kvision.remote.SecurityMgr$withAuth(kotlin.SuspendFunction0((pl.treksoft.kvision.remote.SecurityMgr.withAuth.T)))/block">block</span><span class="symbol">:</span> <span class="keyword">suspend </span><span class="symbol">(</span><span class="symbol">)</span> <span class="symbol">-></span> <a href="with-auth.html#T"><span class="identifier">T</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="with-auth.html#T"><span class="identifier">T</span></a></code> +<p>Executes given block of code after successful authentication.</p> +<h3>Parameters</h3> +<p><a name="block"></a> +<code>block</code> - a block of code</p> +</BODY> +</HTML> |