Spring Roo 1.1 Cookbook

Table of Contents

Spring Roo 1.1 Cookbook

Credits

About the Author

About the Reviewers

www.PacktPub.com

Support files, eBooks, discount offers and more

Why Subscribe?

Free Access for Packt account holders

Preface

What this book covers

What you need for this book

Who this book is for

Conventions

Reader feedback

Customer support

Downloading the example code

Errata

Piracy

Questions

1. Getting Started with Spring Roo

Introduction

Setting up Roo

Getting ready

How to do it...

How it works...

There's more...

Using Spring Roo with Eclipse/STS

See also

Getting help and hints from Roo

Getting ready

How to do it...

How it works...

There's more...

Passing arguments to Roo commands

Log file for executed Roo commands

See also

Creating a Roo project

Getting ready

How to do it...

How it works...

There's more...

See also

Importing a Roo project into Eclipse or IntelliJ IDEA IDE

Getting ready

How to do it...

How it works...

There's more...

See also

Configuring logging

Getting ready

How to do it...

How it works...

There's more...

See also

Viewing properties defined in a properties file

Getting ready

How to do it...

How it works...

See also

Managing properties defined in a properties file

Getting ready

How to do it...

How it works...

There's more...

See also

Creating a Java class

Getting ready

How to do it...

How it works...

There's more...

Moving existing Spring projects to use Spring Roo

@RooToString—customizing the name of the toString method

@RooToString—excluding properties from the toString method

See also

Adding attributes to a Java class

Getting ready

How to do it...

How it works...

There's more...

@RooJavaBean—controlling the generation of getter and setter methods

See also

Creating a Java interface

Getting ready

How to do it...

How it works...

There's more...

See also

Referring to a type from the Roo shell

Getting ready

How to do it...

How it works...

There's more...

See also

Creating application artifacts from Roo script

Getting ready

How to do it...

How it works...

There's more...

See also

2. Persisting Objects Using JPA

Introduction

Setting up a JPA provider for your project

Getting ready

How to do it...

How it works...

There's more...

JNDI-bound data source

See also

Viewing database configuration properties

Getting ready

How to do it...

How it works...

There's more...

See also

Managing database configuration properties

Getting ready

How to do it...

How it works...

There's more...

See also

Creating persistent entities

Getting ready

How to do it...

How it works...

There's more...

Adding table column information in persistent entity fields

The class argument in roo commands

See also

Adding JSR 303 constraints to persistent fields

Getting ready

How to do it...

How it works...

There's more...

See also

Controlling auto-generated methods of persistent entities

Getting ready

How to do it...

How it works...

See also

Creating integration tests for persistent entities

Getting ready

How to do it...

How it works...

There's more...

Customizing seed data creation

Controlling integration test methods

Generating integration tests at the time of entity creation

Providing custom implementation for integration tests

See also

Creating new 'data on demand' for testing entities

Getting ready

How to do it...

How it works...

See also

Creating mock tests for persistent entities

Getting ready

How to do it...

How it works...

See also

Executing persistent entities tests

Getting ready

How to do it...

How it works...

There's more...

See also

Creating applications that interact with multiple databases

Getting ready

How to do it...

How it works...

See also

Packaging your Roo project

Getting ready

How to do it...

How it works...

There's more...

See also

3. Advanced JPA Support in Spring Roo

Introduction

Viewing candidate dynamic finder methods

Getting ready

How to do it...

How it works...

There's more...

Listing dynamic finder methods for multiple persistent fields

Limiting list of dynamic finder methods, based on a filter criteria

See also

Adding dynamic finder methods to an entity

Getting ready

How to do it...

How it works...

There's more...

Adding custom finder methods

Integration testing of dynamic finder methods

Adding dynamic finders through @RooEntity annotation

See also

Creating a many-to-one (or one-to-one) relationship between entities

Getting ready

How to do it...

How it works...

There's more...

Testing JPA entities that participate in relationships

Dynamic finder method for a many-to-one relationship field

See also

Creating a one-to-many (or many-to-many)relationship between entities

Getting ready

How to do it...

How it works...

There's more...

See also

Creating a mapped superclass

Getting ready

How to do it...

How it works...

There's more...

Creating @Embeddable annotated classes

See also

Customizing Roo-generated identifier definition

Getting ready

How to do it...

How it works...

There's more...

See also

Generating database metadata

Getting ready

How to do it...

How it works...

There's more...

See also

Creating entities from a database

Getting ready

How to do it...

How it works...

There's more...

Installing JDBC drivers for Oracle and DB2

Modifying auto-generated JPA fields/relationships

Incremental database reverse engineering

Database table with composite primary key

See also

4. Web Application Development with Spring Web MVC

Introduction

Auto-generating Spring MVC controllers andJSPX views from JPA entities

Getting ready

How to do it...

How it works...

Configuration information defined in web.xml

contextConfigLocation initialization parameter

ContextLoaderListener

