Skip to content

Commit 6cb127d

Browse files
github-actions[bot]github-actions[bot]
committed
chore: Updating docs for lib/java-server-sdk-redis-store
1 parent a7d9a6a commit 6cb127d

File tree

16 files changed

+2756
-0
lines changed

16 files changed

+2756
-0
lines changed

‎lib/java-server-sdk-redis-store/allclasses-frame.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>All Classes (launchdarkly-java-server-sdk-redis-store 3.1.0 API)</title>
7+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
8+
<script type="text/javascript" src="script.js"></script>
9+
</head>
10+
<body>
11+
<h1 class="bar">All&nbsp;Classes</h1>
12+
<div class="indexContainer">
13+
<ul>
14+
<li><a href="com/launchdarkly/sdk/server/integrations/Redis.html" title="class in com.launchdarkly.sdk.server.integrations" target="classFrame">Redis</a></li>
15+
<li><a href="com/launchdarkly/sdk/server/integrations/RedisStoreBuilder.html" title="class in com.launchdarkly.sdk.server.integrations" target="classFrame">RedisStoreBuilder</a></li>
16+
</ul>
17+
</div>
18+
</body>
19+
</html>

‎lib/java-server-sdk-redis-store/allclasses-noframe.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>All Classes (launchdarkly-java-server-sdk-redis-store 3.1.0 API)</title>
7+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
8+
<script type="text/javascript" src="script.js"></script>
9+
</head>
10+
<body>
11+
<h1 class="bar">All&nbsp;Classes</h1>
12+
<div class="indexContainer">
13+
<ul>
14+
<li><a href="com/launchdarkly/sdk/server/integrations/Redis.html" title="class in com.launchdarkly.sdk.server.integrations">Redis</a></li>
15+
<li><a href="com/launchdarkly/sdk/server/integrations/RedisStoreBuilder.html" title="class in com.launchdarkly.sdk.server.integrations">RedisStoreBuilder</a></li>
16+
</ul>
17+
</div>
18+
</body>
19+
</html>

‎lib/java-server-sdk-redis-store/com/launchdarkly/sdk/server/integrations/Redis.html‎

