whoas/docs/html5/groovydoc/index-all.html

475 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<!-- Generated by groovydoc (2.4.0) on -->
<title>Index (whoas 0.1.4 API)</title>
<meta name="date" content="2015-03-19">
<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.4 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="./index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No Frames</a></li>
</ul>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer">
<a href="#_A_">A</a>
<a href="#_B_">B</a>
<a href="#_C_">C</a>
<a href="#_D_">D</a>
<a href="#_E_">E</a>
<a href="#_F_">F</a>
<a href="#_G_">G</a>
<a href="#_H_">H</a>
<a href="#_I_">I</a>
<a href="#_J_">J</a>
<a href="#_K_">K</a>
<a href="#_L_">L</a>
<a href="#_M_">M</a>
<a href="#_N_">N</a>
<a href="#_O_">O</a>
<a href="#_P_">P</a>
<a href="#_Q_">Q</a>
<a href="#_R_">R</a>
<a href="#_S_">S</a>
<a href="#_T_">T</a>
<a href="#_U_">U</a>
<a href="#_V_">V</a>
<a href="#_W_">W</a>
<a href="#_X_">X</a>
<a href="#_Y_">Y</a>
<a href="#_Z_">Z</a>
<a href="#___">_</a>
<a name="_A_"><!-- --></a>
<h2 class="title">A</h2>
<dl>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookQueue.html" title="Class in com.github.lookout.whoas">AbstractHookQueue</a></span> - Class in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
</dt><dd><div class="block">Interface defining how 'HookQueue' providers should behave</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookRunner.html" title="Class in com.github.lookout.whoas">AbstractHookRunner</a></span> - Class in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
</dt><dd><div class="block"></div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookRunner.html#AbstractHookRunner(com.github.lookout.whoas.AbstractHookQueue, com.github.lookout.whoas.Publisher)" title="Constructor in AbstractHookRunner">AbstractHookRunner(AbstractHookQueue, Publisher)</a></span> - Constructor in <a href="com/github/lookout/whoas/AbstractHookRunner.html">AbstractHookRunner</a>
</dt><dd> <div class="block"></div></dd>
</dl>
<a name="_B_"><!-- --></a>
<h2 class="title">B</h2>
<dl>
<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>
<a name="_C_"><!-- --></a>
<h2 class="title">C</h2>
<dl>
</dl>
<a name="_D_"><!-- --></a>
<h2 class="title">D</h2>
<dl>
</dl>
<a name="_E_"><!-- --></a>
<h2 class="title">E</h2>
<dl>
</dl>
<a name="_F_"><!-- --></a>
<h2 class="title">F</h2>
<dl>
</dl>
<a name="_G_"><!-- --></a>
<h2 class="title">G</h2>
<dl>
<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/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>
<dt><span class="strong"><a href="com/github/lookout/whoas/InMemoryQueue.html#getSize()" title="Method in InMemoryQueue">getSize()</a></span> - Method in <a href="com/github/lookout/whoas/InMemoryQueue.html">InMemoryQueue</a>
</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/RedisQueue.html#getSize()" title="Method in RedisQueue">getSize()</a></span> - Method in <a href="com/github/lookout/whoas/RedisQueue.html">RedisQueue</a>
</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/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>
<a name="_H_"><!-- --></a>
<h2 class="title">H</h2>
<dl>
<dt><span class="strong"><a href="com/github/lookout/whoas/HookRequest.html" title="Class in com.github.lookout.whoas">HookRequest</a></span> - Class in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
</dt><dd><div class="block"></div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/HookRequest.html#HookRequest(java.lang.String, java.lang.String)" title="Constructor in HookRequest">HookRequest(String, String)</a></span> - Constructor in <a href="com/github/lookout/whoas/HookRequest.html">HookRequest</a>
</dt><dd> <div class="block">Default constructor for creating a simple HookRequest with a URL and the
POST data to be delivered to that URL</div></dd>
</dl>
<a name="_I_"><!-- --></a>
<h2 class="title">I</h2>
<dl>
<dt><span class="strong"><a href="com/github/lookout/whoas/InMemoryQueue.html" title="Class in com.github.lookout.whoas">InMemoryQueue</a></span> - Class in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
</dt><dd><div class="block">A simple in-memory queue that offers no persistence between process restarts</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/InMemoryQueue.html#InMemoryQueue(Queue<HookRequest>)" title="Constructor in InMemoryQueue">InMemoryQueue(Queue&lt;HookRequest&gt;)</a></span> - Constructor in <a href="com/github/lookout/whoas/InMemoryQueue.html">InMemoryQueue</a>
</dt><dd> <div class="block">Create the InMemoryQueue with the given Queue object</div></dd>
</dl>
<a name="_J_"><!-- --></a>
<h2 class="title">J</h2>
<dl>
</dl>
<a name="_K_"><!-- --></a>
<h2 class="title">K</h2>
<dl>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookRunner.html#keepGoing" title="Field in AbstractHookRunner">keepGoing</a></span> - Field in <a href="com/github/lookout/whoas/AbstractHookRunner.html">AbstractHookRunner</a>
</dt><dd> <div class="block"></div></dd>
</dl>
<a name="_L_"><!-- --></a>
<h2 class="title">L</h2>
<dl>
</dl>
<a name="_M_"><!-- --></a>
<h2 class="title">M</h2>
<dl>
</dl>
<a name="_N_"><!-- --></a>
<h2 class="title">N</h2>
<dl>
</dl>
<a name="_O_"><!-- --></a>
<h2 class="title">O</h2>
<dl>
</dl>
<a name="_P_"><!-- --></a>
<h2 class="title">P</h2>
<dl>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookQueue.html#pop(groovy.lang.Closure)" title="Method in AbstractHookQueue">pop(Closure)</a></span> - Method in <a href="com/github/lookout/whoas/AbstractHookQueue.html">AbstractHookQueue</a>
</dt><dd> <div class="block"></div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/InMemoryQueue.html#pop(groovy.lang.Closure)" title="Method in InMemoryQueue">pop(Closure)</a></span> - Method in <a href="com/github/lookout/whoas/InMemoryQueue.html">InMemoryQueue</a>
</dt><dd> <div class="block">Performs a blocking pop on the queue and invokes the closure with the
item popped from the queue</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/RedisQueue.html#pop(groovy.lang.Closure)" title="Method in RedisQueue">pop(Closure)</a></span> - Method in <a href="com/github/lookout/whoas/RedisQueue.html">RedisQueue</a>
</dt><dd> <div class="block">Performs a blocking pop on the queue and invokes the closure with the
item popped from the queue</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/Publisher.html#publish(com.github.lookout.whoas.HookRequest)" title="Method in Publisher">publish(HookRequest)</a></span> - Method in <a href="com/github/lookout/whoas/Publisher.html">Publisher</a>
</dt><dd> <div class="block">Publish the request using the appropriate backoff and retry logic
defined in the Whoas documentation</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/Publisher.html" title="Class in com.github.lookout.whoas">Publisher</a></span> - Class in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
</dt><dd><div class="block">Publisher is the class responsible for implementing the *actual* HTTP
request logic for Whoas</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookRunner.html#publisher" title="Field in AbstractHookRunner">publisher</a></span> - Field 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/Publisher.html#Publisher()" title="Constructor in Publisher">Publisher()</a></span> - Constructor in <a href="com/github/lookout/whoas/Publisher.html">Publisher</a>
</dt><dd> <div class="block"></div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookQueue.html#push(com.github.lookout.whoas.HookRequest)" title="Method in AbstractHookQueue">push(HookRequest)</a></span> - Method in <a href="com/github/lookout/whoas/AbstractHookQueue.html">AbstractHookQueue</a>
</dt><dd> <div class="block"></div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/InMemoryQueue.html#push(com.github.lookout.whoas.HookRequest)" title="Method in InMemoryQueue">push(HookRequest)</a></span> - Method in <a href="com/github/lookout/whoas/InMemoryQueue.html">InMemoryQueue</a>
</dt><dd> <div class="block">Attempt to insert the request into the queue</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/RedisQueue.html#push(com.github.lookout.whoas.HookRequest)" title="Method in RedisQueue">push(HookRequest)</a></span> - Method in <a href="com/github/lookout/whoas/RedisQueue.html">RedisQueue</a>
</dt><dd> <div class="block">The blpop returns list of strings (key and value)</div></dd>
</dl>
<a name="_Q_"><!-- --></a>
<h2 class="title">Q</h2>
<dl>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookRunner.html#queue" title="Field in AbstractHookRunner">queue</a></span> - Field in <a href="com/github/lookout/whoas/AbstractHookRunner.html">AbstractHookRunner</a>
</dt><dd> <div class="block"></div></dd>
</dl>
<a name="_R_"><!-- --></a>
<h2 class="title">R</h2>
<dl>
<dt><span class="strong"><a href="com/github/lookout/whoas/RedisQueue.html" title="Class in com.github.lookout.whoas">RedisQueue</a></span> - Class in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
</dt><dd><div class="block">A redis queue that offers distributed and persistent queue</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/RedisQueue.html#RedisQueue()" title="Constructor in RedisQueue">RedisQueue()</a></span> - Constructor in <a href="com/github/lookout/whoas/RedisQueue.html">RedisQueue</a>
</dt><dd> <div class="block">Default constructor</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookRunner.html#run()" title="Method in AbstractHookRunner">run()</a></span> - Method in <a href="com/github/lookout/whoas/AbstractHookRunner.html">AbstractHookRunner</a>
</dt><dd> <div class="block">Block forever and run the runner's runloop.</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/SequentialHookRunner.html#run()" title="Method in SequentialHookRunner">run()</a></span> - Method in <a href="com/github/lookout/whoas/SequentialHookRunner.html">SequentialHookRunner</a>
</dt><dd> <div class="block">Execute an infinitely blocking single-threaded runloop</div></dd>
</dl>
<a name="_S_"><!-- --></a>
<h2 class="title">S</h2>
<dl>
<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/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/AbstractHookQueue.html#start()" title="Method in AbstractHookQueue">start()</a></span> - Method in <a href="com/github/lookout/whoas/AbstractHookQueue.html">AbstractHookQueue</a>
</dt><dd> <div class="block"></div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/RedisQueue.html#start()" title="Method in RedisQueue">start()</a></span> - Method in <a href="com/github/lookout/whoas/RedisQueue.html">RedisQueue</a>
</dt><dd> <div class="block">Setup the Redis client</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookQueue.html#started" title="Field in AbstractHookQueue">started</a></span> - Field in <a href="com/github/lookout/whoas/AbstractHookQueue.html">AbstractHookQueue</a>
</dt><dd> <div class="block"></div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/AbstractHookQueue.html#stop()" title="Method in AbstractHookQueue">stop()</a></span> - Method in <a href="com/github/lookout/whoas/AbstractHookQueue.html">AbstractHookQueue</a>
</dt><dd> <div class="block"></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>
</dt><dd> <div class="block">Tell the runloop to stop</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/RedisQueue.html#stop()" title="Method in RedisQueue">stop()</a></span> - Method in <a href="com/github/lookout/whoas/RedisQueue.html">RedisQueue</a>
</dt><dd> <div class="block">Setup jedis pool</div></dd>
</dl>
<a name="_T_"><!-- --></a>
<h2 class="title">T</h2>
<dl>
</dl>
<a name="_U_"><!-- --></a>
<h2 class="title">U</h2>
<dl>
</dl>
<a name="_V_"><!-- --></a>
<h2 class="title">V</h2>
<dl>
</dl>
<a name="_W_"><!-- --></a>
<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>
<dt><span class="strong"><a href="com/github/lookout/whoas/WhoasQueueConfig.html" title="Class in com.github.lookout.whoas">WhoasQueueConfig</a></span> - Class in <a href="./com/github/lookout/whoas/package-summary.html">com.github.lookout.whoas</a>
</dt><dd><div class="block">Whoas Queue Configuration</div></dd>
<dt><span class="strong"><a href="com/github/lookout/whoas/RedisQueue.html#withRedis(groovy.lang.Closure)" title="Method in RedisQueue">withRedis(Closure)</a></span> - Method in <a href="com/github/lookout/whoas/RedisQueue.html">RedisQueue</a>
</dt><dd> <div class="block"></div></dd>
</dl>
<a name="_X_"><!-- --></a>
<h2 class="title">X</h2>
<dl>
</dl>
<a name="_Y_"><!-- --></a>
<h2 class="title">Y</h2>
<dl>
</dl>
<a name="_Z_"><!-- --></a>
<h2 class="title">Z</h2>
<dl>
</dl>
<a name="___"><!-- --></a>
<h2 class="title">_</h2>
<dl>
</dl>
</div>
<a href="#_A_">A</a>
<a href="#_B_">B</a>
<a href="#_C_">C</a>
<a href="#_D_">D</a>
<a href="#_E_">E</a>
<a href="#_F_">F</a>
<a href="#_G_">G</a>
<a href="#_H_">H</a>
<a href="#_I_">I</a>
<a href="#_J_">J</a>
<a href="#_K_">K</a>
<a href="#_L_">L</a>
<a href="#_M_">M</a>
<a href="#_N_">N</a>
<a href="#_O_">O</a>
<a href="#_P_">P</a>
<a href="#_Q_">Q</a>
<a href="#_R_">R</a>
<a href="#_S_">S</a>
<a href="#_T_">T</a>
<a href="#_U_">U</a>
<a href="#_V_">V</a>
<a href="#_W_">W</a>
<a href="#_X_">X</a>
<a href="#_Y_">Y</a>
<a href="#_Z_">Z</a>
<a href="#___">_</a>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="./index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No Frames</a></li>
</ul>
<div class="aboutLanguage"><em>Groovy Documentation</em></div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>