mirror of https://github.com/reiseburo/whoas
Minor documentation update
This commit is contained in:
parent
ac7b449a11
commit
a702b21f75
|
@ -5,7 +5,6 @@
|
|||
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="generator" content="Asciidoctor 1.5.0">
|
||||
<meta name="author" content="If clients of whoas library don't have any whoas configuration, the whoas factory will create">
|
||||
<title>Default behavior</title>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic|Noto+Serif:400,400italic,700,700italic|Droid+Sans+Mono:400">
|
||||
<style>
|
||||
|
@ -503,33 +502,45 @@ table.CodeRay td.code>pre{padding:0}
|
|||
</head>
|
||||
<body class="article toc2 toc-right">
|
||||
<div id="header">
|
||||
<h1>Default behavior</h1>
|
||||
<div class="details">
|
||||
<span id="author" class="author">If clients of whoas library don't have any whoas configuration, the whoas factory will create</span><br>
|
||||
<span id="revdate">InMemoryQueue and SequentialHookRunner</span>
|
||||
</div>
|
||||
<div id="toc" class="toc2">
|
||||
<div id="toctitle">Table of Contents</div>
|
||||
<ul class="sectlevel0">
|
||||
<ul class="sectlevel1">
|
||||
<li><a href="#_default_behavior">Default behavior</a></li>
|
||||
<li><a href="#_library_configuration">Library Configuration</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div id="content">
|
||||
<h1 id="_library_configuration" class="sect0">Library Configuration</h1>
|
||||
<div class="sect1">
|
||||
<h2 id="_default_behavior">Default behavior</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph">
|
||||
<p>If clients of whoas library don’t have any whoas configuration, the whoas factory will create
|
||||
InMemoryQueue that is a simple in memory FIFO with non blocking push and blocking pop operations and
|
||||
SequentialHookRunner that has run loop around queue pop and publishes the hook requests.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_library_configuration">Library Configuration</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph">
|
||||
<p>The clients of whoas library can add "whoas" configuration to build queue and runner of their choice.
|
||||
See the example below</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>whos:
|
||||
<div class="listingblock">
|
||||
<div class="content">
|
||||
<pre>whoas:
|
||||
queueType: "com.github.lookout.whoas.Queue"
|
||||
runnerType: "com.github.lookout.whoas.SequentialHookRunner"</p>
|
||||
runnerType: "com.github.lookout.whoas.SequentialHookRunner"</pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="footer">
|
||||
<div id="footer-text">
|
||||
Last updated 2015-03-18 10:18:32 EDT
|
||||
Last updated 2015-03-18 08:48:36 PDT
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
|
|
|
@ -18,6 +18,8 @@
|
|||
<li><a href="com/github/lookout/whoas/InMemoryQueue.html" title="class in com.github.lookout.whoas" target="classFrame">InMemoryQueue</a></li>
|
||||
<li><a href="com/github/lookout/whoas/Publisher.html" title="class in com.github.lookout.whoas" target="classFrame">Publisher</a></li>
|
||||
<li><a href="com/github/lookout/whoas/SequentialHookRunner.html" title="class in com.github.lookout.whoas" target="classFrame">SequentialHookRunner</a></li>
|
||||
<li><a href="com/github/lookout/whoas/WhoasConfiguration.html" title="interface in com.github.lookout.whoas" target="classFrame"><I>WhoasConfiguration</I></a></li>
|
||||
<li><a href="com/github/lookout/whoas/WhoasFactory.html" title="class in com.github.lookout.whoas" target="classFrame">WhoasFactory</a></li>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
@ -6,9 +6,9 @@
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<!-- Generated by groovydoc (2.3.9) on Fri Jan 02 12:14:16 PST 2015 -->
|
||||
<title>AbstractHookQueue (whoas 0.1.2 API)</title>
|
||||
<meta name="date" content="2015-01-02">
|
||||
<!-- Generated by groovydoc (2.4.0) on Wed Mar 18 10:01:26 PDT 2015 -->
|
||||
<title>AbstractHookQueue (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
|
||||
|
@ -17,7 +17,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="AbstractHookQueue (whoas 0.1.2 API)";
|
||||
parent.document.title="AbstractHookQueue (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
|
|
@ -6,9 +6,9 @@
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<!-- Generated by groovydoc (2.3.9) on Fri Jan 02 12:14:16 PST 2015 -->
|
||||
<title>AbstractHookRunner (whoas 0.1.2 API)</title>
|
||||
<meta name="date" content="2015-01-02">
|
||||
<!-- Generated by groovydoc (2.4.0) on Wed Mar 18 10:01:26 PDT 2015 -->
|
||||
<title>AbstractHookRunner (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
|
||||
|
@ -17,7 +17,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="AbstractHookRunner (whoas 0.1.2 API)";
|
||||
parent.document.title="AbstractHookRunner (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
|
|
@ -6,9 +6,9 @@
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<!-- Generated by groovydoc (2.3.9) on Fri Jan 02 12:14:17 PST 2015 -->
|
||||
<title>HookRequest (whoas 0.1.2 API)</title>
|
||||
<meta name="date" content="2015-01-02">
|
||||
<!-- Generated by groovydoc (2.4.0) on Wed Mar 18 10:01:26 PDT 2015 -->
|
||||
<title>HookRequest (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
|
||||
|
@ -17,7 +17,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="HookRequest (whoas 0.1.2 API)";
|
||||
parent.document.title="HookRequest (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
|
|
@ -6,9 +6,9 @@
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<!-- Generated by groovydoc (2.3.9) on Fri Jan 02 12:14:17 PST 2015 -->
|
||||
<title>InMemoryQueue (whoas 0.1.2 API)</title>
|
||||
<meta name="date" content="2015-01-02">
|
||||
<!-- Generated by groovydoc (2.4.0) on Wed Mar 18 10:01:26 PDT 2015 -->
|
||||
<title>InMemoryQueue (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
|
||||
|
@ -17,7 +17,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="InMemoryQueue (whoas 0.1.2 API)";
|
||||
parent.document.title="InMemoryQueue (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
|
|
@ -6,9 +6,9 @@
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<!-- Generated by groovydoc (2.3.9) on Fri Jan 02 12:14:17 PST 2015 -->
|
||||
<title>Publisher (whoas 0.1.2 API)</title>
|
||||
<meta name="date" content="2015-01-02">
|
||||
<!-- Generated by groovydoc (2.4.0) on Wed Mar 18 10:01:26 PDT 2015 -->
|
||||
<title>Publisher (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
|
||||
|
@ -17,7 +17,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="Publisher (whoas 0.1.2 API)";
|
||||
parent.document.title="Publisher (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
|
|
@ -6,9 +6,9 @@
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<!-- Generated by groovydoc (2.3.9) on Fri Jan 02 12:14:17 PST 2015 -->
|
||||
<title>SequentialHookRunner (whoas 0.1.2 API)</title>
|
||||
<meta name="date" content="2015-01-02">
|
||||
<!-- Generated by groovydoc (2.4.0) on Wed Mar 18 10:01:26 PDT 2015 -->
|
||||
<title>SequentialHookRunner (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="icon">
|
||||
|
@ -17,7 +17,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="SequentialHookRunner (whoas 0.1.2 API)";
|
||||
parent.document.title="SequentialHookRunner (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
|
|
@ -6,8 +6,8 @@
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<!-- Generated by groovydoc (2.3.9) on Wed Mar 18 10:19:48 EDT 2015 -->
|
||||
<title>WhoasConfiguration (whoas 0.1.2 API)</title>
|
||||
<!-- Generated by groovydoc (2.4.0) on Wed Mar 18 10:01:26 PDT 2015 -->
|
||||
<title>WhoasConfiguration (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
|
@ -17,7 +17,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="WhoasConfiguration (whoas 0.1.2 API)";
|
||||
parent.document.title="WhoasConfiguration (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
|
|
@ -6,8 +6,8 @@
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<!-- Generated by groovydoc (2.3.9) on Wed Mar 18 10:19:48 EDT 2015 -->
|
||||
<title>WhoasFactory (whoas 0.1.2 API)</title>
|
||||
<!-- Generated by groovydoc (2.4.0) on Wed Mar 18 10:01:26 PDT 2015 -->
|
||||
<title>WhoasFactory (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link href="../../../../groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
|
@ -17,7 +17,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="WhoasFactory (whoas 0.1.2 API)";
|
||||
parent.document.title="WhoasFactory (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
@ -290,7 +290,7 @@ java.lang.String <strong>runnerType</strong></h4>
|
|||
InstantiationException - if this Class represents an abstract class, an interface,
|
||||
an array class, a primitive type, or void;
|
||||
or if the class has no nullary constructor;
|
||||
or if the instantiation fails for some other reason. <DL><DT><B>Parameters:</B></DT><DD><code>hookQueue</code> - queue to associate with allocated runner</DD></DL><DL><DT><B>Returns:</B></DT><DD></DD></DL></p>
|
||||
or if the instantiation fails for some other reason. <DL><DT><B>Returns:</B></DT><DD></DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>hookQueue</code> - queue to associate with allocated runner</DD></DL></p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
@ -325,7 +325,7 @@ java.lang.String <strong>runnerType</strong></h4>
|
|||
<ul class="blockListLast">
|
||||
<li class="blockList">
|
||||
<h4>java.lang.Object <strong>setRunnerType</strong>(java.lang.String runnerType)</h4>
|
||||
<p> Set function for runner type in the factory <DL><DT><B>Parameters:</B></DT><DD><code>runnerType</code> - type of the runner to store</DD></DL><DL><DT><B>Returns:</B></DT><DD></DD></DL></p>
|
||||
<p> Set function for runner type in the factory <DL><DT><B>Returns:</B></DT><DD></DD></DL><DL><DT><B>Parameters:</B></DT><DD><code>runnerType</code> - type of the runner to store</DD></DL></p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
|
|
@ -18,12 +18,20 @@
|
|||
|
||||
|
||||
|
||||
<div class="indexContainer">
|
||||
<h2>Interfaces</h2>
|
||||
<ul>
|
||||
<li><a href="WhoasConfiguration.html" title="interface in com.github.lookout.whoas" target="classFrame"><em>WhoasConfiguration</em></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="indexContainer">
|
||||
<h2>Classes</h2>
|
||||
<ul>
|
||||
<li><a href="AbstractHookQueue.html" title="class in com.github.lookout.whoas" target="classFrame">AbstractHookQueue</a></li><li><a href="AbstractHookRunner.html" title="class in com.github.lookout.whoas" target="classFrame">AbstractHookRunner</a></li><li><a href="HookRequest.html" title="class in com.github.lookout.whoas" target="classFrame">HookRequest</a></li><li><a href="InMemoryQueue.html" title="class in com.github.lookout.whoas" target="classFrame">InMemoryQueue</a></li><li><a href="Publisher.html" title="class in com.github.lookout.whoas" target="classFrame">Publisher</a></li><li><a href="SequentialHookRunner.html" title="class in com.github.lookout.whoas" target="classFrame">SequentialHookRunner</a></li>
|
||||
<li><a href="AbstractHookQueue.html" title="class in com.github.lookout.whoas" target="classFrame">AbstractHookQueue</a></li><li><a href="AbstractHookRunner.html" title="class in com.github.lookout.whoas" target="classFrame">AbstractHookRunner</a></li><li><a href="HookRequest.html" title="class in com.github.lookout.whoas" target="classFrame">HookRequest</a></li><li><a href="InMemoryQueue.html" title="class in com.github.lookout.whoas" target="classFrame">InMemoryQueue</a></li><li><a href="Publisher.html" title="class in com.github.lookout.whoas" target="classFrame">Publisher</a></li><li><a href="SequentialHookRunner.html" title="class in com.github.lookout.whoas" target="classFrame">SequentialHookRunner</a></li><li><a href="WhoasFactory.html" title="class in com.github.lookout.whoas" target="classFrame">WhoasFactory</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
<html>
|
||||
<head>
|
||||
|
||||
<title>com.github.lookout.whoas (whoas 0.1.2 API)</title>
|
||||
<title>com.github.lookout.whoas (whoas 0.1.4 API)</title>
|
||||
<meta name="keywords" content="com.github.lookout.whoas package">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link rel ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" title="Style">
|
||||
|
@ -11,7 +11,7 @@
|
|||
<script type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
parent.document.title="com.github.lookout.whoas (whoas 0.1.2 API)";
|
||||
parent.document.title="com.github.lookout.whoas (whoas 0.1.4 API)";
|
||||
}
|
||||
</script>
|
||||
<noscript>
|
||||
|
@ -58,6 +58,33 @@ function windowTitle()
|
|||
<div class="contentContainer">
|
||||
|
||||
|
||||
<div class="summary">
|
||||
<ul class="blockList">
|
||||
<li class="blockList">
|
||||
<table border="0" cellpadding="3" cellspacing="0" summary="Interface Summary">
|
||||
<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption>
|
||||
<tbody>
|
||||
<tr>
|
||||
<th class="colFirst" scope="col">Interface</th>
|
||||
<th class="colLast" scope="col">Description</th>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne">
|
||||
<strong><a href="WhoasConfiguration.html" title="class in com/github/lookout/whoas">
|
||||
WhoasConfiguration
|
||||
</a></strong>
|
||||
</td>
|
||||
<td>The interface to create the whoas factory based on configuration
|
||||
The client of whoas will call with the configuration to create the whoas factory.</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="summary">
|
||||
|
@ -120,6 +147,16 @@ function windowTitle()
|
|||
<td>The SequentialHookRunner is will dequeue HookRequest items from the
|
||||
configured AbstractHookQueue and publish those webhooks sequentially.</td>
|
||||
</tr>
|
||||
<tr class="altColor">
|
||||
<td class="colOne">
|
||||
<strong><a href="WhoasFactory.html" title="class in com/github/lookout/whoas">
|
||||
WhoasFactory
|
||||
</a></strong>
|
||||
</td>
|
||||
<td>This factory will allow clients of whoas to build
|
||||
different queues like in memory, persistent etc and runners
|
||||
like sequential.</td>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
@ -3,9 +3,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<!-- Generated by groovydoc (2.3.9) on -->
|
||||
<title>Deprecated API (whoas 0.1.2 API)</title>
|
||||
<meta name="date" content="2015-01-02">
|
||||
<!-- Generated by groovydoc (2.4.0) on -->
|
||||
<title>Deprecated API (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
<link href="groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
<link href="groovy.ico" type="image/x-icon" rel="icon">
|
||||
|
@ -14,7 +14,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="Deprecated API (whoas 0.1.2 API)";
|
||||
parent.document.title="Deprecated API (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
|
|
@ -4,17 +4,17 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<!-- Generated by groovydoc (2.3.9) on -->
|
||||
<title>API Help (whoas 0.1.2 API)</title>
|
||||
<!-- Generated by groovydoc (2.4.0) on -->
|
||||
<title>API Help (whoas 0.1.4 API)</title>
|
||||
<link href="groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
<link href="groovy.ico" type="image/x-icon" rel="icon">
|
||||
<meta name="date" content="2015-01-02">
|
||||
<meta name="date" content="2015-03-18">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="API Help (whoas 0.1.2 API)";
|
||||
parent.document.title="API Help (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
|
|
@ -3,15 +3,15 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<!-- Generated by groovydoc (2.3.9) on -->
|
||||
<title>Index (whoas 0.1.2 API)</title>
|
||||
<meta name="date" content="2015-01-02">
|
||||
<!-- Generated by groovydoc (2.4.0) on -->
|
||||
<title>Index (whoas 0.1.4 API)</title>
|
||||
<meta name="date" content="2015-03-18">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
</head>
|
||||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="Index (whoas 0.1.2 API)";
|
||||
parent.document.title="Index (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
@ -121,6 +121,10 @@ if (location.href.indexOf('is-external=true') == -1) {
|
|||
<dt><span class="strong"><a href="com/github/lookout/whoas/Publisher.html#backoffSleep(java.lang.Long)" title="Method in Publisher">backoffSleep(Long)</a></span> - Method in <a href="com/github/lookout/whoas/Publisher.html">Publisher</a>
|
||||
</dt><dd> <div class="block">Sleep the current thread the appropriate amount of time for the
|
||||
attemptNumber</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasFactory.html#buildQueue()" title="Method in WhoasFactory">buildQueue()</a></span> - Method in <a href="com/github/lookout/whoas/WhoasFactory.html">WhoasFactory</a>
|
||||
</dt><dd> <div class="block">Allocate and return the queue based on stored queue type.</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasFactory.html#buildRunner(com.github.lookout.whoas.AbstractHookQueue)" title="Method in WhoasFactory">buildRunner(AbstractHookQueue)</a></span> - Method in <a href="com/github/lookout/whoas/WhoasFactory.html">WhoasFactory</a>
|
||||
</dt><dd> <div class="block">Allocate and return runner based on stored runner type</div></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
@ -162,8 +166,12 @@ if (location.href.indexOf('is-external=true') == -1) {
|
|||
</dt><dd> <div class="block"></div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookRunner.html#getPublisher()" title="Method in AbstractHookRunner">getPublisher()</a></span> - Method in <a href="com/github/lookout/whoas/AbstractHookRunner.html">AbstractHookRunner</a>
|
||||
</dt><dd> <div class="block"></div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasFactory.html#getQueueType()" title="Method in WhoasFactory">getQueueType()</a></span> - Method in <a href="com/github/lookout/whoas/WhoasFactory.html">WhoasFactory</a>
|
||||
</dt><dd> <div class="block">Get function for queue type in the factory</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/HookRequest.html#getRetries()" title="Method in HookRequest">getRetries()</a></span> - Method in <a href="com/github/lookout/whoas/HookRequest.html">HookRequest</a>
|
||||
</dt><dd> <div class="block"></div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasFactory.html#getRunnerType()" title="Method in WhoasFactory">getRunnerType()</a></span> - Method in <a href="com/github/lookout/whoas/WhoasFactory.html">WhoasFactory</a>
|
||||
</dt><dd> <div class="block">Get function for runner type in the factory</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookQueue.html#getSize()" title="Method in AbstractHookQueue">getSize()</a></span> - Method in <a href="com/github/lookout/whoas/AbstractHookQueue.html">AbstractHookQueue</a>
|
||||
</dt><dd> <div class="block">Return the size of the queue, may not be implemented by some providers
|
||||
in which case it will return -1</div></dd>
|
||||
|
@ -171,6 +179,8 @@ if (location.href.indexOf('is-external=true') == -1) {
|
|||
</dt><dd> <div class="block">Return the number of elements in the queue</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/HookRequest.html#getUrl()" title="Method in HookRequest">getUrl()</a></span> - Method in <a href="com/github/lookout/whoas/HookRequest.html">HookRequest</a>
|
||||
</dt><dd> <div class="block"></div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasConfiguration.html#getWhoasFactory(T)" title="Method in WhoasConfiguration">getWhoasFactory(T)</a></span> - Method in <a href="com/github/lookout/whoas/WhoasConfiguration.html">WhoasConfiguration</a>
|
||||
</dt><dd> <div class="block"></div></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
@ -294,8 +304,12 @@ if (location.href.indexOf('is-external=true') == -1) {
|
|||
<dt><span class="strong"><a href="com/github/lookout/whoas/SequentialHookRunner.html" title="Class in com.github.lookout.whoas">SequentialHookRunner</a></span> - Class in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
|
||||
</dt><dd><div class="block">The SequentialHookRunner is will dequeue HookRequest items from the
|
||||
configured AbstractHookQueue and publish those webhooks sequentially.</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasFactory.html#setQueueType(java.lang.String)" title="Method in WhoasFactory">setQueueType(String)</a></span> - Method in <a href="com/github/lookout/whoas/WhoasFactory.html">WhoasFactory</a>
|
||||
</dt><dd> <div class="block">Set function for the queue type in the factory</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/HookRequest.html#setRetries(java.lang.Long)" title="Method in HookRequest">setRetries(Long)</a></span> - Method in <a href="com/github/lookout/whoas/HookRequest.html">HookRequest</a>
|
||||
</dt><dd> <div class="block"></div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasFactory.html#setRunnerType(java.lang.String)" title="Method in WhoasFactory">setRunnerType(String)</a></span> - Method in <a href="com/github/lookout/whoas/WhoasFactory.html">WhoasFactory</a>
|
||||
</dt><dd> <div class="block">Set function for runner type in the factory</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/Publisher.html#shouldRetry(javax.ws.rs.core.Response)" title="Method in Publisher">shouldRetry(Response)</a></span> - Method in <a href="com/github/lookout/whoas/Publisher.html">Publisher</a>
|
||||
</dt><dd> <div class="block">Determine whether this response meets our criteria for retry</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookRunner.html#stop()" title="Method in AbstractHookRunner">stop()</a></span> - Method in <a href="com/github/lookout/whoas/AbstractHookRunner.html">AbstractHookRunner</a>
|
||||
|
@ -328,6 +342,13 @@ if (location.href.indexOf('is-external=true') == -1) {
|
|||
<h2 class="title">W</h2>
|
||||
<dl>
|
||||
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasConfiguration.html" title="Interface in com.github.lookout.whoas">WhoasConfiguration</a></span> - Interface in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
|
||||
</dt><dd><div class="block">The interface to create the whoas factory based on configuration
|
||||
The client of whoas will call with the configuration to create the whoas factory.</div></dd>
|
||||
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasFactory.html" title="Class in com.github.lookout.whoas">WhoasFactory</a></span> - Class in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
|
||||
</dt><dd><div class="block">This factory will allow clients of whoas to build
|
||||
different queues like in memory, persistent etc and runners
|
||||
like sequential.</div></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>Index (whoas 0.1.2 API)</title>
|
||||
<title>Index (whoas 0.1.4 API)</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<link href="groovy.ico" type="image/x-icon" rel="shortcut icon">
|
||||
<link href="groovy.ico" type="image/x-icon" rel="icon">
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<html>
|
||||
<head>
|
||||
<title>Overview (whoas 0.1.2 API)</title>
|
||||
<title>Overview (whoas 0.1.4 API)</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="keywords" content="Overview">
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
<html>
|
||||
<head>
|
||||
<title>Overview (whoas 0.1.2 API)</title>
|
||||
<title>Overview (whoas 0.1.4 API)</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<meta name="keywords" content="Overview">
|
||||
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
|
@ -12,7 +12,7 @@
|
|||
<body class="center">
|
||||
<script type="text/javascript"><!--
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="Overview (whoas 0.1.2 API)";
|
||||
parent.document.title="Overview (whoas 0.1.4 API)";
|
||||
}
|
||||
//-->
|
||||
</script>
|
||||
|
@ -46,7 +46,7 @@ if (location.href.indexOf('is-external=true') == -1) {
|
|||
</a></div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<div class="header">
|
||||
<h1 class="title">whoas 0.1.2 API</h1>
|
||||
<h1 class="title">whoas 0.1.4 API</h1>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
|
|
Loading…
Reference in New Issue