DispatcherServlet

OpenEntityManagerInViewFilter

HiddenHttpMethodFilter

Exception pages

Beans and configurations defined in webmvc-config.xml

Controller auto-detection

Annotation-driven development support and conversion service

ResourceHttpRequestHandler

DefaultServletHttpRequestHandler

Theme and locale change interceptors

ParameterizableViewController

View resolution

Tiles definitions

Exception handling

Miscellaneous configuration

Roo-generated controllers

There's more...

See also

Packaging, deploying, and using aRoo-generated Spring MVC application

Getting ready

How to do it...

How it works...

There's more...

Running Roo project in embedded Jetty container

See also

Modifying Roo-generated views

Getting ready

How to do it...

How it works...

Changing the displayed application name and welcome text

Changing menu options

Significance of z attribute of Roo installed JSP tags

Understanding a Roo-generated JSPX file

Switching elements from user-managed to Roo-managed mode

See also

Round-tripping support in Spring Roofor web controllers and views

Getting ready

How to do it...

How it works...

There's more...

See also

Creating a Spring MVC controller for a specific JPA entity

Getting ready

How to do it...

How it works...

There's more...

Overriding auto-generated controller methods

See also

Manually creating a Spring MVC controller for a JPA entity

Getting ready

How to do it...

How it works...

There's more...

Scaffolding Spring Web MVC application for a one-to-many relationship

See also

Adding static views to a Roo-generated web application

Getting ready

How to do it...

How it works...

See also

Internationalizing Roo-generated web applications

Getting ready

How to do it...

How it works...

There's more...

See also

Adding or modifying themes generated by Roo

Getting ready

How to do it...

How it works...

There's more...

See also

Adding JSON support to domain objects and controllers

Getting ready

How to do it...

How it works...

See also

Creating and executing Selenium tests for web controllers

Getting ready

How to do it...

How it works...

Selenium test scripts

Selenium test suite

There's more...

See also

5. Web Application Development with GWT, Flex, and Spring Web Flow

Introduction

Scaffolding GWT applications from JPA entities

Getting ready

How to do it...

How it works...

GWT module descriptor

The GWT module's entry point

Dependency injection using GIN

EntityProxy, RequestContext, and RequestFactory interfaces

Activities and places

Dealing with entity proxy-specific processing

There's more...

Compiling and running the GWT application in an embedded Jetty container

Accessing the mobile version of the GWT application

Round-tripping support for GWT applications

Enabling remote logging

See also

Getting started with Flex application development

Getting ready

How to do it...

How it works...

There's more...

Flexmojos Maven plugin configuration

See also

Scaffolding a Flex application from JPA entities

Getting ready

How to do it...

How it works...

There's more...

See also

Getting started with Spring Web Flow

Getting ready

How to do it...

How it works...

Spring Web Flow configuration

Developing applications using both Spring Web MVC and Spring Web Flow

There's more...

See also

6. Emailing, Messaging, Spring Security, Solr, and GAE

Introduction

Sending e-mails using JavaMail API

Getting ready

How to do it...

How it works...

Setting up e-mail sending support

Setting up a mail message

Sending mails

There's more...

Sending e-mails asynchronously

Sending e-mails with attachments

Sending e-mails with JavaMail Session configured in JNDI

See also

Sending and receiving JMS messages

Getting ready

How to do it...

How it works...

Setting up a JMS provider

Sending message using JMS Template

Creating a JMS message consumer

There's more...

Sending JMS messages asynchronously

See also

Configuring Spring Security for your application

Getting ready

How to do it...

How it works...

Spring Security application context XML file

AuthenticationManager configuration

Web request security configuration

Using Spring Security with Apache Directory Server

Flight Booking application requirements

Getting ready

How to do it...

How it works...

Setting up embedded Apache Directory Server

Authenticating against the LDAP server

Configuring web request security

Configuring method-level security

Adding @Secured annotation to JPA entity methods

Deploying a GWT application on GAE

Getting ready

How to do it...

How it works...

appengine-web.xml

Maven GAE plugin

Maven DataNucleus plugin

Persistent entities

Authentication and authorization in GAE applications

Deploying a Spring Web MVC application on GAE

Getting ready

How to do it...

How it works...

Owned relationship

Managing persisted data using Admin Console

There's more...

See also

Adding search capability to your domain model with Sol

Getting ready

How to do it...

How it works...

Configuring Solr for Roo project

Adding domain model data to Solr index and searching Solr documents

Methods and attributes introduced by *_Roo_SolrSearch.aj AspectJ ITD

Searching Solr documents

There's more...

Customizing Roo-generated *_Roo_SolrSearch.aj AspectJ ITD

7. Developing Add-ons and Removing Roo from Projects

Introduction

Setting up GnuPG for add-on development

Getting ready

How to do it...

How it works...

See also

Installing an installable add-on

Getting ready

How to do it...

How it works...

There's more...

