| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SseEventSource.Builder</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SseEventSource.Builder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../jakarta/ws/rs/sse/SseEventSource.html" title="interface in jakarta.ws.rs.sse"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/sse/SseEventSource.Builder.html" target="_top">Frames</a></li> |
| <li><a href="SseEventSource.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.ws.rs.sse</div> |
| <h2 title="Class SseEventSource.Builder" class="title">Class SseEventSource.Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>jakarta.ws.rs.sse.SseEventSource.Builder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../../jakarta/ws/rs/sse/SseEventSource.html" title="interface in jakarta.ws.rs.sse">SseEventSource</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">SseEventSource.Builder</span> |
| extends java.lang.Object</pre> |
| <div class="block">JAX-RS <a href="../../../../jakarta/ws/rs/sse/SseEventSource.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSource</code></a> builder class. |
| <p> |
| Event source builder provides methods that let you conveniently configure and subsequently build a new |
| <code>SseEventSource</code> instance. You can obtain a new event source builder instance using a static |
| <a href="../../../../jakarta/ws/rs/sse/SseEventSource.html#target-jakarta.ws.rs.client.WebTarget-"><code>SseEventSource.target(endpoint)</code></a> factory method. |
| <p> |
| For example: |
| |
| <pre> |
| SseEventSource es = SseEventSource.target(endpoint) |
| .reconnectingEvery(5, SECONDS) |
| .build(); |
| es.register(System.out::println); |
| es.open(); |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html#JAXRS_DEFAULT_SSE_BUILDER_PROPERTY">JAXRS_DEFAULT_SSE_BUILDER_PROPERTY</a></span></code> |
| <div class="block">Name of the property identifying the <a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse"><code>SseEventSource.Builder</code></a> implementation to be returned from |
| <a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html#newBuilder--"><code>newBuilder()</code></a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html#Builder--">Builder</a></span>()</code> |
| <div class="block">Allows custom implementations to extend the SSE event source builder class.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../jakarta/ws/rs/sse/SseEventSource.html" title="interface in jakarta.ws.rs.sse">SseEventSource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html#build--">build</a></span>()</code> |
| <div class="block">Build new SSE event source pointing at a SSE streaming <a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client"><code>web target</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html#reconnectingEvery-long-java.util.concurrent.TimeUnit-">reconnectingEvery</a></span>(long delay, |
| java.util.concurrent.TimeUnit unit)</code> |
| <div class="block">Set the initial reconnect delay to be used by the event source.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected abstract <a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html#target-jakarta.ws.rs.client.WebTarget-">target</a></span>(<a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> endpoint)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="JAXRS_DEFAULT_SSE_BUILDER_PROPERTY"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JAXRS_DEFAULT_SSE_BUILDER_PROPERTY</h4> |
| <pre>public static final java.lang.String JAXRS_DEFAULT_SSE_BUILDER_PROPERTY</pre> |
| <div class="block">Name of the property identifying the <a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse"><code>SseEventSource.Builder</code></a> implementation to be returned from |
| <a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html#newBuilder--"><code>newBuilder()</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#jakarta.ws.rs.sse.SseEventSource.Builder.JAXRS_DEFAULT_SSE_BUILDER_PROPERTY">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Builder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Builder</h4> |
| <pre>protected Builder()</pre> |
| <div class="block">Allows custom implementations to extend the SSE event source builder class.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="target-jakarta.ws.rs.client.WebTarget-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>target</h4> |
| <pre>protected abstract <a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a> target(<a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> endpoint)</pre> |
| </li> |
| </ul> |
| <a name="reconnectingEvery-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reconnectingEvery</h4> |
| <pre>public abstract <a href="../../../../jakarta/ws/rs/sse/SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a> reconnectingEvery(long delay, |
| java.util.concurrent.TimeUnit unit)</pre> |
| <div class="block">Set the initial reconnect delay to be used by the event source. |
| <p> |
| Note that this value may be later overridden by the SSE endpoint using either a <code>retry</code> SSE event field or |
| <code>HTTP 503 + <a href="../../../../jakarta/ws/rs/core/HttpHeaders.html#RETRY_AFTER">"Retry-After"</a></code> mechanism as described in the |
| <a href="../../../../jakarta/ws/rs/sse/SseEventSource.html" title="interface in jakarta.ws.rs.sse"><code>SseEventSource</code></a> javadoc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>delay</code> - the default time to wait before attempting to recover from a connection loss.</dd> |
| <dd><code>unit</code> - time unit of the reconnect delay parameter.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>updated event source builder instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public abstract <a href="../../../../jakarta/ws/rs/sse/SseEventSource.html" title="interface in jakarta.ws.rs.sse">SseEventSource</a> build()</pre> |
| <div class="block">Build new SSE event source pointing at a SSE streaming <a href="../../../../jakarta/ws/rs/client/WebTarget.html" title="interface in jakarta.ws.rs.client"><code>web target</code></a>. |
| <p> |
| The returned event source is ready, but not <a href="../../../../jakarta/ws/rs/sse/SseEventSource.html#open--"><code>connected</code></a> to the SSE endpoint. It is |
| expected that you will manually invoke its <a href="../../../../jakarta/ws/rs/sse/SseEventSource.html#open--"><code>SseEventSource.open()</code></a> method once you are ready to start receiving SSE events. |
| In case you want to build an event source instance that is already connected to the SSE endpoint, use the event |
| source builder <a href="../../../../jakarta/ws/rs/sse/SseEventSource.html#open--"><code>SseEventSource.open()</code></a> method instead. |
| <p> |
| Once the event source is open, the incoming events are processed by the event source in an asynchronous task that |
| runs in an internal single-threaded <code>scheduled executor service</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>new event source instance, ready to be connected to the SSE endpoint.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/ws/rs/sse/SseEventSource.html#open--"><code>SseEventSource.open()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../jakarta/ws/rs/sse/SseEventSource.html" title="interface in jakarta.ws.rs.sse"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/sse/SseEventSource.Builder.html" target="_top">Frames</a></li> |
| <li><a href="SseEventSource.Builder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
