blob: f8308055819b639585e3a29a67f0db9e7b39d674 [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>RESTful Web Services from Patterns Wizard: Specify Resource Classes (Container Item)</title>
<link rel="stylesheet" href="ide.css" title="Oracle BLAFDoc" type="text/css"/>
</head>
<body>
<p><a id="org.netbeans.modules.websvc.rest.wizard.PatternResourcesSetupPanel.CONTAINER" name="org.netbeans.modules.websvc.rest.wizard.PatternResourcesSetupPanel.CONTAINER"></a></p>
<div id="NBCSH5000"><!-- infolevel="all" infotype="General" --><a id="sthref739" name="sthref739"></a>
<h1>RESTful Web Services from Patterns Wizard: Specify Resource Classes (Container Item)</h1>
<a name="BEGIN" id="BEGIN"></a>
<p>Container-Item RESTful web services consist of an item resource class and its container resource class. Both item and container use Java API for RESTful Web Service (JSR-311).
<object classid="java:org.netbeans.modules.javahelp.BrowserDisplayer">
<param name="content" value="http://www.oracle.com/pls/topic/lookup?ctx=nb8200&id=NBDAG2802">
<param name="text" value="<html><u>How?</u></html>">
<param name="textFontSize" value="medium">
<param name="textColor" value="blue">
</object>
</p>
<p>This panel contains the following fields, which specify the class name, URI, and representation type of the resource.</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-t108">Element</th>
<th align="left" valign="bottom" id="r1c2-t108">Description</th>
</tr>
</thead>
<tbody>
<tr align="left" valign="top">
<td align="left" id="r2c1-t108" headers="r1c1-t108">
<p>Resource Name</p>
</td>
<td align="left" headers="r2c1-t108 r1c2-t108">Name for an item resource. Default is /Item.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r3c1-t108" headers="r1c1-t108">
<p>Class Name</p>
</td>
<td align="left" headers="r3c1-t108 r1c2-t108">Name for the item resource class. Default is ItemResource.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r4c1-t108" headers="r1c1-t108">
<p>Container Class Name</p>
</td>
<td align="left" headers="r4c1-t108 r1c2-t108">Name of the container class. Default is ItemsResource.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r5c1-t108" headers="r1c1-t108">
<p>Project</p>
</td>
<td align="left" headers="r5c1-t108 r1c2-t108">The NetBeans IDE project containing this RESTful service. The value is generated by the IDE.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r6c1-t108" headers="r1c1-t108">Location</td>
<td align="left" headers="r6c1-t108 r1c2-t108">The parent directory inside the NetBeans IDE project that contains the RESTful service. By default this is the Source Packages directory.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r7c1-t108" headers="r1c1-t108">Resource Package</td>
<td align="left" headers="r7c1-t108 r1c2-t108">The package containing the RESTful service classes. Select from a drop-down list of packages or type the name of a new package. These packages are in the directory specified in the Location field.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r8c1-t108" headers="r1c1-t108">Path</td>
<td align="left" headers="r8c1-t108 r1c2-t108">The path, passed as an argument of the <code dir="ltr">@Path</code> annotation. For Container-Item services, the Path is a variable that identifies individual instances of the item resource class. The default value of Path is {id}.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r9c1-t108" headers="r1c1-t108">
<p>Container Path</p>
</td>
<td align="left" headers="r9c1-t108 r1c2-t108">The path of the container resource, passed as an argument of the @Path annotation for the container class declaration. By default the Path is /Items.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r10c1-t108" headers="r1c1-t108">
<p>MIME Type</p>
</td>
<td align="left" headers="r10c1-t108 r1c2-t108">MIME type of RESTful service requests and responses, passed as arguments of the <code dir="ltr">@Produces</code> and <code dir="ltr">@Consumes</code> annotations. The default MIME type is <code dir="ltr">application/xml</code>. Therefore the default <code dir="ltr">@Produces</code> and <code dir="ltr">@Consumes</code> annotations are <code dir="ltr">@Produces("application/xml")</code> and <code dir="ltr">@Consumes("application/xml")</code>.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r11c1-t108" headers="r1c1-t108">
<p>Representation Class</p>
</td>
<td align="left" headers="r11c1-t108 r1c2-t108">Class of the representation of the item resource class instance returned by a get method. Default class is <code dir="ltr">java.lang.String</code>.</td>
</tr>
<tr align="left" valign="top">
<td align="left" id="r12c1-t108" headers="r1c1-t108">
<p>Container Representation Class</p>
</td>
<td align="left" headers="r12c1-t108 r1c2-t108">Class of the representation of the container resource class instance returned by a get method. Default class is <code dir="ltr">java.lang.String</code>.</td>
</tr>
</tbody>
</table>
<br />
<!-- -->
<a id="NBCSH5009" name="NBCSH5009"></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=NBDAG1842">
<param name="text" value="<html><u>&quot;Developing and Securing Web Services&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>