apidocs/3.0.0/jakarta/ws/rs/sse/SseEventSource.Builder.html - third_party/jakartaee/rest - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.2) on Wed Sep 23 17:36:24 GMT 2020 -->
 <title>SseEventSource.Builder (jakarta.ws.rs-api 3.0.0 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2020-09-23">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="SseEventSource.Builder (jakarta.ws.rs-api 3.0.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"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";
 var pathtoroot = "../../../../";
 var useModuleDirectories = true;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/SseEventSource.Builder.html">Use</a></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" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <ul class="navListSearch">
 <li><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">jakarta.ws.rs.sse</a></div>
 <h2 title="Class SseEventSource.Builder" class="title">Class SseEventSource.Builder</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></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="SseEventSource.html" title="interface in jakarta.ws.rs.sse">SseEventSource</a></dd>
 </dl>
 <hr>
 <pre>public abstract static class <span class="typeNameLabel">SseEventSource.Builder</span>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
 <div class="block">JAX-RS <a href="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="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 =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="memberSummary">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Field</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JAXRS_DEFAULT_SSE_BUILDER_PROPERTY">JAXRS_DEFAULT_SSE_BUILDER_PROPERTY</a></span></code></th>
 <td class="colLast">
 <div class="block">Name of the property identifying the <a href="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse"><code>SseEventSource.Builder</code></a> implementation to be returned from
  <a href="#newBuilder()"><code>newBuilder()</code></a>.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier</th>
 <th class="colSecond" scope="col">Constructor</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected </code></td>
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Builder</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Allows custom implementations to extend the SSE event source builder class.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>abstract <a href="SseEventSource.html" title="interface in jakarta.ws.rs.sse">SseEventSource</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Build new SSE event source pointing at a SSE streaming <a href="../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="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectingEvery(long,java.util.concurrent.TimeUnit)">reconnectingEvery</a></span>&#8203;(long&nbsp;delay,
                  <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;unit)</code></th>
 <td class="colLast">
 <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="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#target(jakarta.ws.rs.client.WebTarget)">target</a></span>&#8203;(<a href="../client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a>&nbsp;endpoint)</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a id="JAXRS_DEFAULT_SSE_BUILDER_PROPERTY">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>JAXRS_DEFAULT_SSE_BUILDER_PROPERTY</h4>
 <pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> JAXRS_DEFAULT_SSE_BUILDER_PROPERTY</pre>
 <div class="block">Name of the property identifying the <a href="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse"><code>SseEventSource.Builder</code></a> implementation to be returned from
  <a href="#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>
 </section>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a id="&lt;init&gt;()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>Builder</h4>
 <pre>protected&nbsp;Builder()</pre>
 <div class="block">Allows custom implementations to extend the SSE event source builder class.</div>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="target(jakarta.ws.rs.client.WebTarget)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>target</h4>
 <pre class="methodSignature">protected abstract&nbsp;<a href="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a>&nbsp;target&#8203;(<a href="../client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a>&nbsp;endpoint)</pre>
 </li>
 </ul>
 <a id="reconnectingEvery(long,java.util.concurrent.TimeUnit)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>reconnectingEvery</h4>
 <pre class="methodSignature">public abstract&nbsp;<a href="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a>&nbsp;reconnectingEvery&#8203;(long&nbsp;delay,
                                                          <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;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="../core/HttpHeaders.html#RETRY_AFTER">"Retry-After"</a></code> mechanism as described in the
  <a href="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 id="build()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>build</h4>
 <pre class="methodSignature">public abstract&nbsp;<a href="SseEventSource.html" title="interface in jakarta.ws.rs.sse">SseEventSource</a>&nbsp;build()</pre>
 <div class="block">Build new SSE event source pointing at a SSE streaming <a href="../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="SseEventSource.html#open()"><code>connected</code></a> to the SSE endpoint. It is
  expected that you will manually invoke its <a href="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="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 <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>scheduled executor service</code></a>.</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="SseEventSource.html#open()"><code>SseEventSource.open()</code></a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/SseEventSource.Builder.html">Use</a></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" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.html">All&nbsp;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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small><p align="left">Copyright &#169; 2018, 2020 Eclipse Foundation.<br>Use is subject to <a href="../../../../resources/EFSL.html" target="_top">license terms</a>.</small></p>
 </footer>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc (11.0.2) on Wed Sep 23 17:36:24 GMT 2020 -->
	<title>SseEventSource.Builder (jakarta.ws.rs-api 3.0.0 API)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<meta name="dc.created" content="2020-09-23">
	<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
	<script type="text/javascript" src="../../../../script.js"></script>
	<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
	<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
	<!--[if IE]>
	<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
	<![endif]-->
	<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
	<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
	<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="SseEventSource.Builder (jakarta.ws.rs-api 3.0.0 API)";
	}
	}
	catch(err) {
	}
	//-->
	var data = {"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";
	var pathtoroot = "../../../../";
	var useModuleDirectories = true;
	loadScripts(document, 'script');</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<header role="banner">
	<nav role="navigation">
	<div class="fixedNav">
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a id="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/SseEventSource.Builder.html">Use</a></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" id="allclasses_navbar_top">
	<li><a href="../../../../allclasses.html">All Classes</a></li>
	</ul>
	<ul class="navListSearch">
	<li><label for="search">SEARCH:</label>
	<input type="text" id="search" value="search" disabled="disabled">
	<input type="reset" id="reset" value="reset" disabled="disabled">
	</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>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	</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 id="skip.navbar.top">
	<!-- -->
	</a></div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	</div>
	<div class="navPadding"> </div>
	<script type="text/javascript"><!--
	$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
	//-->
	</script>
	</nav>
	</header>
	<!-- ======== START OF CLASS DATA ======== -->
	<main role="main">
	<div class="header">
	<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">jakarta.ws.rs.sse</a></div>
	<h2 title="Class SseEventSource.Builder" class="title">Class SseEventSource.Builder</h2>
	</div>
	<div class="contentContainer">
	<ul class="inheritance">
	<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></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="SseEventSource.html" title="interface in jakarta.ws.rs.sse">SseEventSource</a></dd>
	</dl>
	<hr>
	<pre>public abstract static class <span class="typeNameLabel">SseEventSource.Builder</span>
	extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
	<div class="block">JAX-RS <a href="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="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 =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="field.summary">
	<!-- -->
	</a>
	<h3>Field Summary</h3>
	<table class="memberSummary">
	<caption><span>Fields</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colSecond" scope="col">Field</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JAXRS_DEFAULT_SSE_BUILDER_PROPERTY">JAXRS_DEFAULT_SSE_BUILDER_PROPERTY</a></span></code></th>
	<td class="colLast">
	<div class="block">Name of the property identifying the <a href="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse"><code>SseEventSource.Builder</code></a> implementation to be returned from
	<a href="#newBuilder()"><code>newBuilder()</code></a>.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</section>
	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="constructor.summary">
	<!-- -->
	</a>
	<h3>Constructor Summary</h3>
	<table class="memberSummary">
	<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier</th>
	<th class="colSecond" scope="col">Constructor</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>protected </code></td>
	<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Builder</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Allows custom implementations to extend the SSE event source builder class.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</section>
	<!-- ========== METHOD SUMMARY =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="method.summary">
	<!-- -->
	</a>
	<h3>Method Summary</h3>
	<table class="memberSummary">
	<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="colSecond" scope="col">Method</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	<tr id="i0" class="altColor">
	<td class="colFirst"><code>abstract <a href="SseEventSource.html" title="interface in jakarta.ws.rs.sse">SseEventSource</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Build new SSE event source pointing at a SSE streaming <a href="../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="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reconnectingEvery(long,java.util.concurrent.TimeUnit)">reconnectingEvery</a></span>(long delay,
	<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a> unit)</code></th>
	<td class="colLast">
	<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="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#target(jakarta.ws.rs.client.WebTarget)">target</a></span>(<a href="../client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> endpoint)</code></th>
	<td class="colLast"> </td>
	</tr>
	</table>
	<ul class="blockList">
	<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
	<!-- -->
	</a>
	<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
	<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
	</ul>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ FIELD DETAIL =========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="field.detail">
	<!-- -->
	</a>
	<h3>Field Detail</h3>
	<a id="JAXRS_DEFAULT_SSE_BUILDER_PROPERTY">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>JAXRS_DEFAULT_SSE_BUILDER_PROPERTY</h4>
	<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> JAXRS_DEFAULT_SSE_BUILDER_PROPERTY</pre>
	<div class="block">Name of the property identifying the <a href="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse"><code>SseEventSource.Builder</code></a> implementation to be returned from
	<a href="#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>
	</section>
	<!-- ========= CONSTRUCTOR DETAIL ======== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="constructor.detail">
	<!-- -->
	</a>
	<h3>Constructor Detail</h3>
	<a id="<init>()">
	<!-- -->
	</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>
	</section>
	<!-- ============ METHOD DETAIL ========== -->
	<section role="region">
	<ul class="blockList">
	<li class="blockList"><a id="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a id="target(jakarta.ws.rs.client.WebTarget)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>target</h4>
	<pre class="methodSignature">protected abstract <a href="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a> target(<a href="../client/WebTarget.html" title="interface in jakarta.ws.rs.client">WebTarget</a> endpoint)</pre>
	</li>
	</ul>
	<a id="reconnectingEvery(long,java.util.concurrent.TimeUnit)">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>reconnectingEvery</h4>
	<pre class="methodSignature">public abstract <a href="SseEventSource.Builder.html" title="class in jakarta.ws.rs.sse">SseEventSource.Builder</a> reconnectingEvery(long delay,
	<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a> 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="../core/HttpHeaders.html#RETRY_AFTER">"Retry-After"</a></code> mechanism as described in the
	<a href="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 id="build()">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>build</h4>
	<pre class="methodSignature">public abstract <a href="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="../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="SseEventSource.html#open()"><code>connected</code></a> to the SSE endpoint. It is
	expected that you will manually invoke its <a href="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="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 <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>scheduled executor service</code></a>.</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="SseEventSource.html#open()"><code>SseEventSource.open()</code></a></dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	</section>
	</li>
	</ul>
	</div>
	</div>
	</main>
	<!-- ========= END OF CLASS DATA ========= -->
	<footer role="contentinfo">
	<nav role="navigation">
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a id="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="class-use/SseEventSource.Builder.html">Use</a></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" id="allclasses_navbar_bottom">
	<li><a href="../../../../allclasses.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>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	</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 id="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</nav>
	<p class="legalCopy"><small><p align="left">Copyright © 2018, 2020 Eclipse Foundation.<br>Use is subject to <a href="../../../../resources/EFSL.html" target="_top">license terms</a>.</small></p>
	</footer>
	</body>
	</html>