blob: 0bf7bbfe62d9c4fba9341febe76a08b61259a35f [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<title>New WebSocket Endpoint Wizard: Create WebSocket Endpoint</title>
<link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/>
</head>
<body>
<p><a id="org.netbeans.modules.websocket.wizard.WebSocketPanel" name="org.netbeans.modules.websocket.wizard.WebSocketPanel"></a></p>
<div id="NBCSH4126"><!-- infolevel="all" infotype="General" --><a id="sthref547" name="sthref547"></a>
<h1>New WebSocket Endpoint Wizard: Create WebSocket Endpoint</h1>
<a name="BEGIN" id="BEGIN"></a>
<p>Use to create a new WebSocket endpoint and specify the class name and WebSocket URI of the endpoint.
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG2966">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<p>In the Create WebSocket Endpoint panel, you set the following properties:</p>
<table summary="User interface elements and descriptions" dir="ltr" border="1" width="100%" frame="hsides" rules="groups" cellpadding="3" cellspacing="0">
<col width="24%" />
<col width="*" />
<thead>
<tr align="left" valign="top">
<th align="left" valign="bottom" id="r1c1-t53">Element</th>
<th align="left" valign="bottom" id="r1c2-t53">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t53" headers="r1c1-t53">
<p>Class Name</p>
</td>
<td align="left" headers="r2c1-t53 r1c2-t53">Specifies the class name of the WebSocket endpoint. The IDE names the class <code dir="ltr">NewWSEndpoint</code> by default.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t53" headers="r1c1-t53">
<p>Project</p>
</td>
<td align="left" headers="r3c1-t53 r1c2-t53">Specifies the project where the endpoint is located. You cannot change this value.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t53" headers="r1c1-t53">
<p>Location</p>
</td>
<td align="left" headers="r4c1-t53 r1c2-t53">Specifies the location where you want to store the new class.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t53" headers="r1c1-t53">
<p>Package</p>
</td>
<td align="left" headers="r5c1-t53 r1c2-t53">Specifies the package where you want to store the file containing the WebSocket endpoint class. Select the package from the drop down list.
<p><b>Warning:</b> It is highly recommended that you do not place Java classes in the default package.</p>
</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t53" headers="r1c1-t53">
<p>Created File</p>
</td>
<td align="left" headers="r6c1-t53 r1c2-t53">Specifies the file created containing the endpoint. The name of the file is identical to the class name.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t53" headers="r1c1-t53">
<p>WebSocket URI</p>
</td>
<td align="left" headers="r7c1-t53 r1c2-t53">Specifies the URI that is the name of the new endpoint.</td>
</tr>
</tbody>
</table>
<br />
<!-- -->
<p>When you click <b>Finish</b>, the IDE creates the class based on the parameters that you specified. The new class appears in the Project window under the package-name node.</p>
<a id="NBCSH4133" name="NBCSH4133"></a>
<hr><p><b>Related Topics</b></p>
<p><i>Developing Applications with NetBeans IDE</i>,
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG2965">
<param name="text" value="<html><u>&quot;Using WebSocket Endpoints&quot;</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<!-- -->
<!-- -->
<!-- Start Footer -->
<table summary="" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td align="left" width="86%"><a href="legal_notice.htm">
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements; and to You under the Apache License, Version 2.0.</a>
</td>
</tr>
</table>
<!-- -->
</body>
</html>