(Quick Reference)

The Grails Framework - Reference Documentation

Authors: Graeme Rocher, Peter Ledbrook, Marc Palmer, Jeff Brown, Luke Daley, Burt Beckwith

Version: 1.3.9

Table of Contents

2Getting Started

2.1Downloading and Installing

2.2Upgrading from previous versions of Grails

2.3Creating an Application

2.4A Hello World Example

2.5Getting Set-up in an IDE

2.6Convention over Configuration

2.7Running an Application

2.8Testing an Application

2.9Deploying an Application

2.10Supported Java EE Containers

2.11Generating an Application

2.12Creating Artefacts

3.1Basic Configuration

3.1.1Built in options

3.1.2Logging

3.2Environments

3.3The DataSource

3.3.1DataSources and Environments

3.3.2JNDI DataSources

3.3.3Automatic Database Migration

3.3.4Transaction-aware DataSource Proxy

3.4Externalized Configuration

3.5Versioning

3.6Project Documentation

3.7Dependency Resolution

3.7.1Configurations and Dependencies

3.7.2Dependency Repositories

3.7.3Debugging Resolution

3.7.4Inherited Dependencies

3.7.5Providing Default Dependencies

3.7.6Dependency Reports

3.7.7Plugin JAR Dependencies

3.7.8Maven Integration

3.7.9Deploying to a Maven Repository

3.7.10Plugin Dependencies

4The Command Line

4.1Creating Gant Scripts

4.2Re-using Grails scripts

4.3Hooking into Events

4.4Customising the build

4.5Ant and Maven

5Object Relational Mapping (GORM)

5.1Quick Start Guide

5.1.1Basic CRUD

5.2Domain Modelling in GORM

5.2.1Association in GORM

5.2.1.1Many-to-one and one-to-one

5.2.1.2One-to-many

5.2.1.3Many-to-many

5.2.1.4Basic Collection Types

5.2.2Composition in GORM

5.2.3Inheritance in GORM

5.2.4Sets, Lists and Maps

5.3Persistence Basics

5.3.1Saving and Updating

5.3.2Deleting Objects

5.3.3Understanding Cascading Updates and Deletes

5.3.4Eager and Lazy Fetching

5.3.5Pessimistic and Optimistic Locking

5.3.6Modification Checking

5.4Querying with GORM

5.4.1Dynamic Finders

5.4.2Criteria

5.4.3Hibernate Query Language (HQL)

5.5Advanced GORM Features

5.5.1Events and Auto Timestamping

5.5.2Custom ORM Mapping

5.5.2.1Table and Column Names

5.5.2.2Caching Strategy

5.5.2.3Inheritance Strategies

5.5.2.4Custom Database Identity

5.5.2.5Composite Primary Keys

5.5.2.6Database Indices

5.5.2.7Optimistic Locking and Versioning

5.5.2.8Eager and Lazy Fetching

5.5.2.9Custom Cascade Behaviour

5.5.2.10Custom Hibernate Types

5.5.2.11Derived Properties

5.5.2.12Custom Naming Strategy

5.5.3Default Sort Order

5.6Programmatic Transactions

5.7GORM and Constraints

6.1Controllers

6.1.1Understanding Controllers and Actions

6.1.2Controllers and Scopes

6.1.3Models and Views

6.1.4Redirects and Chaining

6.1.5Controller Interceptors

6.1.6Data Binding

6.1.7XML and JSON Responses

6.1.8More on JSONBuilder

6.1.9Uploading Files

6.1.10Command Objects

6.1.11Handling Duplicate Form Submissions

6.1.12Simple Type Converters

6.2Groovy Server Pages

6.2.1GSP Basics

6.2.1.1Variables and Scopes

6.2.1.2Logic and Iteration

6.2.1.3Page Directives

6.2.1.4Expressions

6.2.2GSP Tags

6.2.2.1Variables and Scopes

6.2.2.2Logic and Iteration

6.2.2.3Search and Filtering

6.2.2.4Links and Resources

6.2.2.5Forms and Fields

6.2.2.6Tags as Method Calls

6.2.3Views and Templates

6.2.4Layouts with Sitemesh

6.2.5Sitemesh Content Blocks

6.2.6Making Changes to a Deployed Application

6.2.7GSP Debugging

6.3Tag Libraries

6.3.1Variables and Scopes

6.3.2Simple Tags

6.3.3Logical Tags

6.3.4Iterative Tags

6.3.5Tag Namespaces

6.3.6Using JSP Tag Libraries

6.3.7Tag return value

6.4URL Mappings

6.4.1Mapping to Controllers and Actions

6.4.2Embedded Variables

6.4.3Mapping to Views

6.4.4Mapping to Response Codes

6.4.5Mapping to HTTP methods

6.4.6Mapping Wildcards

6.4.7Automatic Link Re-Writing

6.4.8Applying Constraints

6.4.9Named URL Mappings

6.5Web Flow

6.5.1Start and End States

6.5.2Action States and View States

6.5.3Flow Execution Events

6.5.4Flow Scopes

6.5.5Data Binding and Validation

6.5.6Subflows and Conversations

6.6.1Applying Filters

6.6.2Filter Types

6.6.3Variables and Scopes

6.6.4Filter Dependencies

6.7.1Ajax using Prototype

6.7.1.1Remoting Linking

6.7.1.2Updating Content

6.7.1.3Remote Form Submission

6.7.1.4Ajax Events

6.7.2Ajax with Dojo

6.7.3Ajax with GWT

6.7.4Ajax on the Server

6.8Content Negotiation

7.1Declaring Constraints

7.2Validating Constraints

7.3Validation on the Client

7.4Validation and Internationalization

7.5Validation Non Domain and Command Object Classes

8The Service Layer

8.1Declarative Transactions

8.1.1Transactions Rollback and the Session

8.2Scoped Services

8.3Dependency Injection and Services

8.4Using Services from Java

9.1Unit Testing

9.2Integration Testing

9.3Functional Testing

10Internationalization

10.1Understanding Message Bundles

10.2Changing Locales

10.3Reading Messages

10.4Scaffolding and i18n

11.1Securing Against Attacks

11.2Encoding and Decoding Objects

11.3Authentication

11.4Security Plug-ins

11.4.1Spring Security

11.4.2Shiro

12.1Creating and Installing Plug-ins

12.2Plugin Repositories

12.3Understanding a Plug-ins Structure

12.4Providing Basic Artefacts

12.5Evaluating Conventions

12.6Hooking into Build Events

12.7Hooking into Runtime Configuration

12.8Adding Dynamic Methods at Runtime

12.9Participating in Auto Reload Events

12.10Understanding Plug-in Load Order

13.3RSS and Atom

14Grails and Spring

14.1The Underpinnings of Grails

14.2Configuring Additional Beans

14.3Runtime Spring with the Beans DSL

14.4The BeanBuilder DSL Explained

14.5Property Placeholder Configuration

14.6Property Override Configuration

15Grails and Hibernate

15.1Using Hibernate XML Mapping Files

15.2Mapping with Hibernate Annotations

15.3Adding Constraints

15.4Further Reading

Quick Reference (hide)