Lines changed: 323 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,323 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>Redis (launchdarkly-java-server-sdk-redis-store 3.1.0 API)</title>
7+
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
8+
<script type="text/javascript" src="../../../../../script.js"></script>
9+
</head>
10+
<body>
11+
<script type="text/javascript"><!--
12+
try {
13+
if (location.href.indexOf('is-external=true') == -1) {
14+
parent.document.title="Redis (launchdarkly-java-server-sdk-redis-store 3.1.0 API)";
15+
}
16+
}
17+
catch(err) {
18+
}
19+
//-->
20+
var methods = {"i0":9,"i1":9};
21+
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
22+
var altColor = "altColor";
23+
var rowColor = "rowColor";
24+
var tableTab = "tableTab";
25+
var activeTableTab = "activeTableTab";
26+
</script>
27+
<noscript>
28+
<div>JavaScript is disabled on your browser.</div>
29+
</noscript>
30+
<!-- ========= START OF TOP NAVBAR ======= -->
31+
<div class="topNav"><a name="navbar.top">
32+
<!-- -->
33+
</a>
34+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
35+
<a name="navbar.top.firstrow">
36+
<!-- -->
37+
</a>
38+
<ul class="navList" title="Navigation">
39+
<li><a href="../../../../../com/launchdarkly/sdk/server/integrations/package-summary.html">Package</a></li>
40+
<li class="navBarCell1Rev">Class</li>
41+
<li><a href="package-tree.html">Tree</a></li>
42+
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
43+
<li><a href="../../../../../index-all.html">Index</a></li>
44+
<li><a href="../../../../../help-doc.html">Help</a></li>
45+
</ul>
46+
</div>
47+
<div class="subNav">
48+
<ul class="navList">
49+
<li>Prev&nbsp;Class</li>
50+
<li><a href="../../../../../com/launchdarkly/sdk/server/integrations/RedisStoreBuilder.html" title="class in com.launchdarkly.sdk.server.integrations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
51+
</ul>
52+
<ul class="navList">
53+
<li><a href="../../../../../index.html?com/launchdarkly/sdk/server/integrations/Redis.html" target="_top">Frames</a></li>
54+
<li><a href="Redis.html" target="_top">No&nbsp;Frames</a></li>
55+
</ul>
56+
<ul class="navList" id="allclasses_navbar_top">
57+
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
58+
</ul>
59+
<div>
60+
<script type="text/javascript"><!--
61+
allClassesLink = document.getElementById("allclasses_navbar_top");
62+
if(window==top) {
63+
allClassesLink.style.display = "block";
64+
}
65+
else {
66+
allClassesLink.style.display = "none";
67+
}
68+
//-->
69+
</script>
70+
</div>
71+
<div>
72+
<ul class="subNavList">
73+
<li>Summary:&nbsp;</li>
74+
<li>Nested&nbsp;|&nbsp;</li>
75+
<li>Field&nbsp;|&nbsp;</li>
76+
<li>Constr&nbsp;|&nbsp;</li>
77+
<li><a href="#method.summary">Method</a></li>
78+
</ul>
79+
<ul class="subNavList">
80+
<li>Detail:&nbsp;</li>
81+
<li>Field&nbsp;|&nbsp;</li>
82+
<li>Constr&nbsp;|&nbsp;</li>
83+
<li><a href="#method.detail">Method</a></li>
84+
</ul>
85+
</div>
86+
<a name="skip.navbar.top">
87+
<!-- -->
88+
</a></div>
89+
<!-- ========= END OF TOP NAVBAR ========= -->
90+
<!-- ======== START OF CLASS DATA ======== -->
91+
<div class="header">
92+
<div class="subTitle">com.launchdarkly.sdk.server.integrations</div>
93+
<h2 title="Class Redis" class="title">Class Redis</h2>
94+
</div>
95+
<div class="contentContainer">
96+
<ul class="inheritance">
97+
<li>java.lang.Object</li>
98+
<li>
99+
<ul class="inheritance">
100+
<li>com.launchdarkly.sdk.server.integrations.Redis</li>
101+
</ul>
102+
</li>
103+
</ul>
104+
<div class="description">
105+
<ul class="blockList">
106+
<li class="blockList">
107+
<hr>
108+
<br>
109+
<pre>public abstract class <span class="typeNameLabel">Redis</span>
110+
extends java.lang.Object</pre>
111+
<div class="block">Integration between the LaunchDarkly SDK and Redis.</div>
112+
<dl>
113+
<dt><span class="simpleTagLabel">Since:</span></dt>
114+
<dd>4.12.0</dd>
115+
</dl>
116+
</li>
117+
</ul>
118+
</div>
119+
<div class="summary">
120+
<ul class="blockList">
121+
<li class="blockList">
122+
<!-- ========== METHOD SUMMARY =========== -->
123+
<ul class="blockList">
124+
<li class="blockList"><a name="method.summary">
125+
<!-- -->
126+
</a>
127+
<h3>Method Summary</h3>
128+
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
129+
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
130+
<tr>
131+
<th class="colFirst" scope="col">Modifier and Type</th>
132+
<th class="colLast" scope="col">Method and Description</th>
133+
</tr>
134+
<tr id="i0" class="altColor">
135+
<td class="colFirst"><code>static <a href="../../../../../com/launchdarkly/sdk/server/integrations/RedisStoreBuilder.html" title="class in com.launchdarkly.sdk.server.integrations">RedisStoreBuilder</a>&lt;com.launchdarkly.sdk.server.subsystems.BigSegmentStore&gt;</code></td>
136+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/launchdarkly/sdk/server/integrations/Redis.html#bigSegmentStore--">bigSegmentStore</a></span>()</code>
137+
<div class="block">Returns a builder object for creating a Redis-backed Big Segment store.</div>
138+
</td>
139+
</tr>
140+
<tr id="i1" class="rowColor">
141+
<td class="colFirst"><code>static <a href="../../../../../com/launchdarkly/sdk/server/integrations/RedisStoreBuilder.html" title="class in com.launchdarkly.sdk.server.integrations">RedisStoreBuilder</a>&lt;com.launchdarkly.sdk.server.subsystems.PersistentDataStore&gt;</code></td>
142+
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/launchdarkly/sdk/server/integrations/Redis.html#dataStore--">dataStore</a></span>()</code>
143+
<div class="block">Returns a builder object for creating a Redis-backed persistent data store.</div>
144+
</td>
145+
</tr>
146+
</table>
147+
<ul class="blockList">
148+
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
149+
<!-- -->
150+
</a>
151+
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
152+
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
153+
</ul>
154+
</li>
155+
</ul>
156+
</li>
157+
</ul>
158+
</div>
159+
<div class="details">
160+
<ul class="blockList">
161+
<li class="blockList">
162+
<!-- ============ METHOD DETAIL ========== -->
163+
<ul class="blockList">
164+
<li class="blockList"><a name="method.detail">
165+
<!-- -->
166+
</a>
167+
<h3>Method Detail</h3>
168+
<a name="dataStore--">
169+
<!-- -->
170+
</a>
171+
<ul class="blockList">
172+
<li class="blockList">
173+
<h4>dataStore</h4>
174+
<pre>public static&nbsp;<a href="../../../../../com/launchdarkly/sdk/server/integrations/RedisStoreBuilder.html" title="class in com.launchdarkly.sdk.server.integrations">RedisStoreBuilder</a>&lt;com.launchdarkly.sdk.server.subsystems.PersistentDataStore&gt;&nbsp;dataStore()</pre>
175+
<div class="block">Returns a builder object for creating a Redis-backed persistent data store.
176+
<p>
177+
This is for the main data store that holds feature flag data. To configure a
178+
Big Segment store, use <a href="../../../../../com/launchdarkly/sdk/server/integrations/Redis.html#bigSegmentStore--"><code>bigSegmentStore()</code></a> instead.
179+
<p>
180+
You can use methods of the builder to specify any non-default Redis options
181+
you may want, before passing the builder to <code>Components.persistentDataStore(ComponentConfigurer)</code>.
182+
In this example, the store is configured to use a Redis host called "host1":
183+
<pre><code>
184+
LDConfig config = new LDConfig.Builder()
185+
.dataStore(
186+
Components.persistentDataStore(
187+
Redis.dataStore().uri(URI.create("redis://host1:6379")
188+
)
189+
)
190+
.build();
191+
</code></pre>
192+
<p>
193+
Note that the SDK also has its own options related to data storage that are configured
194+
at a different level, because they are independent of what database is being used. For
195+
instance, the builder returned by <code>Components.persistentDataStore(ComponentConfigurer)</code>
196+
has options for caching:
197+
<pre><code>
198+
LDConfig config = new LDConfig.Builder()
199+
.dataStore(
200+
Components.persistentDataStore(
201+
Redis.dataStore().uri(URI.create("redis://my-redis-host"))
202+
).cacheSeconds(15)
203+
)
204+
.build();
205+
</code></pre></div>
206+
<dl>
207+
<dt><span class="returnLabel">Returns:</span></dt>
208+
<dd>a data store configuration object</dd>
209+
</dl>
210+
</li>
211+
</ul>
212+
<a name="bigSegmentStore--">
213+
<!-- -->
214+
</a>
215+
<ul class="blockListLast">
216+
<li class="blockList">
217+
<h4>bigSegmentStore</h4>
218+
<pre>public static&nbsp;<a href="../../../../../com/launchdarkly/sdk/server/integrations/RedisStoreBuilder.html" title="class in com.launchdarkly.sdk.server.integrations">RedisStoreBuilder</a>&lt;com.launchdarkly.sdk.server.subsystems.BigSegmentStore&gt;&nbsp;bigSegmentStore()</pre>
219+
<div class="block">Returns a builder object for creating a Redis-backed Big Segment store.
220+
<p>
221+
You can use methods of the builder to specify any non-default Redis options
222+
you may want, before passing the builder to <code>Components.bigSegments(ComponentConfigurer)</code>.
223+
In this example, the store is configured to use a Redis host called "host2":
224+
<pre><code>
225+
LDConfig config = new LDConfig.Builder()
226+
.bigSegments(
227+
Components.bigSegments(
228+
Redis.bigSegmentStore().uri(URI.create("redis://host2:6379")
229+
)
230+
)
231+
.build();
232+
</code></pre>
233+
<p>
234+
Note that the SDK also has its own options related to Big Segments that are configured
235+
at a different level, because they are independent of what database is being used. For
236+
instance, the builder returned by <code>Components.bigSegments(ComponentConfigurer)</code>
237+
has an option for the status polling interval:
238+
<pre><code>
239+
LDConfig config = new LDConfig.Builder()
240+
.dataStore(
241+
Components.bigSegments(
242+
Redis.bigSegmentStore().uri(URI.create("redis://my-redis-host"))
243+
).statusPollInterval(Duration.ofSeconds(30))
244+
)
245+
.build();
246+
</code></pre></div>
247+
<dl>
248+
<dt><span class="returnLabel">Returns:</span></dt>
249+
<dd>a Big Segment store configuration object</dd>
250+
<dt><span class="simpleTagLabel">Since:</span></dt>
251+
<dd>3.0.0</dd>
252+
</dl>
253+
</li>
254+
</ul>
255+
</li>
256+
</ul>
257+
</li>
258+
</ul>
259+
</div>
260+
</div>
261+
<!-- ========= END OF CLASS DATA ========= -->
262+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
263+
<div class="bottomNav"><a name="navbar.bottom">
264+
<!-- -->
265+
</a>
266+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
267+
<a name="navbar.bottom.firstrow">
268+
<!-- -->
269+
</a>
270+
<ul class="navList" title="Navigation">
271+
<li><a href="../../../../../com/launchdarkly/sdk/server/integrations/package-summary.html">Package</a></li>
272+
<li class="navBarCell1Rev">Class</li>
273+
<li><a href="package-tree.html">Tree</a></li>
274+
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
275+
<li><a href="../../../../../index-all.html">Index</a></li>
276+
<li><a href="../../../../../help-doc.html">Help</a></li>
277+
</ul>
278+
</div>
279+
<div class="subNav">
280+
<ul class="navList">
281+
<li>Prev&nbsp;Class</li>
282+
<li><a href="../../../../../com/launchdarkly/sdk/server/integrations/RedisStoreBuilder.html" title="class in com.launchdarkly.sdk.server.integrations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
283+
</ul>
284+
<ul class="navList">
285+
<li><a href="../../../../../index.html?com/launchdarkly/sdk/server/integrations/Redis.html" target="_top">Frames</a></li>
286+
<li><a href="Redis.html" target="_top">No&nbsp;Frames</a></li>
287+
</ul>
288+
<ul class="navList" id="allclasses_navbar_bottom">
289+
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
290+
</ul>
291+
<div>
292+
<script type="text/javascript"><!--
293+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
294+
if(window==top) {
295+
allClassesLink.style.display = "block";
296+
}
297+
else {
298+
allClassesLink.style.display = "none";
299+
}
300+
//-->
301+
</script>
302+
</div>
303+
<div>
304+
<ul class="subNavList">
305+
<li>Summary:&nbsp;</li>
306+
<li>Nested&nbsp;|&nbsp;</li>
307+
<li>Field&nbsp;|&nbsp;</li>
308+
<li>Constr&nbsp;|&nbsp;</li>
309+
<li><a href="#method.summary">Method</a></li>
310+
</ul>
311+
<ul class="subNavList">
312+
<li>Detail:&nbsp;</li>
313+
<li>Field&nbsp;|&nbsp;</li>
314+
<li>Constr&nbsp;|&nbsp;</li>
315+
<li><a href="#method.detail">Method</a></li>
316+
</ul>
317+
</div>
318+
<a name="skip.navbar.bottom">
319+
<!-- -->
320+
</a></div>
321+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
322+
</body>
323+
</html>

0 commit comments

Comments
 (0)