bean-validation-webapp
Directory actions
More options
Directory actions
More options
bean-validation-webapp
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
parent directory.. | ||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!--
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
Copyright (c) 2010-2013 Oracle and/or its affiliates. All rights reserved.
The contents of this file are subject to the terms of either the GNU
General Public License Version 2 only ("GPL") or the Common Development
and Distribution License("CDDL") (collectively, the "License"). You
may not use this file except in compliance with the License. You can
obtain a copy of the License at
http://glassfish.java.net/public/CDDL+GPL_1_1.html
or packager/legal/LICENSE.txt. See the License for the specific
language governing permissions and limitations under the License.
When distributing the software, include this License Header Notice in each
file and include the License file at packager/legal/LICENSE.txt.
GPL Classpath Exception:
Oracle designates this particular file as subject to the "Classpath"
exception as provided by Oracle in the GPL Version 2 section of the License
file that accompanied this code.
Modifications:
If applicable, add the following below the License Header, with the fields
enclosed by brackets [] replaced by your own identifying information:
"Portions Copyright [year] [name of copyright owner]"
Contributor(s):
If you wish your version of this file to be governed by only the CDDL or
only the GPL Version 2, indicate your decision by adding "[Contributor]
elects to include this software in this distribution under the [CDDL or GPL
Version 2] license." If you don't indicate a single choice of license, a
recipient has the option to distribute your version of this file under
either the CDDL, the GPL Version 2 or to extend the choice of license to
its licensees as provided above. However, if you add GPL Version 2 code
and therefore, elected the GPL Version 2 license, then the option applies
and therefore, elected the GPL Version 2 license, then the option applies
only if the new code is made subject to such option by the copyright
holder.
-->
<html>
<head>
<title>Bean Validation Webapp Example</title>
</head>
<body>
<h1>Bean Validation Webapp Example</h1>
<p>This example demonstrates a simple Bean Validation (JSR-349) example with Jersey on the backend and AngularJs on the frontend.</p>
<p>Note: There is no validation on the frontend side, every error displayed is recognized on the backend.</p>
<h2>Contents</h2>
<p>The mapping of the URI path space is presented in the following table:</p>
<table border="1">
<tr>
<th>URI path</th>
<th>Resource class</th>
<th>HTTP methods</th>
<th>Allowed values</th>
</tr>
<tr>
<td>/api/contact</td>
<td>ContactCardResource</td>
<td>GET, POST, DELETE</td>
<td> </td>
</tr>
<tr>
<td>/api/contact/{id}</td>
<td>ContactCardResource</td>
<td>GET, DELETE</td>
<td>id - positive number</td>
</tr>
<tr>
<td>/api/contact/search/{searchType}?q={searchValue}</td>
<td>SearchResource</td>
<td>GET</td>
<td>searchType - (name|phone|email)<br/>searchValue - non empty string</td>
</tr>
</table>
<p>Application is configured by using web.xml, which registers
<a href="https://jax-rs-spec.java.net/nonav/2.0/apidocs/javax/ws/rs/core/Application.html">javax.ws.rs.core.Application</a> descendant to get
classes and singletons from it (see class MyApplication). Bean Validation annotations are present on resource classes (see ContactCardResource, SearchResource)
as well as on the domain class (see ContactCard).</p>
<p>
When <code>curl</code> (see examples below) is used for sending requests to the server, one can see how to affect the media type of returned validation errors (if any).
<br/>
Allowed media types for validation errors entities are: "text/plain"/"text/html" or "application/json"/"application/xml" (appropriate provider has to be registered to transform errors into JSON/XML)
<br/>
Note: <code>jersey.config.beanValidation.enableOutputValidationErrorEntity.server</code> init parameter (<code>web.xml</code>) has to be enabled to let Jersey know
that it should send validation errors as a Response entities (this behavior if disabled by default).
</p>
<h2>Running the Example</h2>
<p>Run the example as follows:</p>
<blockquote><pre>
mvn clean package jetty:run</pre></blockquote>
<p>This deploys current example using Jetty. You can access the application at <a href="http://localhost:8080/bean-validation-webapp">http://localhost:8080/bean-validation-webapp</a>
</p>
<p>You can access resources of this application also using curl:</p>
<blockquote><code>curl -v -H "Accept: application/json" http://localhost:8080/bean-validation-webapp/api/contact/424242</code></blockquote>
<blockquote>In this example you should see JSON array returned with one error - "Contact with given ID does not exist.".</blockquote>
<blockquote><code>curl -v http://localhost:8080/bean-validation-webapp/api/contact/424242</code></blockquote>
<blockquote>In this example you should see the same error but as a plain text.</blockquote>
<h2>Resources</h2>
<p>This examples is using following (3-rd party) front-end frameworks:</p>
<div>
<strong>AngularJS</strong> by Google - front-end MVC JS framework
<ul>
<li><a href="http://angularjs.org">Homepage</a></li>
<li><a href="http://docs.angularjs.org/tutorial">Tutorial</a></li>
<li><a href="http://docs.angularjs.org/api">Reference guide</a></li>
<li><a href="http://docs.angularjs.org/guide">Developer guide</a></li>
</ul>
</div>
<div>
<strong>Bootstrap</strong> by Twitter - front-end HTML/CSS/JS framework
<ul>
<li><a href="http://twitter.github.com/bootstrap">Homepage</a></li>
<li><a href="http://twitter.github.com/bootstrap/getting-started.html">Getting started</a></li>
</ul>
</div>
</body>
</html>