Performance comparison between diverse Java Frameworks for Web

My favorite is still The Bestest :P

Link to the Original Presentation

mvc:view-controller

This tag is a shortcut for defining a ParameterizableViewController that immediately forwards to a view when invoked. Use it in static cases when there is no Java Controller logic to execute before the view generates the response.

An example of view-controller that forwards to a home page is shown below: <mvc:view-controller path="/" view-name="home"/>
Source: http://static.springsource.org/spring/docs/3.0.x/reference/mvc.html

Spring 3.1 M2: Spring MVC Enhancements

Programming Model Improvements

This is the list of programming model improvements introduced in the new @MVC support classes.

1. Declared @PathVariable arguments are now automatically added to the model. For example this:
@RequestMapping("/develop/apps/edit/{slug}") public String editForm(@PathVariable String slug, Model model) { model.addAttribute("slug", slug); // ... }
is replaced by:
@RequestMapping("/develop/apps/edit/{slug}") public String editForm(@PathVariable String slug, Model model) { // model contains "slug" variable }


2. Redirect strings support URI templates expanded with variables from the model (including declared @PathVariables). For example this:
@RequestMapping( value="/groups/{group}/events/{year}/{month}/{slug}/rooms", method=RequestMethod.POST) public String createRoom( @PathVariable String group, @PathVariable Integer year, @PathVariable Integer month, @PathVariable String slug) { // ... return "redirect:/groups/" + group + "/events/" + year + "/" + month + "/" + slug; }
is replaced by:
@RequestMapping( value="/groups/{group}/events/{year}/{month}/{slug}/rooms", method=RequestMethod.POST) public String createRoom( @PathVariable String group, @PathVariable Integer year, @PathVariable Integer month, @PathVariable String slug) { // ... return "redirect:/groups/{group}/events/{year}/{month}/{slug}"; }


3. URI template variables are supported in data binding. For example this:
@RequestMapping("/people/{firstName}/{lastName}/SSN") public String find(Person person, @PathVariable String firstName, @PathVariable String lastName) { person.setFirstName(firstName); person.setLastName(lastName); // ... }
is replaced by:
@RequestMapping("/people/{firstName}/{lastName}/SSN") public String search(Person person) { // person.getFirstName() and person.getLastName() are populated // ... }


4. Consumable and producible media types can be specified via @RequestMapping. For example this:
@RequestMapping(value="/pets", headers="Content-Type=application/json") public void addPet(@RequestBody Pet pet, Model model) { // ... }
is replaced by:
@RequestMapping(value="/pets", consumes="application/json") public void addPet(@RequestBody Pet pet, Model model) { // ... }
Besides being shorter the above returns NOT_ACCEPTABLE (406) if the URL matches but the input media type doesn't.


5. For producible media types this:
@Controller @RequestMapping(value = "/pets/{petId}", headers="Accept=application/json") @ResponseBody public Pet getPet(@PathVariable String petId, Model model) { // ... }
is replaced by:
@Controller @RequestMapping(value = "/pets/{petId}", produces="application/json") @ResponseBody public Pet getPet(@PathVariable String petId, Model model) { // ... }
The above returns a NOT_SUPPORTED_MEDIA_TYPE (415) if the URL matches but the acceptable media type doesn't.

Using @PathVariable

Let's say that you are creating an user account-based web application in Spring 3.0. You would like to create a controller that would allow users to see each other's profile by using a URL such as
http://myapp/profile/username.

For example:
http://myapp/profile/Juan would show user Juan's profile.
http://myapp/profile/Gaby would show user Gaby's profile.


Spring 3.0's annotated controllers make this kind of mapping easy with the new @PathVariable mapping. @Controller public class ShowProfileController { @RequestMapping("/profile/{username}") public String showProfile(Model model, @PathVariable("username") final String username) { ... return "showProfile"; // show my jsp } } As you can see, the RequestMapping for the showProfile method has something a bit unusual: {username}
This is a PathVariable, and it means that this method will serve any request of the format "/profile/someUserName"

We capture the actual username in the next line using the @PathVariable annotation @PathVariable("username") and store it in the variable

final String username

Now we can use it however we want!
Viva Spring framework!!!

Load Properties in Spring MVC

This is a really trivial case, but I have to cover it, because you never know when you'll need it.

We have our application and we need to load a Properties file and use it, specifically in one of your Controllers, just like this...

I know! When we say spring + properties files, everybody think on this case (don't you?): <!-- Properties file certain specific App Stuff --> <context:property-placeholder location="classpath:my-application.properties"/> <!-- Creates reCaptcha Instance --> <bean id="reCaptcha" class="net.tanesha.recaptcha.ReCaptchaImpl"> <property name="privateKey" value="${recaptcha.private.key}" /> <property name="publicKey" value="${recaptcha.public.key}" /> <property name="includeNoscript" value="false" /> </bean>
But this is not the case I want to cover right now, because the one I want to cover is this one:

String value = (String)properties.get(key);

@Controller @RequestMapping(value = "/sitexfer/*") public class SiteXrefController extends BaseCustomController { private static final Logger log = Logger.getLogger(SiteXrefController.class); @Autowired private HttpClient httpClient; @Autowired @Qualifier("SiteXferProperties") private Properties properties; ... private String executeTest(final String serverType, final String instance, final Enumeration<String> headerNames, final HttpServletRequest request){ log.debug("Testing=" + instance + ", serverType=" + serverType); log.debug("Additional Params: " + headerNames); String result = ""; String url = (String)properties.get(serverType+"."+instance); ... return result; } .... } Ahhhh! That's what I meant :D

How can I do that? Simple, trust in Spring! (may the Spring be with you :P ) By using Util Schema <util:properties id="SiteXferProperties" location="classpath:sitexfer-application.properties"/> <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:p="http://www.springframework.org/schema/p" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:util="http://www.springframework.org/schema/util" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd"> <util:properties id="SiteXferProperties" location="classpath:sitexfer-application.properties"/> <context:annotation-config/> <context:component-scan base-package="com.bofa.sitexfer.web.controller"/> </beans>

Piece of cake
Pan comido

Log4jConfigListener Deployment Issue on WebLogic

It looks like Spring framework's Log4jConfigListener is having an issue when webapp is deployed as WAR.
Log4jConfigListener is defined in web.xml. I got the below error while deploying the application in weblogic 10.3:

 
weblogic.management.DeploymentException: Cannot set web app root system property when WAR file is not expanded - with nested exception:  [java.lang.IllegalStateException: Cannot set web app root system property when WAR file is not expanded].

The solution is deploy the WAR as exploded or don't use Log4jConfigListener. The spring framework documentation also says the WAR should be exploded.

But... there is a solution available to this without any code change. We just need to set "Archived Real Path Enabled" option checked, just like this:


1. Go to server admin console->Domain-> Web applications. Click the checkbox of Archived Real Path Enabled. This should make an entry into domain config.xml as below. <web-app-container> <show-archived-real-path-enabled>true</show-archived-real-path-enabled> </web-app-container> 2. Second option is at webapp level by updating weblogic.xml as below: true The value of set in the web app has precedence over the value set at the domain level. The default value of this property is false.

This is my example: <?xml version="1.0" encoding="UTF-8"?> <wls:weblogic-web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wls="http://www.bea.com/ns/weblogic/90" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd http://www.bea.com/ns/weblogic/90 http://www.bea.com/ns/weblogic/90/weblogic-web-app.xsd"> <wls:context-root>sitexfer-testing</wls:context-root> <wls:container-descriptor> <wls:show-archived-real-path-enabled>true</wls:show-archived-real-path-enabled> </wls:container-descriptor> </wls:weblogic-web-app>

Upload Files with Spring MVC

Have you ever tried to upload a file as part of a form to be submited?
In my case I have a form to add or update products, and each product must have an image (JPG file), besides the regular information related to each product: Name, Description, etc.
Then, we need a form with some inputs and a method on one of my controllers to handle this request and we're set.

This topic is really simple to cover, despite of the fact is poorly covered by the official documentation.
Steps
Add entries on your POM <dependency> <groupId>commons-io</groupId> <artifactId>commons-io</artifactId> <version>1.4</version> </dependency> <dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fileupload</artifactId> <version>1.2.1</version> </dependency>
Add a MultipartResolver in your Web Application Context <property name="maxUploadSize" value="50000"/><!-- in bytes --> <!-- There are more props, but I am not going to use them --> </bean>
On your form don't forget to include enctype attribute and make it POST

Add your input type file as regular HTML

In your controller add a method to handle with all params @RequestMapping(value="saveOrUpdateProduct.do", method=RequestMethod.POST) public String saveUpdateProduct(HttpServletRequest request, ModelMap modelMap, @ModelAttribute("ProductDTO") final ProductDTO productDTO, @RequestParam("productImage") final MultipartFile productImage, @RequestParam("brand") final Integer brand, @RequestParam("category") final Integer category){ if(!this.isLoggedIn(request)){//Verify if user is authenticated return "redirect:/authentication/notLoggedIn.do"; } Boolean result = false; File fileProductImage = new File(request.getSession().getServletContext().getRealPath("/img/products/")+File.separatorChar+productDTO.getCode()+".JPG"); //I'm going to upload all images into this directory and will assign them ext JPG log.debug("Save or Update products"); log.debug("fileProductImage="+fileProductImage); productDTO.getBrandDTO().setIdBrand(brand); productDTO.getCategoryDTO().setIdCategory(category); try { /*if(StringUtils.isEmpty(productDTO.getIdProduct()+"")){ result = this.catalogsService.addProduct(productDTO); }else{ result = this.catalogsService.modifyProduct(productDTO); } */ if(result){ log.debug("productDTO= "+productDTO+", idBrand= "+brand+", idCategory="+category); log.debug("FileUpload= "+productImage+", "+productImage.getContentType()+", "+productImage.getName()+", "+productImage.getOriginalFilename()+", "+productImage.getSize()); FileUtils.writeByteArrayToFile(fileProductImage, productImage.getBytes()); } } catch (Exception ex) { log.error(ex); modelMap.put(GenericConstants.KEY_ERROR, ex.getMessage()); } return getAllProducts(request, modelMap, null); }
I'm using FileUtils to save the uploaded file :D
Look carefully to this parameter @RequestParam("productImage") final org.springframework.web.multipart.MultipartFile productImage @RequestParam("productImage") matches to

And you're all set! Easy, Isn't it?

Integration reCaptcha with Spring MVC

When I was explaining about reCaptcha on my previous entry, I made reference to my little-store example app, which basically has a bunch of frameworks (the idea is implement those technologies that I want to learn or just practice).

What I did is really simple, the first step was adding my new dependency to my POM <dependency> <groupId>net.tanesha.recaptcha4j</groupId> <artifactId>recaptcha4j</artifactId> <version>0.0.7</version> </dependency>
Then add to my webApplicationContext.xml my new reCaptcha bean <!-- Creates reCaptcha Instance --> <bean id="reCaptcha" class="net.tanesha.recaptcha.ReCaptchaImpl"> <property name="privateKey" value="${recaptcha.private.key}" /> <property name="publicKey" value="${recaptcha.public.key}" /> <property name="includeNoscript" value="false" /> </bean>
You must get the keys from the official website by adding your site. On my case I put the keys in a properties file, and then by using spring I loaded that file
<context:property-placeholder location="classpath:my-application.properties"/>

Next in my Controller I used my ReCaptcha bean, like this @Controller @RequestMapping("/checkOut/*") public class CheckOutController extends BaseCustomController { ... @Autowired private ReCaptcha reCaptcha; @RequestMapping(value="addPaymentInformation.do", method=RequestMethod.POST) public String addPaymentInfo(HttpServletRequest request, ModelMap modelMap, @ModelAttribute("CreditCardDTO") CreditCardDTO paramCreditCardDTO, Object skipUpdateCreditCard){ ... //Displays reCatcha modelMap.put("reCaptcha", reCaptcha.createRecaptchaHtml(request.getParameter("error"), null)); return "checkout/confirm_order"; }
As you could see, this code populates a variable (reCaptcha) which I'm going to display on my JSP using JSTL:

${requestScope.reCaptcha}

Inside of a HTML FORM

Finally, this is how I validated the confirmation text (you must be expecting these 2 params: recaptcha_challenge_field and recaptcha_response_field)
@RequestMapping(value="submitOrderAndPayment.do", method=RequestMethod.POST) public String submitOrderWithPayment(HttpServletRequest request, ModelMap modelMap, @RequestParam("idCreditCard") final Integer idCreditCard, @RequestParam("recaptcha_challenge_field") final String reCaptchaChallenge, @RequestParam("recaptcha_response_field") final String reCaptchaResponse){ ... //Handles reCaptcha ReCaptchaResponse response = reCaptcha.checkAnswer(request.getRemoteAddr(), reCaptchaChallenge, reCaptchaResponse); if(!response.isValid()){ log.warn("reCaptcha Answer msg= "+response.getErrorMessage()); modelMap.put("reCaptchaError",response.getErrorMessage()); return addPaymentInfo(request, modelMap, creditCardDTO, Boolean.TRUE); } ... //It was correct, then proceed //Show confirmation page, it shows order number return "checkout/order_completed"; }
The only problem I faced was related to my flow (which screen should I display), but besides that the implementation is really straight forward, simple!

reCaptcha - FREE anti-bot service that helps digitize books

Did you remember one of my entries where I implemented jCaptcha???
If you don't know what I'm talking about this is the entry

Now that we understand each other, just for things of the destiny (¬¬ yeah of course!), I found something about "Digitizing Books One Word at a Time" from Google and how many times you've seen this Captcha.


Actually, you can implement it on the same way with jCaptcha, but you need more customization, at the end it has Pros and Cons both solutions, but as an Architect, I take in consideration 2 main factors:

• Is your App going to be in a closed environment?? Is it going to have access to Internet?? (One thing is that you can access your app through web and something else is that your Network and Server configuration doesn't allow your app to interact with other websites)
• Do you want to have full control of your App?? Then you don't want to share anything about your app with any external entity, you don't need external Black Boxes (you can re-invent the wheel for you, can't you?)

For this particular situation, I'd prefer to share something with the world, I mean I don't care if Google knows that I'm using its service, My App can share and cooperate with the rest of the world, because I'm not using critical information (for my purposes: Educational)

Then let's begin...
.
What is reCAPTCHA?
reCAPTCHA is a free CAPTCHA service that protects your site against spam, malicious registrations and other forms of attacks where computers try to disguise themselves as a human; a CAPTCHA is a Completely Automated Public Turing test to tell Computers and Human Apart. reCAPTCHA comes in the form of a widget that you can easily add to your blog, forum, registration form, etc.

In my next entry I'll be implementing this reCaptcha in my little-store app :)
So I'll see how it works and how hard is to implement it (obviously I'll need to install the library on my local Maven Repo) and use Scriptlets "duh!"
But as people say, if life gives you lemons, make lemonade and that's what I'm going to do

Pass parameters from one page to another

This is the issue, I have a JSP which helps me to generate a URL to change the Locale, to switch between Spanish and English, but I have a JSP (maybe more) which is displayed based on a Parameter, because shows the details for an Object based on idObject.
This is my original JSP (So each time I clicked the link, the page was refreshed, but missing the param, obviously the content was never displayed - duh!) <fmt:message key="button.locale"/>: <c:url var="englishLocaleUrl" value="${urlBase}"> <c:param name="locale" value="en" /> </c:url> <c:url var="spanishLocaleUrl" value="${urlBase}"> <c:param name="locale" value="es" /> </c:url> <c:out value="${englishLocaleUrl}"/><fmt:message key="locale.english"/> <c:out value="${spanishLocaleUrl}"/><fmt:message key="locale.spanish"/>

The fix is really simple, just add more params to each URL, by using JSTL :) Like this (creating dynamically my params) <c:forEach items="${param}" var="pageParam"> <c:param name="${pageParam.key}" value="${pageParam.value}" /> </c:forEach> <fmt:message key="button.locale"/>: <c:url var="englishLocaleUrl" value="${urlBase}"> <c:param name="locale" value="en" /> <c:forEach items="${param}" var="pageParam"> <c:param name="${pageParam.key}" value="${pageParam.value}" /> </c:forEach> </c:url> <c:url var="spanishLocaleUrl" value="${urlBase}"> <c:param name="locale" value="es" /> <c:forEach items="${param}" var="pageParam"> <c:param name="${pageParam.key}" value="${pageParam.value}" /> </c:forEach> </c:url> <c:out value="${englishLocaleUrl}"/><fmt:message key="locale.english"/> <c:out value="${spanishLocaleUrl}"/><fmt:message key="locale.spanish"/>

Spring MVC and Tiles 2

I still remember how cool it was to use Tiles with Struts, back in Mexico and a couple of times here, but since I've migrated my efforts on Spring MVC;
At the very beginning I couldn't implement Tiles successfully (I just tried 2 times :P - 1 really important and another one just for fun)
But when Tiles became an independent project: Apache Tiles 2 things changed a little bit, and now that everything could be delegated to Spring, let's give it a shot!
I didn't have to change too many things, because let's start from an existing App using Spring MVC, Spring Core, Hibernate, Apache CXF, DisplayTag, jCaptcha, etc.

This is my Application layout (yes! I <3 Maven 2!)
 

This is one of my Controllers (something really common) @Controller public class LandingPageController extends BaseCustomController { private static final Logger log = Logger.getLogger(LandingPageController.class); @Autowired private ICatalogsService catalogsService; @RequestMapping(value = "/showLandingPage.do") public String showInitialPage(HttpServletRequest request, HttpServletResponse response, ModelMap modelMap) { if(!this.isLoggedIn(request)){//Verify if user is authenticated return "redirect:/authentication/notLoggedIn.do"; } log.debug("show initial page / welcome page"); log.debug("Get random products"); List<ProductDTO> list = new ArrayList<ProductDTO>(); Integer max = RandomUtils.JVM_RANDOM.nextInt(GenericConstants.MAX_NUMBER_PRODUCTS); if(max==0){ max = GenericConstants.MIN_NUMBER_PRODUCTS; // } try { list = catalogsService.getRandomProducts(max); modelMap.put(GenericConstants.KEY_LIST_ITEMS, list); } catch (ApplicationException ex) { log.error(ex); modelMap.put(GenericConstants.KEY_FATAL, "ErrorCode "+ex.getErrorCode()+": "+ex.getErrorMessage()); } return "start/landing_page";//show jsp } }
On the return statement return "start/landing_page";//show jsp I'm just displaying the file: /jsp/start/landing_page.jsp
This is my previous webApplicationContext.xml (look at the InternalResourceViewResolver - it maps the JSP's to the return statements on my Controllers) <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:flow="http://www.springframework.org/schema/webflow-config" xmlns:p = "http://www.springframework.org/schema/p" xmlns:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd http://www.springframework.org/schema/webflow-config http://www.springframework.org/schema/webflow-config/spring-webflow-config-2.0.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd"> <!--================== Annotation config =====================--> <context:annotation-config/> <!--================== Location of Controllers =====================--> <context:component-scan base-package="mx.com.juca.store.web.controller"/> <!--================== InternalResourceViewResolver =====================--> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/> <property name="prefix" value="/jsp/"/> <property name="suffix" value=".jsp"/> </bean> </beans>

Let's start by integrating Tiles

Add new dependencies in your pom.xml <dependency> <groupId>org.apache.tiles</groupId> <artifactId>tiles-core</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>org.apache.tiles</groupId> <artifactId>tiles-el</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>org.apache.tiles</groupId> <artifactId>tiles-jsp</artifactId> <version>2.2.2</version> </dependency>
Update your webApplicationContext.xml (don't forget to take out the existing InternalResourceViewResolver - we're going to replace it with a Tiles View Resolver) by adding these entries <!--================== Internationalization of my App =====================--> <!-- Resolves localized messages*.properties file(s) in the application to allow for internationalization --> <bean class="org.springframework.context.support.ReloadableResourceBundleMessageSource" id="messageSource" p:basenames="WEB-INF/i18n/messages" p:fallbackToSystemLocale="false"/> <!-- Declare the Interceptor --> <mvc:interceptors> <bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor" p:paramName="locale"/> </mvc:interceptors> <!-- Declare the Resolver --> <bean id="localeResolver" class="org.springframework.web.servlet.i18n.SessionLocaleResolver"/> <!--================== Modify dynamically Theme =====================--> <!-- store preferred theme configuration in a cookie --> <bean class="org.springframework.web.servlet.theme.CookieThemeResolver" id="themeResolver" p:cookieName="theme" p:defaultThemeName="standard"/> <!--================== Tiles Integration - View Resolver: replaces previous InternalResourceViewResolver =====================--> <bean class="org.springframework.web.servlet.view.UrlBasedViewResolver" id="tilesViewResolver"> <property name="viewClass" value="org.springframework.web.servlet.view.tiles2.TilesView"/> </bean> <!--================== Tiles Configuration =====================--> <bean class="org.springframework.web.servlet.view.tiles2.TilesConfigurer" id="tilesConfigurer"> <property name="definitions"> <list> <value>/WEB-INF/conf/layouts/layouts.xml</value> <!-- Scan views directory for Tiles configurations --> <value>/jsp/**/views.xml</value> </list> </property> </bean>
Put more attention to this portion (the rest is a nice to have) <!--================== Tiles Integration - View Resolver: replaces previous InternalResourceViewResolver =====================--> <bean class="org.springframework.web.servlet.view.UrlBasedViewResolver" id="tilesViewResolver"> <property name="viewClass" value="org.springframework.web.servlet.view.tiles2.TilesView"/> </bean> <!--================== Tiles Configuration =====================--> <bean class="org.springframework.web.servlet.view.tiles2.TilesConfigurer" id="tilesConfigurer"> <property name="definitions"> <list> <value>/WEB-INF/conf/layouts/layouts.xml</value> <!-- Scan views directory for Tiles configurations --> <value>/jsp/**/views.xml</value> </list> </property> </bean>
Then according to this tilesConfigurer, I have to add a new file on each JSP folder (views.xml) and my layouts, like this
 

layouts.xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE tiles-definitions PUBLIC "-//Apache Software Foundation//DTD Tiles Configuration 2.1//EN" "http://tiles.apache.org/dtds/tiles-config_2_1.dtd"> <tiles-definitions> <definition name="default" template="/WEB-INF/conf/layouts/default.jsp"> <put-attribute name="header" value="/WEB-INF/conf/layouts/header.jsp" /> <put-attribute name="menu" value="/WEB-INF/conf/layouts/menu.jsp" /> <put-attribute name="footer" value="/WEB-INF/conf/layouts/footer.jsp" /> </definition> </tiles-definitions>
default.jsp <%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %> <%@ taglib uri="http://tiles.apache.org/tags-tiles" prefix="tiles" %> <%@ taglib uri="http://www.springframework.org/tags/form" prefix="form" %> <%@ taglib uri="http://www.springframework.org/tags" prefix="spring" %> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <meta http-equiv="X-UA-Compatible" content="IE=8" /> <spring:url value="/images/favicon.ico" var="favicon" /> <link rel="SHORTCUT ICON" href="${favicon}" /> <spring:message code="site.title" var="app_name"/> <title><spring:message code="welcome_h3" arguments="${app_name}" /></title> <link href="${pageContext.request.contextPath}/css/displaytag.css" rel="stylesheet" type="text/css"> <link href="${pageContext.request.contextPath}/css/estilos.css" rel="stylesheet" type="text/css"> <link href="${pageContext.request.contextPath}/css/standard.css" rel="stylesheet" type="text/css"> <script src="${pageContext.request.contextPath}/js/overlib/overlib.js"></script> </head> <body class="tundra spring"> <div id="overDiv" style="position:absolute; visibility:hidden; z-index:1000;"></div> <div id="wrapper"> <tiles:insertAttribute name="header" ignore="true" /> <tiles:insertAttribute name="menu" ignore="true" /> <div id="main"> <tiles:insertAttribute name="body"/> <tiles:insertAttribute name="footer" ignore="true"/> </div> </div> </body> </html>
footer.jsp. Look at the links, because this is the key to make this APP Multilanguage (besides the entries on webApplicationContext.xml and obviously the *.properties files)
 
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> <%@ taglib prefix="fmt" uri="http://java.sun.com/jsp/jstl/fmt" %> <div align="right"> <div> <fmt:message key="button.locale"/>: <c:url var="englishLocaleUrl" value="${urlBase}"> <c:param name="locale" value="" /> </c:url> <c:url var="spanishLocaleUrl" value="${urlBase}"> <c:param name="locale" value="es" /> </c:url> <a href='<c:out value="${englishLocaleUrl}"/>'><fmt:message key="locale.english"/></a> <a href='<c:out value="${spanishLocaleUrl}"/>'><fmt:message key="locale.spanish"/></a> </div> <div> </div> <div><fmt:message key="site.footer"/></div> </div>
views.xml on /jsp/start/ folder <?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE tiles-definitions PUBLIC "-//Apache Software Foundation//DTD Tiles Configuration 2.1//EN" "http://tiles.apache.org/dtds/tiles-config_2_1.dtd"> <tiles-definitions> <definition extends="default" name="start/landing_page"> <put-attribute name="body" value="/jsp/start/landing_page.jsp"/> </definition> </tiles-definitions>
This portion makes the magic (
without touching any single line of code!!! ) <definition extends="default" name="start/landing_page">
Where else have you seen "start/landing_page" before? If you don't remember, in my controller (return statement: return "start/landing_page";//show jsp)

And now you're ready to rock!

JCaptcha & Spring MVC

Have you ever heard about Captcha.
Is this familiar?

Now that you remember what I'm talking about, let's begin.
I chose JCaptcha, because I used before with Struts back in Mexico for one of my projects when I was working in Government (SICOSIEM) and it was really useful (but I used a servlet)
Now the idea will be implementing the same project on an existing Spring MVC App, which is really simple :)
First things first!. Get JCaptcha and install it in your Local MVN Repo (version 1.0-all), because if you add as dependency version 1.0, it will not work, due to the lack of some jars on Maven Central Repo.
My Controller which will behave like my old servlet (I just have to create an IMG tag with src="/myAppContext/captcha/captcha.htm") @Controller @RequestMapping("/captcha/*") public class CaptchaController { @Autowired private CaptchaService captchaService; @RequestMapping(value="captcha.htm", method=RequestMethod.GET) public void showCaptcha(HttpServletRequest request, HttpServletResponse response) throws Exception { byte[] captchaChallengeAsJpeg = null; // the output stream to render the captcha image as jpeg into ByteArrayOutputStream jpegOutputStream = new ByteArrayOutputStream(); try { // get the session id that will identify the generated captcha. // the same id must be used to validate the response, the session id // is a good candidate! String sessionId = request.getSession().getId(); // call the ImageCaptchaService getChallenge method BufferedImage challenge = ((ImageCaptchaService) captchaService).getImageChallengeForID(sessionId); // a jpeg encoder JPEGImageEncoder jpegEncoder = JPEGCodec.createJPEGEncoder(jpegOutputStream); jpegEncoder.encode(challenge); } catch (IllegalArgumentException e) { response.sendError(HttpServletResponse.SC_NOT_FOUND); } catch (CaptchaServiceException e) { response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); } captchaChallengeAsJpeg = jpegOutputStream.toByteArray(); // flush it in the response response.setHeader("Cache-Control", "no-store"); response.setHeader("Pragma", "no-cache"); response.setDateHeader("Expires", 0); // response.setContentType("image/jpeg"); // response.getOutputStream().write(jpegOutputStream); ServletOutputStream responseOutputStream = response.getOutputStream(); responseOutputStream.write(captchaChallengeAsJpeg); responseOutputStream.flush(); responseOutputStream.close(); } }
This is how you have to use it (on my previous jsp I have an input text called "captchaText" which holds the value entered by the user) @RequestMapping(value = "registerCustomer.htm",method=RequestMethod.POST) public String signUpCustomer(HttpServletRequest request, ModelMap modelMap, @ModelAttribute("CustomerDTO") CustomerDTO paramCustomerDTO, @RequestParam(value="captchaText", required=true) final String verificationText){ Boolean isResponseCorrect = false; String sessionId = request.getSession().getId(); try { isResponseCorrect = this.captchaService.validateResponseForID(request.getSession().getId(), verificationText); }catch(CaptchaServiceException ex) { //should not happen, may be thrown if the id is not valid log.warn("Session Id "+sessionId+" Not valid",ex); } try { if(isResponseCorrect){ result = this.customerService.doSignUp(paramCustomerDTO); }else{ modelMap.put(GenericConstants.KEY_ERROR, "Verification text incorrect, please type it again"); } }catch... .... }
This is a minimal configuration (I have the bad habit of splitting all my configurations to make my life easier, on this case I'll call this configuration file "jcaptcha.xml"), if you want to dig deeper, you can explore the official web site and play around with other classes (just look into this package: com.octo.captcha.engine.image.gimpy) <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> <!-- =================== Captcha (Predefined) Engines =================== --> <bean id="imageEngineBean3" class="com.octo.captcha.engine.image.gimpy.BaffleListGimpyEngine"/> <bean id="imageEngineBean4" class="com.octo.captcha.engine.image.gimpy.BasicGimpyEngine"/> <bean id="imageEngineBean5" class="com.octo.captcha.engine.image.gimpy.DefaultGimpyEngine"/> <bean id="imageEngineBean6" class="com.octo.captcha.engine.image.gimpy.DeformedBaffleListGimpyEngine"/> <bean id="imageEngineBean7" class="com.octo.captcha.engine.image.gimpy.DoubleRandomListGimpyEngine"/> <bean id="imageEngineBean8" class="com.octo.captcha.engine.image.gimpy.FilteredBaffleListGimpyEngine"/> <bean id="imageEngineBean9" class="com.octo.captcha.engine.image.gimpy.FilteredDoubleRandomListGimpyEngine"/> <bean id="imageEngineBean10" class="com.octo.captcha.engine.image.gimpy.FilteredGimpyEngine"/> <bean id="imageEngineBean11" class="com.octo.captcha.engine.image.gimpy.FilteredListGimpyEngine"/> <!-- Only 12 and 13 are pretty decent --> <bean id="imageEngineBean12" class="com.octo.captcha.engine.image.gimpy.NonLinearTextGimpyEngine"/> <bean id="imageEngineBean13" class="com.octo.captcha.engine.image.gimpy.SimpleListImageCaptchaEngine"/> <!-- =================== Captcha Service =================== --> <bean id="captchaService" class="com.octo.captcha.service.multitype.GenericManageableCaptchaService"> <constructor-arg index="0" ref="imageEngineBean12"/> <constructor-arg index="1"><value>180</value></constructor-arg> <constructor-arg index="2"><value>180000</value></constructor-arg> <constructor-arg index="3"><value>200</value></constructor-arg> </bean> </beans>
FYI: This is the captcha service I'm injecting in my Controllers <bean id="captchaService" class="com.octo.captcha.service.multitype.GenericManageableCaptchaService">
Don't forget adding your new configuration file for JCaptcha in your Spring App Context (this is my web.xml) <!-- Spring Context Configuration --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/conf/spring/daoApplicationContext.xml, /WEB-INF/conf/spring/serviceApplicationContext.xml, /WEB-INF/conf/cxf/cxf-services.xml, /WEB-INF/conf/captcha/jcaptcha.xml </param-value> </context-param>
If you want to see a more complex ("customized") configuration, you can use see this one (It took me a while to create it - but I used as reference what is on JCaptcha WebSite) <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> <!-- =================== Captcha Engines =================== --> <bean id="imageEngineBean" class="com.octo.captcha.engine.GenericCaptchaEngine"> <constructor-arg index="0"> <list> <ref bean="captchaFactoryBean"/> </list> </constructor-arg> </bean> <bean id="imageEngineBean3" class="com.octo.captcha.engine.image.gimpy.BaffleListGimpyEngine"/> <bean id="imageEngineBean4" class="com.octo.captcha.engine.image.gimpy.BasicGimpyEngine"/> <bean id="imageEngineBean5" class="com.octo.captcha.engine.image.gimpy.DefaultGimpyEngine"/> <bean id="imageEngineBean6" class="com.octo.captcha.engine.image.gimpy.DeformedBaffleListGimpyEngine"/> <bean id="imageEngineBean7" class="com.octo.captcha.engine.image.gimpy.DoubleRandomListGimpyEngine"/> <bean id="imageEngineBean8" class="com.octo.captcha.engine.image.gimpy.FilteredBaffleListGimpyEngine"/> <bean id="imageEngineBean9" class="com.octo.captcha.engine.image.gimpy.FilteredDoubleRandomListGimpyEngine"/> <bean id="imageEngineBean10" class="com.octo.captcha.engine.image.gimpy.FilteredGimpyEngine"/> <bean id="imageEngineBean11" class="com.octo.captcha.engine.image.gimpy.FilteredListGimpyEngine"/> <!-- Only 12 and 13 are pretty decent --> <bean id="imageEngineBean12" class="com.octo.captcha.engine.image.gimpy.NonLinearTextGimpyEngine"/> <bean id="imageEngineBean13" class="com.octo.captcha.engine.image.gimpy.SimpleListImageCaptchaEngine"/> <!-- =================== Captcha Factory Bean =================== --> <bean id="captchaFactoryBean" class="com.octo.captcha.image.gimpy.GimpyFactory" > <constructor-arg ref="wordGeneratorBean"/> <constructor-arg ref="wordToImageBean"/> </bean> <!-- =================== Dictionary Word Generator =================== --> <bean id="wordGeneratorBean" class= "com.octo.captcha.component.word.wordgenerator.DictionaryWordGenerator" > <constructor-arg ref="fileDictionaryBean"/> </bean> <!-- =================== File Dictionary =================== --> <bean id="fileDictionaryBean" class="com.octo.captcha.component.word.FileDictionary" > <constructor-arg index="0"><value>toddlist</value></constructor-arg> </bean> <!-- =================== Deformed Compose Word To Image =================== --> <bean id="wordToImageBean" class="com.octo.captcha.component.image.wordtoimage.DeformedComposedWordToImage" > <constructor-arg index="0" ref="randomFontGeneratorBean"/> <constructor-arg index="1" ref="backGeneratorFunkyBean"/> <constructor-arg index="2" ref="simpleColoredPasterBean"/> <constructor-arg index="3" ref="rippleDeformationBack"/> <constructor-arg index="4" ref="none"/> <constructor-arg index="5" ref="waterDeformation"/> </bean> <!-- =================== Random Font Generator =================== --> <bean id="randomFontGeneratorBean" class="com.octo.captcha.component.image.fontgenerator.RandomFontGenerator" > <constructor-arg index="0"><value>40</value></constructor-arg> <constructor-arg index="1"><value>50</value></constructor-arg> <constructor-arg index="2"> <list> <ref bean="fontArial"/> <ref bean="fontTahoma"/> <ref bean="fontVerdana"/> <ref bean="fontComic"/> <ref bean="fontLucida"/> </list> </constructor-arg> </bean> <!-- =================== Fonts =================== --> <bean id="fontArial" class="java.awt.Font" > <constructor-arg index="0"><value>Arial</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <bean id="fontTahoma" class="java.awt.Font" > <constructor-arg index="0"><value>Tahoma</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <bean id="fontVerdana" class="java.awt.Font" > <constructor-arg index="0"><value>Verdana</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <bean id="fontComic" class="java.awt.Font" > <constructor-arg index="0"><value>Comic sans MS</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <bean id="fontLucida" class="java.awt.Font" > <constructor-arg index="0"><value>Lucida console</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>10</value></constructor-arg> </bean> <!-- =================== Backgrounds =================== --> <bean id="uniColorBackGeneratorBean" class="com.octo.captcha.component.image.backgroundgenerator.UniColorBackgroundGenerator" > <constructor-arg index="0"><value>300</value></constructor-arg> <constructor-arg index="1"><value>100</value></constructor-arg> </bean> <bean id="backGeneratorFunkyBean" class="com.octo.captcha.component.image.backgroundgenerator.FunkyBackgroundGenerator" > <constructor-arg index="0"><value>300</value></constructor-arg> <constructor-arg index="1"><value>100</value></constructor-arg> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="2" ref="randomListColorGeneratorBean"/> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="3" ref="randomListColorGeneratorBean"/> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="4" ref="randomListColorGeneratorBean"/> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="5" ref="randomListColorGeneratorBean"/> <constructor-arg index="6"><value>0.2f</value></constructor-arg> </bean> <!-- =================== Text Pasters =================== --> <bean id="simpleWhitePasterBean" class="com.octo.captcha.component.image.textpaster.SimpleTextPaster" > <constructor-arg type="java.lang.Integer" index="0"> <value>4</value> </constructor-arg> <constructor-arg type="java.lang.Integer" index="1"> <value>6</value> </constructor-arg> <constructor-arg type="java.awt.Color" index="2"> <ref bean="colorBlack"/> </constructor-arg> </bean> <bean id="simpleColoredPasterBean" class="com.octo.captcha.component.image.textpaster.RandomTextPaster" > <constructor-arg type="java.lang.Integer" index="0"><value>4</value></constructor-arg> <constructor-arg type="java.lang.Integer" index="1"><value>6</value></constructor-arg> <constructor-arg type="com.octo.captcha.component.image.color.ColorGenerator" index="2" ref="randomRangeColorGeneratorDarkBean"/> <constructor-arg index="3"><value>true</value></constructor-arg> </bean> <!-- =================== Random Range Color Generator =================== --> <bean id="randomRangeColorGeneratorDarkBean" class="com.octo.captcha.component.image.color.RandomRangeColorGenerator" > <constructor-arg index="0"> <list> <value>0</value> <value>150</value> </list> </constructor-arg> <constructor-arg index="1"> <list> <value>0</value> <value>150</value> </list> </constructor-arg> <constructor-arg index="2"> <list> <value>0</value> <value>150</value> </list> </constructor-arg> <constructor-arg index="3"> <list> <value>255</value> <value>255</value> </list> </constructor-arg> </bean> <!-- =================== RandomList Color Generator =================== --> <bean id="randomListColorGeneratorBean" class="com.octo.captcha.component.image.color.RandomListColorGenerator" > <constructor-arg index="0"> <list> <ref bean="yellow"/> <ref bean="blue"/> <ref bean="lightBlue"/> <ref bean="colorBlack"/> </list> </constructor-arg> </bean> <!-- =================== Colors =================== --> <bean id="blue" class="java.awt.Color" > <constructor-arg type="int" index="0"><value>0</value></constructor-arg> <constructor-arg type="int" index="1"><value>0</value></constructor-arg> <constructor-arg type="int" index="2"><value>255</value></constructor-arg> </bean> <bean id="lightBlue" class="java.awt.Color" > <constructor-arg type="int" index="0"><value>200</value></constructor-arg> <constructor-arg type="int" index="1"><value>200</value></constructor-arg> <constructor-arg type="int" index="2"><value>255</value></constructor-arg> </bean> <bean id="yellow" class="java.awt.Color" > <constructor-arg type="int" index="0"><value>255</value></constructor-arg> <constructor-arg type="int" index="1"><value>255</value></constructor-arg> <constructor-arg type="int" index="2"><value>0</value></constructor-arg> </bean> <bean id="colorBlack" class="java.awt.Color" > <constructor-arg index="0"><value>0</value></constructor-arg> <constructor-arg index="1"><value>0</value></constructor-arg> <constructor-arg index="2"><value>0</value></constructor-arg> </bean> <!-- =================== Captcha Service =================== --> <bean id="captchaService" class="com.octo.captcha.service.multitype.GenericManageableCaptchaService"> <constructor-arg index="0" ref="imageEngineBean"/> <constructor-arg index="1"><value>180</value></constructor-arg> <constructor-arg index="2"><value>180000</value></constructor-arg> <constructor-arg index="3"><value>200</value></constructor-arg> </bean> <!-- =================== Deformations =================== --> <bean id="sphere" class="com.jhlabs.image.SphereFilter"> <property name="refractionIndex"> <value>1</value> </property> </bean> <bean id="emboss" class="com.jhlabs.image.EmbossFilter"> <property name="bumpHeight"> <value>1.0</value> </property> </bean> <bean id="rippleBack" class="com.jhlabs.image.RippleFilter"> <property name="waveType"> <value>3</value> </property> <property name="XAmplitude"> <value>10</value> </property> <property name="YAmplitude"> <value>3</value> </property> <property name="XWavelength"> <value>20</value> </property> <property name="YWavelength"> <value>10</value> </property> <property name="edgeAction"> <value>1</value> </property> </bean> <bean id="smear" class="com.jhlabs.image.SmearFilter"> <property name="shape"> <value>0</value> </property> <property name="distance"> <value>15</value> </property> <property name="density"> <value>0.4</value> </property> <property name="scatter"> <value>0.5</value> </property> <property name="angle"> <value>0.0</value> </property> <property name="mix"> <value>0.6</value> </property> <property name="fadeout"> <value>0</value> </property> </bean> <bean id="ripple" class="com.jhlabs.image.RippleFilter"> <property name="waveType"> <value>1</value> </property> <property name="XAmplitude"> <value>2</value> </property> <property name="YAmplitude"> <value>2</value> </property> <property name="XWavelength"> <value>10</value> </property> <property name="YWavelength"> <value>10</value> </property> <property name="edgeAction"> <value>1</value> </property> </bean> <bean id="ripple2" class="com.jhlabs.image.RippleFilter"> <property name="waveType"> <value>2</value> </property> <property name="XAmplitude"> <value>2</value> </property> <property name="YAmplitude"> <value>2</value> </property> <property name="XWavelength"> <value>10</value> </property> <property name="YWavelength"> <value>10</value> </property> <property name="edgeAction"> <value>1</value> </property> </bean> <bean id="ripple3" class="com.jhlabs.image.RippleFilter"> <property name="waveType"> <value>5</value> </property> <property name="XAmplitude"> <value>5</value> </property> <property name="YAmplitude"> <value>5</value> </property> <property name="XWavelength"> <value>10</value> </property> <property name="YWavelength"> <value>10</value> </property> <property name="edgeAction"> <value>1</value> </property> </bean> <bean id="twirl" class="com.jhlabs.image.TwirlFilter"> <property name="angle"> <value>0.8</value> </property> </bean> <bean id="water" class="com.jhlabs.image.WaterFilter"> <property name="amplitude"> <value>2</value> </property> <property name="antialias"> <value>true</value> </property> <property name="wavelength"> <value>20</value> </property> </bean> <bean id="weaves" class="com.jhlabs.image.WeaveFilter"> <property name="useImageColors"> <value>true</value> </property> <property name="XGap"> <value>2</value> </property> <property name="XWidth"> <value>10</value> </property> <property name="YWidth"> <value>16</value> </property> <property name="YGap"> <value>6</value> </property> </bean> <bean id="crystal" class="com.jhlabs.image.CrystalizeFilter"> <property name="scale"> <value>0.5</value> </property> <property name="gridType"> <value>1</value> </property> <property name="fadeEdges"> <value>false</value> </property> <property name="edgeThickness"> <value>0.4</value> </property> <property name="randomness"> <value>1.0</value> </property> </bean> <bean id="smearDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="smear" /> </list> </constructor-arg> </bean> <bean id="rippleDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="ripple" /> </list> </constructor-arg> </bean> <bean id="ripple2Deformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="ripple2" /> </list> </constructor-arg> </bean> <bean id="ripple3Deformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="ripple3" /> </list> </constructor-arg> </bean> <bean id="sphereDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="sphere" /> </list> </constructor-arg> </bean> <bean id="waterDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="water" /> </list> </constructor-arg> </bean> <bean id="embossDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="emboss" /> </list> </constructor-arg> </bean> <bean id="rippleDeformationBack" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="rippleBack" /> </list> </constructor-arg> </bean> <bean id="cristalDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="crystal" /> </list> </constructor-arg> </bean> <bean id="weavesDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="weaves" /> </list> </constructor-arg> </bean> <bean id="twirlDeformation" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <list> <ref bean="twirl" /> </list> </constructor-arg> </bean> <bean id="none" class="com.octo.captcha.component.image.deformation.ImageDeformationByFilters"> <constructor-arg index="0"> <null /> </constructor-arg> </bean> </beans>

Mapping 2 or more URL patterns with same servlet

We have a simple Spring MVC servlet (as usual), nothing out of normal. <servlet> <description>The framework will, on initialization of a DispatcherServlet, look for a file named [servlet-name]-servlet.xml (webApplicationContext-servlet.xml) in WEB-INF</description> <servlet-name>webApplicationContext</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/conf/spring/webApplicationContext.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet>
With its respective mapping <servlet-mapping> <servlet-name>webApplicationContext</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping>
This is the tricky part, I want to map some weird request mappings like: *.htm or *.jspx (besides *.do)

• registerCustomer.do
• registerCustomer.htm
• registerCustomer.jspx

The solution is simple, just add another entry to your servlet-mapping: <servlet-mapping> <servlet-name>webApplicationContext</servlet-name> <url-pattern>*.do</url-pattern> <url-pattern>*.htm</url-pattern> </servlet-mapping> The only restriction is to use web-app version=2.4 or 2.5
I always use 2.4 and I didn't have anything else to do. But for educational purposes I updated my web.xml (web app descriptor) for my future developments.

Spring MVC - Binding VO to a Form

Problema:
I have a VO and I wanted to populate it on my JSP and on my controller just process the VO already populated.

Solution:
@Controller @RequestMapping(value = "/loggers/*") public class LoggersConfigurationController extends BaseCustomController { private static final Logger log = Logger .getLogger(LoggersConfigurationController.class); @SuppressWarnings("unchecked") @RequestMapping(value = "configureLoggers.do", method = RequestMethod.GET) public String showScreen(HttpServletRequest request, HttpServletResponse response, ModelMap modelMap) { if (!this.isLoggedIn(request)) { return "redirect:/authentication/notLoggedIn.do"; } log.debug("Show Screen when RequestMethod.GET"); //By doing this I'm preparing my diabolic plan!!! LoggerVO loggerVO = new LoggerVO(); modelMap.put("LoggerVO", loggerVO); return "configuration/loggersConfiguration"; } @SuppressWarnings("unchecked") @RequestMapping(value = "configureLoggers.do", method = RequestMethod.POST) public String updateLogger( HttpServletRequest request, HttpServletResponse response, ModelMap modelMap, @ModelAttribute(value="LoggerVO") LoggerVO loggerVO) { if (!this.isLoggedIn(request)) { return "redirect:/authentication/notLoggedIn.do"; } log.debug("Update logger when RequestMethod.POST"); List<String> messages = new ArrayList<String>(); log.debug("@ModelAttribute="+loggerVO); LogUtils.getInstance().setLogger(loggerVO); messages.add(loggerVO.getName()+" updated successfully to "+loggerVO.getLevel()); modelMap.put("KEY_LIST_MESSAGES", messages); //return "configuration/loggersConfiguration"; return "index-tabbed"; } }
On my POST method I'll handle my VO already populated.
This entry will do 50% of the job @ModelAttribute(value="LoggerVO") LoggerVO loggerVO
On my JSP I'll map using spring's tag library <%@taglib prefix="spring" uri="http://www.springframework.org/tags" %> <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %> <%@taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %> <H2>Loggers Configuration</H2> <form:form id="loggersForm" name="loggersForm" modelAttribute="LoggerVO" commandName="LoggerVO" action="/${pageContext.servletContext.servletContextName}/loggers/configureLoggers.do" method="POST"> <table width="100%"> <tr> <td><label for="name">Logger Name</label></td> <td> <form:select path="name" items="${applicationScope.KEY_LIST_LOGGERS}" itemValue="name" itemLabel="name"/> </td> </tr> <tr> <td><label for="level">Level</label></td> <td> <form:select path="level" items="${applicationScope.KEY_LIST_LOG_LEVELS}"/> </td> </tr> </table> <p> <input type="submit" value="Update"> </p> <div style="visibility: hidden"> <form:select path="appenderVOs"/> </div> </form:form> <c:if test="${!empty requestScope.KEY_LIST_MESSAGES}"> <script>alert("${requestScope.KEY_LIST_MESSAGES}");</script> </c:if>
By doing this modelAttribute="LoggerVO" commandName="LoggerVO"
I'm matching what I have on my form and what I have on my Controller <form:form id="loggersForm" name="loggersForm" modelAttribute="LoggerVO" commandName="LoggerVO" action="/${pageContext.servletContext.servletContextName}/loggers/configureLoggers.do" method="POST">
I hope this will help you!
Salu2

Adding Spring Web MVC part 2

Now I'll show you a couple of examples how it looks like a Controller & a JSP using Spring MVC.

From my personal perspective Defining a controller gives you a lot of power, because you can define a method to handle RequestMethod.GET, just to show a Form, and another method to handle the RequestMethod.POST to handle the "submit", cool isn't it?

import org.springframework.stereotype.Controller; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; /** * Consumers Configuration Controller * * @author Juan Cruz */ @Controller @RequestMapping(value="/configuration/*") public class ConsumersConfigurationController extends BaseCustomController{ @Autowired private SomeInterfaceService myInstanceService; public ConsumersConfigurationController() { //You can intialize something or just use } @RequestMapping(value = "showConsumersConfiguration.do") public String showConsumersConfiguration(HttpServletRequest request, HttpServletResponse response, ModelMap modelMap) { if(!this.isLoggedIn(request)){ return "redirect:/authentication/logout.do"; } log.debug("showConsumersConfiguration"); modelMap.put("KEY_LIST_EAST_SERVERS", listEastServers); modelMap.put("KEY_LIST_WEST_SERVERS", listWestServers); modelMap.put("KEY_LIST_NORTH_SERVERS", listNorthServers); return "configuration/consumersConfiguration";//show jsp }

By adding @Controller you already told Spring, "hey this dude is going to be a Controller".

@RequestMapping(value="/configuration/*") means: "If my URL is WebContext/configuration/ this Controller is going to handle the Request"

Then on each method I can define my path below /configuration/ @RequestMapping(value = "showConsumersConfiguration.do"), something like this WebContext/configuration/showConsumersConfiguration.do

I almost forgot @Autowired which is for inject implementation of that Bean

If you want to handle an object like a form (bind an object to a form), check this out

<%@taglib prefix="spring" uri="http://www.springframework.org/tags" %> <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %> <form:form id="loginForm" name="loginForm" modelAttribute="UserVO" action="doLogin.do" method="post"> <table width="100%"> <tr> <td><label for="userId">Login</label></td> <td><form:input path="userId" size="20" title="By default you will see your US-WIN."/></td> </tr> <tr> <td><label for="password">Password</label></td> <td><form:password path="password" size="20" title="Enter your US-WIN password."/></td> </tr> </table> <p> <input type="submit" value="Authenticate"> </p> <form:hidden path="email"/> <form:hidden path="firstName"/> <form:hidden path="lastName"/> </form:form>

Important, include these tag libraries!

By using this attribute modelAttribute="UserVO" of form:form tag, I'm binding this line of my controller: modelMap.put("UserVO", userVO); with my form

public class UserVO implements Serializable { private String userId; private String password; private String email; private String firstName; private String lastName; }

If you see carefully, each attribute of my VO, has a reference on my JSP, at least as hidden field, but all of them are there

@Controller @RequestMapping(value = "/authentication/*") public class LoginController extends BaseCustomController{ @RequestMapping(value = "doLogin.do") public String authenticateUser(HttpServletRequest request, HttpServletResponse response, ModelMap modelMap, @ModelAttribute UserVO paramUserVO) { } @RequestMapping(value = "login.do") public String showLogin(HttpServletRequest request, HttpServletResponse response, ModelMap modelMap) { UserVO userVO = new UserVO(); modelMap.put("UserVO", userVO); return "authentication/login";//show jsp }

Now my form has been binded to my VO @ModelAttribute UserVO paramUserVO

Now you're ready to play around with this thing!!!

Always go to the official documentation to get more details!!!

Adding Spring Web MVC

I'll try to be brief.

Basically, you need to add a new Servlet on you web.xml, a configuration file (let's call it webApplicationContext.xml) and some Annotations.

This is my example:

My web.xml <servlet> <servlet-name>webApplicationContext</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/conf/spring/webApplicationContext.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>webApplicationContext</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping>

The framework will, on initialization of a DispatcherServlet, look for a file named [servlet-name]-servlet.xml (webApplicationContext-servlet.xml) in WEB-INF by default, but if you provide parameter "contextConfigLocation" you can define a location and name for your configuration file.

My webApplicationContext.xml <?xml version="1.0" encoding="UTF-8" ?> <beans xmlns = "http://www.springframework.org/schema/beans" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:context = "http://www.springframework.org/schema/context" xsi:schemaLocation = "http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd"> <!--================== Annotation config =====================--> <context:annotation-config/> <!--================== Location of Controllers =====================--> <context:component-scan base-package = "com.vzw.common.gsbsocketapp.web.controller"/> <!--================== InternalResourceViewResolver =====================--> <bean class = "org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name = "viewClass" value = "org.springframework.web.servlet.view.JstlView"/> <property name = "prefix" value = "/jsp/"/> <property name = "suffix" value = ".jsp"/> </bean> </beans>

Which basically is divided in 3 sections:

• We're going to use configuration based onn annotations
• Location of my Controllers
• And where are located my JSP's

In my next entry I'll cover how it looks like a Controller & JSP.

WebServices with CXF - Configuration files - web.xml

<web-app version = "2.4" xmlns = "http://java.sun.com/xml/ns/j2ee" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation = "http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"> <display-name>Archetype Created Web Application</display-name> <context-param> <param-name>webAppRootKey</param-name> <param-value>my-web-app</param-value> </context-param> <!--Log4J Configuration --> <context-param> <param-name>log4jConfigLocation</param-name> <param-value>/WEB-INF/conf/log4j/log4j-config.xml</param-value> </context-param> <!--Spring Context Configuration --> <context-param> <param-name>contextConfigLocation</param-name> <param-value> /WEB-INF/conf/spring/daoApplicationContext.xml, /WEB-INF/conf/spring/serviceApplicationContext.xml, /WEB-INF/conf/cxf/cxf-services.xml </param-value> </context-param> <!--Log4J Listener --> <listener> <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener> <!--Spring Context Listener --> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <!--Another Context Listener --> <listener> <listener-class>mx.com.mylibrary.web.listener.ContextListener</listener-class> </listener> <!--Servlet Declarations --> <servlet> <servlet-name>webApplicationServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <init-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/conf/spring/webApplicationContext.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet> <display-name>CXF Servlet</display-name> <servlet-name>CXFServlet</servlet-name> <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/services/*</url-pattern> </servlet-mapping> <!--Servlet Mappings --> <servlet-mapping> <servlet-name>webApplicationServlet</servlet-name> <url-pattern>*.do</url-pattern> </servlet-mapping> <!--Session Time-out in minutes --> <session-config> <session-timeout>30</session-timeout> </session-config> <!--Welcome file --> <welcome-file-list> <welcome-file>/index.jsp</welcome-file> </welcome-file-list> <!--Reference to a DB Conection --> <resource-ref> <description>DB Connection</description> <res-ref-name>jdbc/bookStoreDS</res-ref-name> <res-type>javax.sql.DataSource</res-type> <res-auth>Container</res-auth> <res-sharing-scope>Shareable</res-sharing-scope> </resource-ref> </web-app>

WebServices with CXF - My Service interface & Impl

Like with our DTO's, later this code will be having some changes when Apache CXF is called to scene.

package mx.com.mylibrary.core.business.service; import java.util.List; import mx.com.mylibrary.core.business.dto.AuthorDTO; import mx.com.mylibrary.core.business.dto.BookDTO; import mx.com.mylibrary.core.business.dto.EditorDTO; /** * Service interface * * @author Juan Carlos Cruz * @since May 02 2010 */ public interface LibraryService { public List<AuthorDTO> getAllAuthors(); public List<BookDTO> getAllBooks(); public List<EditorDTO> getAllEditors(); public List<EditorDTO> getAllOnlyEditors(); public void saveAuthor(AuthorDTO authorDTO); public void saveBook(BookDTO bookDTO); public void saveEditor(EditorDTO editorDTO); public void addBook(AuthorDTO authorDTO, BookDTO bookDTO, EditorDTO editorDTO); public BookDTO getBook(@WebParam(name="bookIdentifier") Integer bookId); public void updateBook(BookDTO bookDTO); } Now this is my implementation, as you see I'm becoming fan of the use of annotations. I feel like "NIÑO CHIQUITO" (child) with new toy. package mx.com.mylibrary.core.business.service.impl; import java.util.ArrayList; import java.util.List; import mx.com.mylibrary.core.business.dto.AuthorDTO; import mx.com.mylibrary.core.business.dto.BookDTO; import mx.com.mylibrary.core.business.dto.EditorDTO; import mx.com.mylibrary.core.business.service.LibraryService; import mx.com.mylibrary.core.persistence.dao.AuthorDAO; import mx.com.mylibrary.core.persistence.dao.BookDAO; import mx.com.mylibrary.core.persistence.dao.EditorDAO; import mx.com.mylibrary.core.persistence.domain.Author; import mx.com.mylibrary.core.persistence.domain.Book; import mx.com.mylibrary.core.persistence.domain.Editor; import mx.com.mylibrary.core.util.Transformer; import org.apache.log4j.Logger; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.transaction.annotation.Isolation; import org.springframework.transaction.annotation.Propagation; import org.springframework.transaction.annotation.Transactional; /** * Service implementation * * @author Juan Carlos Cruz * @since May 02 2010 */ public class LibraryServiceImpl implements LibraryService { private static final Logger log = Logger .getLogger(LibraryServiceImpl.class); @Autowired private AuthorDAO authorDAO; @Autowired private EditorDAO editorDAO; @Autowired private BookDAO bookDAO; @Transactional(readOnly = true, propagation = Propagation.NOT_SUPPORTED, isolation = Isolation.READ_COMMITTED) public List<AuthorDTO> getAllAuthors() { log.debug("Get all Authors"); List<AuthorDTO> result = new ArrayList<AuthorDTO>(); List<Author> authors = this.authorDAO.findByExample(new Author()); for (Author author : authors) { AuthorDTO authorDTO = Transformer.transformToDTO(author); List<Book> books = author.getBooks(); List<BookDTO> bookDTOs = new ArrayList<BookDTO>(); for(Book book: books){ bookDTOs.add(Transformer.transformToDTO(book)); } authorDTO.setListBooks(bookDTOs); result.add(authorDTO); } log.debug(result.size() + " Items retrieved"); return result; } @Transactional(readOnly = false, propagation = Propagation.REQUIRED) public void addBook(AuthorDTO authorDTO, BookDTO bookDTO, EditorDTO editorDTO) { log.debug("Save Book " + authorDTO + "; " + bookDTO + "; " + editorDTO); Author author = Transformer.transformToPojo(authorDTO); Book book = Transformer.transformToPojo(bookDTO); Editor editor = Transformer.transformToPojo(editorDTO); log.debug("Saving "+author); this.authorDAO.save(author); log.debug("Saving "+editor); this.editorDAO.save(editor); book.setEditor(editor); log.debug("Saving "+book); this.bookDAO.save(book); List<Book> books = new ArrayList<Book>(); books.add(book); log.debug("Saving AuthorBook"); author.setBooks(books); log.debug("addBook successfull"); } @Transactional(readOnly = true, propagation = Propagation.NOT_SUPPORTED, isolation = Isolation.READ_COMMITTED) public List<BookDTO> getAllBooks() { log.debug("get All Books"); List<BookDTO> result = new ArrayList<BookDTO>(); List<Book> books = this.bookDAO.findByExample(new Book()); for (Book book : books) { BookDTO bookDTO = Transformer.transformToDTO(book); Editor editor = book.getEditor(); List<Author> authors = book.getAutores(); List<AuthorDTO> authorDTOs = new ArrayList<AuthorDTO>(); for (Author author : authors) { AuthorDTO authorDTO = Transformer.transformToDTO(author); authorDTOs.add(authorDTO); } if(editor!=null){ EditorDTO editorDTO = Transformer.transformToDTO(editor); bookDTO.setEditorDTO(editorDTO); } bookDTO.setListAutors(authorDTOs); result.add(bookDTO); } log.debug(result.size() + " Items retrieved"); return result; } @Transactional(readOnly = true, propagation = Propagation.NOT_SUPPORTED, isolation = Isolation.READ_COMMITTED) public List<EditorDTO> getAllEditors() { log.debug("get All Editors"); List<EditorDTO> result = new ArrayList<EditorDTO>(); List<Editor> editors = this.editorDAO.findByExample(new Editor()); for (Editor editor : editors) { EditorDTO editorDTO = Transformer.transformToDTO(editor); List<Book> books = editor.getBooks(); List<BookDTO> bookDTOs = new ArrayList<BookDTO>(); for(Book book: books){ bookDTOs.add(Transformer.transformToDTO(book)); } editorDTO.setListBooks(bookDTOs); result.add(editorDTO); } log.debug(result.size() + " Items retrieved"); return result; } @Transactional(readOnly=true, propagation = Propagation.NOT_SUPPORTED, isolation = Isolation.READ_COMMITTED) public List<EditorDTO> getAllOnlyEditors() { log.debug("get All Editors"); List<EditorDTO> result = new ArrayList<EditorDTO>(); List<Editor> editors = this.editorDAO.findByExample(new Editor()); for (Editor editor : editors) { EditorDTO editorDTO = Transformer.transformToDTO(editor); result.add(editorDTO); } log.debug(result.size() + " Items retrieved"); return result; } @Transactional(readOnly = true, propagation = Propagation.NOT_SUPPORTED, isolation = Isolation.READ_COMMITTED) public BookDTO getBook(Integer bookId) { log.debug("get Book bookId ="+bookId); List<AuthorDTO> listAutorsDTO = new ArrayList<AuthorDTO>(); BookDTO result = new BookDTO(); Book book = this.bookDAO.findById(bookId); result = Transformer.transformToDTO(book); result.setEditorDTO(Transformer.transformToDTO(book.getEditor())); List<Author> listAuthors = book.getAutores(); for(Author author: listAuthors){ listAutorsDTO.add(Transformer.transformToDTO(author)); } result.setListAutors(listAutorsDTO); return result; } @Transactional(readOnly = false, propagation = Propagation.REQUIRED) public void saveAuthor(AuthorDTO authorDTO) { log.debug("Save Author " + authorDTO); this.authorDAO.save(Transformer.transformToPojo(authorDTO)); log.debug("saveAuthor successfull"); } @Transactional(readOnly = false, propagation = Propagation.REQUIRED) public void saveBook(BookDTO bookDTO) { log.debug("Save Book " + bookDTO); Book book = Transformer.transformToPojo(bookDTO); if(bookDTO.getEditorDTO()!=null && bookDTO.getEditorDTO().getEditorId()!=null){ book.setEditor(Transformer.transformToPojo(bookDTO.getEditorDTO())); } this.bookDAO.save(book); log.debug("saveBook successfull"); } @Transactional(readOnly = false, propagation = Propagation.REQUIRED) public void saveEditor(EditorDTO editorDTO) { log.debug("Save Editor " + editorDTO); this.editorDAO.save(Transformer.transformToPojo(editorDTO)); log.debug("saveEditor successfull"); } @Transactional(readOnly = false, propagation = Propagation.REQUIRED) public void updateBook(BookDTO bookDTO) { log.debug("Update Book " + bookDTO); this.bookDAO.update(Transformer.transformToPojo(bookDTO)); log.debug("updateBook successfull"); } }

In future entries I'll explain the configuration files involved to attach together Hibernate, Spring and Apache CXF.
But for now, let'f finish with Hibernate+Spring part and then we'll integrate with Apache CXF (then we'll talk about confuration files)

Hasta luego!

WebServices with CXF - My DTO's

For your DTO's youmust apply the same rule like with every Java Bean (getter's & setter's, toString, hashCode, equals & Serialization)

My first step is creating a base DTO with all common fields and methods, then it's just extending from that class. I'll just put 2 examples, Ok?

package mx.com.mylibrary.core.business.dto; import java.io.Serializable; import java.util.Date; public abstract class BaseDTO implements Serializable { private static final long serialVersionUID = -2375424405198208312L; private Date createDate; public Date getCreateDate() { return createDate; } public void setCreateDate(Date createDate) { this.createDate = createDate; } @Override public abstract int hashCode(); @Override public abstract boolean equals(Object obj); } package mx.com.mylibrary.core.business.dto; import java.io.Serializable; import java.util.List; /** * * Data Transfer Object * * @author Juan Carlos Cruz * @since May 23 2010 */ public class AuthorDTO extends BaseDTO implements Serializable { private static final long serialVersionUID = -5573197656310571940L; private Integer authorId; private String name; private String email; private List<BookDTO> listBooks; //getter's and setter's } package mx.com.mylibrary.core.business.dto; import java.io.Serializable; import java.util.List; /** * * Data Transfer Object * * @author Juan Carlos Cruz * @since May 23 2010 */ @XmlType(name="Book") public class BookDTO extends BaseDTO implements Serializable { private static final long serialVersionUID = 3254611377962442345L; private Integer bookId; private String title; private EditorDTO editorDTO = new EditorDTO(); private List<AuthorDTO> listAutors; //getter's and setter's }

Later we'll have to retake this objects, because we'll have add some extra lines (anotations) just to make them compatible with our WebServices framework, it will be fun.

WebServices with CXF - My Pojos & DAOs

First thing, is a good practice declaring methods equals and hashCode
You know what, I'll skip these methods on my code, eclipse can do it for you, don't be lazy!!!
And one more thing, as Architect it's a must declaring toString method, because when you're debugging these method it's going to be really helpful, and you know what... declare toString it's a must too.
package mx.com.mylibrary.core.persistence.domain; import java.io.Serializable; import java.util.ArrayList; import java.util.Date; import java.util.List; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.FetchType; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.OneToMany; import javax.persistence.Table; /** * * Domain Object * * @author Juan Carlos Cruz * @since Sep 26 2009 */ @Entity @Table(name = "EDITOR") public class Editor implements Serializable { private static final long serialVersionUID = 5125858002922739070L; @Id @GeneratedValue(strategy = GenerationType.AUTO) @Column(name = "editor_id", unique = true) private Integer editorId; @Column(name = "title", length = 200, nullable = false) private String name; @Column(name = "url", length = 255, nullable = true) private String url; @Column(name = "create_date", insertable = false, updatable = false, columnDefinition = "Timestamp DEFAULT CURRENT_TIMESTAMP") private Date createDate; @OneToMany(mappedBy="editor", fetch=FetchType.LAZY) private List<Book> books = new ArrayList<Book>(0); //Setters & Getters } package mx.com.mylibrary.core.persistence.domain; import java.io.Serializable; import java.util.ArrayList; import java.util.Date; import java.util.List; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.FetchType; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.JoinColumn; import javax.persistence.JoinTable; import javax.persistence.ManyToMany; import javax.persistence.ManyToOne; import javax.persistence.Table; import javax.persistence.UniqueConstraint; /** * * Domain Object * * @author Juan Carlos Cruz * @since Sep 26 2009 */ @Entity @Table(name = "BOOK") public class Book implements Serializable { private static final long serialVersionUID = -5220399448304637221L; @Id @GeneratedValue(strategy = GenerationType.AUTO) @Column(name = "book_id", unique = true) private Integer bookId; @Column(name = "title", length = 200, nullable = false) private String title; @Column(name = "create_date", insertable = false, updatable = false, columnDefinition = "Timestamp DEFAULT CURRENT_TIMESTAMP") private Date createDate; @ManyToOne(optional = true, fetch = FetchType.EAGER) @JoinColumn(name = "editor_id", nullable = true, updatable = true) private Editor editor; @ManyToMany(fetch = FetchType.LAZY) @JoinTable(name = "AUTHOR_BOOK", joinColumns = @JoinColumn(name = "book_id", referencedColumnName = "book_id"), inverseJoinColumns = @JoinColumn(name = "author_id", referencedColumnName = "author_id"), uniqueConstraints = @UniqueConstraint( columnNames = {"book_id", "author_id"} ) ) private List<Author> autores = new ArrayList<Author>(0); //Setters & Getters } package mx.com.mylibrary.core.persistence.domain; import java.io.Serializable; import java.util.ArrayList; import java.util.Date; import java.util.List; import javax.persistence.CascadeType; import javax.persistence.Column; import javax.persistence.Entity; import javax.persistence.FetchType; import javax.persistence.GeneratedValue; import javax.persistence.GenerationType; import javax.persistence.Id; import javax.persistence.JoinColumn; import javax.persistence.JoinTable; import javax.persistence.ManyToMany; import javax.persistence.Table; /** * * Domain Object * * @author Juan Carlos Cruz * @since Sep 26 2009 */ @Entity @Table(name = "AUTHOR") public class Author implements Serializable { private static final long serialVersionUID = 3065679411071650221L; @Id @GeneratedValue(strategy = GenerationType.AUTO) @Column(name = "author_id", unique = true) private Integer authorId; @Column(name = "name", length = 100, nullable = false) private String name; @Column(name = "email", length = 100, nullable = true) private String email; @Column(name = "create_date", insertable = false, updatable = false, columnDefinition = "Timestamp DEFAULT CURRENT_TIMESTAMP") private Date createDate; @ManyToMany(fetch = FetchType.LAZY, cascade = CascadeType.ALL) @JoinTable(name = "AUTHOR_BOOK", joinColumns = @JoinColumn(name = "author_id", referencedColumnName = "author_id"), inverseJoinColumns = @JoinColumn(name = "book_id", referencedColumnName = "book_id") ) private List<Book> books = new ArrayList<Book>(0); //Setters & Getters } The next step is explain what are those annotations, well they're Java 6 annotations, so we can skip some configurations and declare them into our code. I'll try to explain as simple as possible these annotations, let's analyze them: @Entity @Table(name = "EDITOR") public class Editor...

What I'm doing here is just declaring that this POJO will be an Entity which maps to a table called EDITOR

@Id @GeneratedValue(strategy = GenerationType.AUTO) @Column(name = "editor_id", unique = true) private Integer editorId; @Column(name = "title", length = 200, nullable = false) private String name; @Column(name = "url", length = 255, nullable = true) private String url; @Column(name = "create_date", insertable = false, updatable = false, columnDefinition = "Timestamp DEFAULT CURRENT_TIMESTAMP") private Date createDate; @OneToMany(mappedBy="editor", fetch=FetchType.LAZY) private List<Book> books = new ArrayList<Book>(0);

Using Annotations, I declared that editorId is my PK which basically is AutoIncremental and to which column will be mapped. With columns is really easy.

But what about relations??? Like

BOOK >-- EDITOR

In this case I just declared what I needed to declare: One Editor has Many books using a List of Book, like in every mapping of Hibernate: the most common fetching strategy to be used will be LAZY; basically what I did was linking the current ENTITY by it's PK (mappedBy="editor") to Book

So in Book this is what we have to do (the inverse to OneToMany and define an Editor for each Book, so each child will have a reference to it's Dad):
@ManyToOne(optional = true, fetch = FetchType.EAGER) @JoinColumn(name = "editor_id", nullable = true, updatable = true) private Editor editor;

The last thing is just declare which column & attribute will be used to do the JOIN between child and father

You can get more details if you look for that topic in Hibernate official documentation.
And these are my DAO's (I just included 1 as example), others should be similar. Always code oriented to interfaces! Later you'll thank me. package mx.com.mylibrary.core.persistence.dao; import java.util.List; import mx.com.mylibrary.core.persistence.domain.Book; import org.springframework.dao.DataAccessException; /** * Data access object Interface (DAO) for domain model class Book. * * @author Juan Carlos Cruz * @since September 29 2009 */ public interface BookDAO { public void save(Book transientInstance) throws DataAccessException; public void delete(Book persistentInstance) throws DataAccessException; public Book findById(Integer id) throws DataAccessException; public List<Book> findByExample(Book instance) throws DataAccessException; public List<Book> findByProperty(String propertyName, Object value) throws DataAccessException; public void saveOrUpdate(Book instance) throws DataAccessException; public void update(Book instance) throws DataAccessException; } package mx.com.mylibrary.core.persistence.dao.impl; import java.util.List; import mx.com.mylibrary.core.persistence.dao.BookDAO; import mx.com.mylibrary.core.persistence.domain.Book; import org.hibernate.Criteria; import org.hibernate.SessionFactory; import org.hibernate.criterion.Example; import org.hibernate.criterion.MatchMode; import org.hibernate.criterion.Restrictions; import org.springframework.dao.DataAccessException; /** * Data access object Implementation (DAO) for domain model class Book. * * @author Juan Carlos Cruz * @since September 29 2009 */ public class BookDAOImpl implements BookDAO { private SessionFactory sessionFactory; public void setSessionFactory(SessionFactory sessionFactory) { this.sessionFactory = sessionFactory; } public void delete(Book persistentInstance) { this.sessionFactory.getCurrentSession().delete(persistentInstance); } @SuppressWarnings("unchecked") public List<Book> findByExample(Book instance) throws DataAccessException { Criteria criteria = this.sessionFactory.getCurrentSession().createCriteria(Book.class); Example example = Example.create(instance).ignoreCase(); example.enableLike(MatchMode.START); example.excludeZeroes(); criteria.add(example); return criteria.list(); } @SuppressWarnings("unchecked") public Book findById(Integer id) { Criteria criteria = this.sessionFactory.getCurrentSession().createCriteria(Book.class); criteria.add(Restrictions.eq("bookId", id)); List<Book> items = criteria.list(); return items.isEmpty()?null:items.get(0); } @SuppressWarnings("unchecked") public List<Book> findByProperty(String propertyName, Object value) throws DataAccessException { Criteria criteria = this.sessionFactory.getCurrentSession().createCriteria(Book.class); criteria.add(Restrictions.eq(propertyName, value)); return criteria.list(); } public void save(Book transientInstance) { this.sessionFactory.getCurrentSession().save(transientInstance); } public void saveOrUpdate(Book instance) { this.sessionFactory.getCurrentSession().saveOrUpdate(instance); } public void update(Book instance) { this.sessionFactory.getCurrentSession().update(instance); } } In my next entry I will explain my Services and we'll be ready for using CXF.