Trusting add-ons by default

Installing add-ons not indexed by RooBot

See also

Developing a simple add-on

Getting ready

How to do it...

How it works...

MysimpleCommands class

Defining Roo commands

Making Roo commands unavailable

The MysimpleOperations interface and MysimpleOperationsImpl class

MysimpleNameProperty enum type

There's more...

Deploying and running mysimple add-on

Using the mysimple add-on in a Roo project

Tab-completion feature with constant values

Multiple command availability using @CliAvailabilityIndicator

Templates in Roo add-ons

The pom.xml file

OSGi commands for troubleshooting

See also

Developing an advanced add-on

Getting ready

How to do it...

How it works...

The MyadvancedCommands class

The MyadvancedOperationsImpl class

The MyadvancedMetadataProvider class

Dependency registration and unregistration

Registering and unregistering metadata creation trigger

Code generation functionality of add-ons

There's more...

See also

Converting non-OSGi JDBC drivers into OSGi-compliant bundles

Getting ready

How to do it...

How it works...

See also

Removing Roo with push-in refactoring

Getting ready

How to do it...

How it works...

There's more...

Push-in refactoring—single AspectJ ITD file

Push-in refactoring – across the whole project

See also

Adding Roo to a project using pull-out refactoring

Getting ready

How to do it...

There's more...

See also

Upgrading to the latest version of Roo

Getting ready

How to do it...

How it works...

There's more...

Index

Spring Roo 1.1 Cookbook

Spring Roo 1.1 Cookbook

Copyright © 2011 Packt Publishing

All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.

Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book.

Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information.

First published: September 2011

Production Reference: 1190911

Published by Packt Publishing Ltd.

Livery Place

35 Livery Street

Birmingham B3 2PB, UK

ISBN 978-1-84951-458-3

www.packtpub.com

Cover Image by Sergey Suchok (<sevlad.main@gmail.com>)

Credits

Author

Ashish Sarin

Reviewers

Tobias Lütticke

John Joseph Ryan III

Acquisition Editor

Usha Iyer

Development Editors

Neha Mallik

Reshma Sundaresan

Technical Editors

Vanjeet D'souza

Mehreen Shaikh

Project Coordinator

Joel Goveya

Proofreaders

Aaron Nash

Lisa Brady

Linda Morris

Indexer

Hemangini Bari

Production Coordinators

Nilesh R. Mohite

Alwin Roy

Cover Work

Nilesh R. Mohite

About the Author

Ashish Sarin has more than 11 years of experience architecting and developing applications using Java EE technologies. He is a Sun Certified Enterprise Architect for Java EE Platform. He has authored many articles on portlets and rich Internet applications using Liferay, DWR, JSF, and Spring Portlet MVC.

Ashish is also the author of Portlets in Action (http://manning.com/sarin/) by Manning Publications.

Writing Spring Roo 1.1 Cookbook has been a very satisfying experience because of the multitude of technologies it covers.

I would like to thank Tobias Lütticke for providing excellent feedback during the review of the book. It helped a great deal with improving the technical content and presentation of the book.

This book owes a great deal to John J. Ryan III for doing an outstanding job of ensuring that each and every recipe is well tested and well presented to readers. As the book's content moved from Spring Roo 1.1.1 to 1.1.3, John made sure that we don't miss out on any relevant recipes and technical details. It has given me a lot of confidence that recipes covered in this book will work as described.

Special thanks to Vanjeet D'souza and Mehreen Shaikh for doing an excellent job of ensuring that the book meets Packt's standards.

Thanks to Neha Mallik for doing an outstanding job at improving the structure and presentation of the book. Thanks to Usha Iyer as well for giving me the opportunity to write for Packt.

About the Reviewers

Tobias Lütticke has more than 11 years of experience in the software field. As a consultant and software architect, he has shaped various mission-critical applications for German blue chip companies and his current employer. His background also includes project management and teaching of software development best practices. Early in his career Tobias developed a passion for Open Source and agile development methodologies that still drives his work. He is fortunate to have been involved in the successful delivery of two major Roo-based projects; one of them is a public-facing geographic information system almost entirely built with Open Source components.

Tobias is a certified Scrum Master, Project Management Professional (PMP), and he holds a Computer Science degree from Karlsruhe Institute of Technology, Excellence University, Germany.

Currently, he works as a Senior Application Solution Architect for a New Zealand government entity, where he architects enterprise applications and leads development teams to see his solutions through to fruition.

Tobias enjoys writing and shares his experience in the software development space through articles he publishes in various magazines as well as through his book on OpenSSH.

John J. Ryan III is the founder and Director of Systems Engineering for Princigration ™ LLC. He specializes in portal web development and system integration of Java based technologies. He has extensive experience in data-centric systems across a wide array of technology stacks and implementation languages. John has a BS in Computer Science and Engineering from the University of Texas at Arlington and an MS in Systems Engineering from Southern Methodist University.