| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ServerEndpointConfig.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="ServerEndpointConfig.Builder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../javax/websocket/server/ServerEndpointConfig.html" title="interface in javax.websocket.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/websocket/server/ServerEndpointConfig.Configurator.html" title="class in javax.websocket.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/websocket/server/ServerEndpointConfig.Builder.html" target="_top">Frames</a></li> |
| <li><a href="ServerEndpointConfig.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>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">javax.websocket.server</div> |
| <h2 title="Class ServerEndpointConfig.Builder" class="title">Class ServerEndpointConfig.Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.websocket.server.ServerEndpointConfig.Builder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../javax/websocket/server/ServerEndpointConfig.html" title="interface in javax.websocket.server">ServerEndpointConfig</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static final class <span class="typeNameLabel">ServerEndpointConfig.Builder</span> |
| extends java.lang.Object</pre> |
| <div class="block">The ServerEndpointConfig.Builder is a class used for creating <a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server"><code>ServerEndpointConfig.Builder</code></a> objects for |
| the purposes of deploying a server endpoint. |
| |
| <p> |
| Here are some examples: |
| |
| <p> |
| Building a plain configuration for an endpoint with just a path. |
| |
| <pre> |
| <code> |
| ServerEndpointConfig config = ServerEndpointConfig.Builder.create(ProgrammaticEndpoint.class, "/foo").build(); |
| </code> |
| </pre> |
| |
| <p> |
| Building a configuration with no subprotocols and a custom configurator. |
| |
| <pre> |
| <code> |
| ServerEndpointConfig config = ServerEndpointConfig.Builder.create(ProgrammaticEndpoint.class, "/bar") |
| .subprotocols(subprotocols) |
| .configurator(new MyServerConfigurator()) |
| .build(); |
| </code> |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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="../../../javax/websocket/server/ServerEndpointConfig.html" title="interface in javax.websocket.server">ServerEndpointConfig</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html#build--">build</a></span>()</code> |
| <div class="block">Builds the configuration object using the current attributes that have been set on this builder object.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html#configurator-javax.websocket.server.ServerEndpointConfig.Configurator-">configurator</a></span>(<a href="../../../javax/websocket/server/ServerEndpointConfig.Configurator.html" title="class in javax.websocket.server">ServerEndpointConfig.Configurator</a> serverEndpointConfigurator)</code> |
| <div class="block">Sets the custom configurator to use on the configuration object built by this builder.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html#create-java.lang.Class-java.lang.String-">create</a></span>(java.lang.Class<?> endpointClass, |
| java.lang.String path)</code> |
| <div class="block">Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the |
| relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom |
| configurator.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html#decoders-java.util.List-">decoders</a></span>(java.util.List<java.lang.Class<? extends <a href="../../../javax/websocket/Decoder.html" title="interface in javax.websocket">Decoder</a>>> decoders)</code> |
| <div class="block">Sets the decoder implementation classes to use in the configuration.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html#encoders-java.util.List-">encoders</a></span>(java.util.List<java.lang.Class<? extends <a href="../../../javax/websocket/Encoder.html" title="interface in javax.websocket">Encoder</a>>> encoders)</code> |
| <div class="block">Sets the list of encoder implementation classes for this builder.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html#extensions-java.util.List-">extensions</a></span>(java.util.List<<a href="../../../javax/websocket/Extension.html" title="interface in javax.websocket">Extension</a>> extensions)</code> |
| <div class="block">Sets the extensions to use in the configuration.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html#subprotocols-java.util.List-">subprotocols</a></span>(java.util.List<java.lang.String> subprotocols)</code> |
| <div class="block">Sets the subprotocols to use in the configuration.</div> |
| </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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="create-java.lang.Class-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public static <a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a> create(java.lang.Class<?> endpointClass, |
| java.lang.String path)</pre> |
| <div class="block">Creates the builder with the mandatory information of the endpoint class (programmatic or annotated), the |
| relative URI or URI-template to use, and with no subprotocols, extensions, encoders, decoders or custom |
| configurator.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>endpointClass</code> - the class of the endpoint to configure</dd> |
| <dd><code>path</code> - The URI or URI template where the endpoint will be deployed. A trailing "/" will be |
| ignored and the path must begin with /.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new instance of ServerEndpointConfig.Builder</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../javax/websocket/server/ServerEndpointConfig.html" title="interface in javax.websocket.server">ServerEndpointConfig</a> build()</pre> |
| <div class="block">Builds the configuration object using the current attributes that have been set on this builder object.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new ServerEndpointConfig object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encoders-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>encoders</h4> |
| <pre>public <a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a> encoders(java.util.List<java.lang.Class<? extends <a href="../../../javax/websocket/Encoder.html" title="interface in javax.websocket">Encoder</a>>> encoders)</pre> |
| <div class="block">Sets the list of encoder implementation classes for this builder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>encoders</code> - the encoders</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decoders-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>decoders</h4> |
| <pre>public <a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a> decoders(java.util.List<java.lang.Class<? extends <a href="../../../javax/websocket/Decoder.html" title="interface in javax.websocket">Decoder</a>>> decoders)</pre> |
| <div class="block">Sets the decoder implementation classes to use in the configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>decoders</code> - the decoders</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="subprotocols-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>subprotocols</h4> |
| <pre>public <a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a> subprotocols(java.util.List<java.lang.String> subprotocols)</pre> |
| <div class="block">Sets the subprotocols to use in the configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subprotocols</code> - the subprotocols.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder instance</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="extensions-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>extensions</h4> |
| <pre>public <a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a> extensions(java.util.List<<a href="../../../javax/websocket/Extension.html" title="interface in javax.websocket">Extension</a>> extensions)</pre> |
| <div class="block">Sets the extensions to use in the configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>extensions</code> - the extensions to use.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="configurator-javax.websocket.server.ServerEndpointConfig.Configurator-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>configurator</h4> |
| <pre>public <a href="../../../javax/websocket/server/ServerEndpointConfig.Builder.html" title="class in javax.websocket.server">ServerEndpointConfig.Builder</a> configurator(<a href="../../../javax/websocket/server/ServerEndpointConfig.Configurator.html" title="class in javax.websocket.server">ServerEndpointConfig.Configurator</a> serverEndpointConfigurator)</pre> |
| <div class="block">Sets the custom configurator to use on the configuration object built by this builder.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serverEndpointConfigurator</code> - the configurator</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this builder instance</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="../../../javax/websocket/server/ServerEndpointConfig.html" title="interface in javax.websocket.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/websocket/server/ServerEndpointConfig.Configurator.html" title="class in javax.websocket.server"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/websocket/server/ServerEndpointConfig.Builder.html" target="_top">Frames</a></li> |
| <li><a href="ServerEndpointConfig.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>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> |
