| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ClientEndpointConfig</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="ClientEndpointConfig"; |
| } |
| } |
| 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/websocket/ClientEndpoint.html" title="annotation in jakarta.websocket"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/websocket/ClientEndpointConfig.Builder.html" title="class in jakarta.websocket"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/websocket/ClientEndpointConfig.html" target="_top">Frames</a></li> |
| <li><a href="ClientEndpointConfig.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.websocket</div> |
| <h2 title="Interface ClientEndpointConfig" class="title">Interface ClientEndpointConfig</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../jakarta/websocket/EndpointConfig.html" title="interface in jakarta.websocket">EndpointConfig</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ClientEndpointConfig</span> |
| extends <a href="../../jakarta/websocket/EndpointConfig.html" title="interface in jakarta.websocket">EndpointConfig</a></pre> |
| <div class="block">The ClientEndpointConfig is a special kind of endpoint configuration object that contains web socket configuration |
| information specific only to client endpoints. Developers deploying programmatic client endpoints can create |
| instances of this configuration by using a <a href="../../jakarta/websocket/ClientEndpointConfig.Builder.html" title="class in jakarta.websocket"><code>ClientEndpointConfig.Builder</code></a>. Developers can override some of the |
| configuration operations by providing an implementation of <a href="../../jakarta/websocket/ClientEndpointConfig.Configurator.html" title="class in jakarta.websocket"><code>ClientEndpointConfig.Configurator</code></a>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/websocket/ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a></span></code> |
| <div class="block">The ClientEndpointConfig.Builder is a class used for creating <a href="../../jakarta/websocket/ClientEndpointConfig.html" title="interface in jakarta.websocket"><code>ClientEndpointConfig</code></a> objects for the |
| purposes of deploying a client endpoint.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/websocket/ClientEndpointConfig.Configurator.html" title="class in jakarta.websocket">ClientEndpointConfig.Configurator</a></span></code> |
| <div class="block">The Configurator class may be extended by developers who want to provide custom configuration algorithms, such as |
| intercepting the opening handshake, or providing arbitrary methods and algorithms that can be accessed from each |
| endpoint instance configured with this configurator.</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><a href="../../jakarta/websocket/ClientEndpointConfig.Configurator.html" title="class in jakarta.websocket">ClientEndpointConfig.Configurator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/websocket/ClientEndpointConfig.html#getConfigurator--">getConfigurator</a></span>()</code> |
| <div class="block">Return the custom configurator for this configuration.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../../jakarta/websocket/Extension.html" title="interface in jakarta.websocket">Extension</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/websocket/ClientEndpointConfig.html#getExtensions--">getExtensions</a></span>()</code> |
| <div class="block">Return the extensions, in order of preference, favorite first, that this client would like to use for its |
| sessions.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/websocket/ClientEndpointConfig.html#getPreferredSubprotocols--">getPreferredSubprotocols</a></span>()</code> |
| <div class="block">Return the ordered list of sub protocols a client endpoint would like to use, in order of preference, favorite |
| first that this client would like to use for its sessions.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.jakarta.websocket.EndpointConfig"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface jakarta.websocket.<a href="../../jakarta/websocket/EndpointConfig.html" title="interface in jakarta.websocket">EndpointConfig</a></h3> |
| <code><a href="../../jakarta/websocket/EndpointConfig.html#getDecoders--">getDecoders</a>, <a href="../../jakarta/websocket/EndpointConfig.html#getEncoders--">getEncoders</a>, <a href="../../jakarta/websocket/EndpointConfig.html#getUserProperties--">getUserProperties</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPreferredSubprotocols--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPreferredSubprotocols</h4> |
| <pre>java.util.List<java.lang.String> getPreferredSubprotocols()</pre> |
| <div class="block">Return the ordered list of sub protocols a client endpoint would like to use, in order of preference, favorite |
| first that this client would like to use for its sessions. This list is used to generate the |
| Sec-WebSocket-Protocol header in the opening handshake for clients using this configuration. The first protocol |
| name is the most preferred. See <a href="http://tools.ietf.org/html/rfc6455#section-4.1">Client Opening |
| Handshake</a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of the preferred subprotocols, the empty list if there are none</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExtensions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExtensions</h4> |
| <pre>java.util.List<<a href="../../jakarta/websocket/Extension.html" title="interface in jakarta.websocket">Extension</a>> getExtensions()</pre> |
| <div class="block">Return the extensions, in order of preference, favorite first, that this client would like to use for its |
| sessions. These are the extensions that will be used to populate the Sec-WebSocket-Extensions header in the |
| opening handshake for clients using this configuration. The first extension in the list is the most preferred |
| extension. See <a href="http://tools.ietf.org/html/rfc6455#section-9.1">Negotiating Extensions</a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of extensions, the empty list if there are none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfigurator--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getConfigurator</h4> |
| <pre><a href="../../jakarta/websocket/ClientEndpointConfig.Configurator.html" title="class in jakarta.websocket">ClientEndpointConfig.Configurator</a> getConfigurator()</pre> |
| <div class="block">Return the custom configurator for this configuration. If the developer did not provide one, the platform default |
| configurator is returned.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configurator in use with this configuration.</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/websocket/ClientEndpoint.html" title="annotation in jakarta.websocket"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/websocket/ClientEndpointConfig.Builder.html" title="class in jakarta.websocket"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/websocket/ClientEndpointConfig.html" target="_top">Frames</a></li> |
| <li><a href="ClientEndpointConfig.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
