(Quick Reference)

The Grails Framework - Reference Documentation

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

Version: 2.1.5

Table of Contents

1.1What's new in Grails 2.1?

1.2What's new in Grails 2.0?

1.2.1Development Environment Features

1.2.2Core Features

1.2.3Web Features

1.2.4Persistence Features

1.2.5Testing Features

2Getting Started

2.1Installation Requirements

2.2Downloading and Installing

2.3Creating an Application

2.4A Hello World Example

2.5Using Interactive Mode

2.6Getting Set Up in an IDE

2.7Convention over Configuration

2.8Running an Application

2.9Testing an Application

2.10Deploying an Application

2.11Supported Java EE Containers

2.12Generating an Application

2.13Creating Artefacts

3Upgrading from previous versions of Grails

4.1Basic Configuration

4.1.1Built in options

4.1.2Logging

4.2Environments

4.3The DataSource

4.3.1DataSources and Environments

4.3.2JNDI DataSources

4.3.3Automatic Database Migration

4.3.4Transaction-aware DataSource Proxy

4.3.5Database Console

4.3.6Multiple Datasources

4.4Externalized Configuration

4.5Versioning

4.6Project Documentation

4.7Dependency Resolution

4.7.1Configurations and Dependencies

4.7.2Dependency Repositories

4.7.3Debugging Resolution

4.7.4Inherited Dependencies

4.7.5Providing Default Dependencies

4.7.6Snapshots and Other Changing Dependencies

4.7.7Dependency Reports

4.7.8Plugin JAR Dependencies

4.7.9Maven Integration

4.7.10Deploying to a Maven Repository

4.7.11Plugin Dependencies

4.7.12Caching of Dependency Resolution Results

5The Command Line

5.1Interactive Mode

5.2Creating Gant Scripts

5.3Re-using Grails scripts

5.4Hooking into Events

5.5Customising the build

5.6Ant and Maven

5.7Grails Wrapper

6Object Relational Mapping (GORM)

6.1Quick Start Guide

6.1.1Basic CRUD

6.2Domain Modelling in GORM

6.2.1Association in GORM

6.2.1.1Many-to-one and one-to-one

6.2.1.2One-to-many

6.2.1.3Many-to-many

6.2.1.4Basic Collection Types

6.2.2Composition in GORM

6.2.3Inheritance in GORM

6.2.4Sets, Lists and Maps

6.3Persistence Basics

6.3.1Saving and Updating

6.3.2Deleting Objects

6.3.3Understanding Cascading Updates and Deletes

6.3.4Eager and Lazy Fetching

6.3.5Pessimistic and Optimistic Locking

6.3.6Modification Checking

6.4Querying with GORM

6.4.1Dynamic Finders

6.4.2Where Queries

6.4.3Criteria

6.4.4Detached Criteria

6.4.5Hibernate Query Language (HQL)

6.5Advanced GORM Features

6.5.1Events and Auto Timestamping

6.5.2Custom ORM Mapping

6.5.2.1Table and Column Names

6.5.2.2Caching Strategy

6.5.2.3Inheritance Strategies

6.5.2.4Custom Database Identity

6.5.2.5Composite Primary Keys

6.5.2.6Database Indices

6.5.2.7Optimistic Locking and Versioning

6.5.2.8Eager and Lazy Fetching

6.5.2.9Custom Cascade Behaviour

6.5.2.10Custom Hibernate Types

6.5.2.11Derived Properties

6.5.2.12Custom Naming Strategy

6.5.3Default Sort Order

6.6Programmatic Transactions

6.7GORM and Constraints

7.1Controllers

7.1.1Understanding Controllers and Actions

7.1.2Controllers and Scopes

7.1.3Models and Views

7.1.4Redirects and Chaining

7.1.5Controller Interceptors

7.1.6Data Binding

7.1.7XML and JSON Responses

7.1.8More on JSONBuilder

7.1.9Uploading Files

7.1.10Command Objects

7.1.11Handling Duplicate Form Submissions

7.1.12Simple Type Converters

7.1.13Asynchronous Request Processing

7.2Groovy Server Pages

7.2.1GSP Basics

7.2.1.1Variables and Scopes

7.2.1.2Logic and Iteration

7.2.1.3Page Directives

7.2.1.4Expressions

7.2.2GSP Tags

7.2.2.1Variables and Scopes

7.2.2.2Logic and Iteration

7.2.2.3Search and Filtering

7.2.2.4Links and Resources

7.2.2.5Forms and Fields

7.2.2.6Tags as Method Calls

7.2.3Views and Templates

7.2.4Layouts with Sitemesh

7.2.5Static Resources

7.2.5.1Including resources using the resource tags

7.2.5.2Other resource tags

7.2.5.3Declaring resources

7.2.5.4Overriding plugin resources

7.2.5.5Optimizing your resources

7.2.5.6Debugging

7.2.5.7Preventing processing of resources

7.2.5.8Other Resources-aware plugins

7.2.6Sitemesh Content Blocks

7.2.7Making Changes to a Deployed Application

7.2.8GSP Debugging

7.3Tag Libraries

7.3.1Variables and Scopes

7.3.2Simple Tags

7.3.3Logical Tags

7.3.4Iterative Tags

7.3.5Tag Namespaces

7.3.6Using JSP Tag Libraries

7.3.7Tag return value

7.4URL Mappings

7.4.1Mapping to Controllers and Actions

7.4.2Embedded Variables

7.4.3Mapping to Views

7.4.4Mapping to Response Codes

7.4.5Mapping to HTTP methods

7.4.6Mapping Wildcards

7.4.7Automatic Link Re-Writing

7.4.8Applying Constraints

7.4.9Named URL Mappings

7.4.10Customizing URL Formats

7.5Web Flow

7.5.1Start and End States

7.5.2Action States and View States

7.5.3Flow Execution Events

7.5.4Flow Scopes

7.5.5Data Binding and Validation

7.5.6Subflows and Conversations

7.6.1Applying Filters

7.6.2Filter Types

7.6.3Variables and Scopes

7.6.4Filter Dependencies

7.7.1Ajax Support

7.7.1.1Remoting Linking

7.7.1.2Updating Content

7.7.1.3Remote Form Submission

7.7.1.4Ajax Events

7.7.2Ajax with Prototype

7.7.3Ajax with Dojo

7.7.4Ajax with GWT

7.7.5Ajax on the Server

7.8Content Negotiation

8.1Declaring Constraints

8.2Validating Constraints

8.3Sharing Constraints Between Classes

8.4Validation on the Client

8.5Validation and Internationalization

8.6Applying Validation to Other Classes

9The Service Layer

9.1Declarative Transactions

9.1.1Transactions Rollback and the Session

9.2Scoped Services

9.3Dependency Injection and Services

9.4Using Services from Java

10.1Unit Testing

10.1.1Unit Testing Controllers

10.1.2Unit Testing Tag Libraries

10.1.3Unit Testing Domains

10.1.4Unit Testing Filters

10.1.5Unit Testing URL Mappings

10.1.6Mocking Collaborators

10.1.7Mocking Codecs

10.2Integration Testing

10.3Functional Testing

11Internationalization

11.1Understanding Message Bundles

11.2Changing Locales

11.3Reading Messages

11.4Scaffolding and i18n

12.1Securing Against Attacks

12.2Encoding and Decoding Objects

12.3Authentication

12.4Security Plugins

12.4.1Spring Security

12.4.2Shiro

13.1Creating and Installing Plugins

13.2Plugin Repositories

13.3Understanding a Plugin's Structure

13.4Providing Basic Artefacts

13.5Evaluating Conventions

13.6Hooking into Build Events

13.7Hooking into Runtime Configuration

13.8Adding Dynamic Methods at Runtime

13.9Participating in Auto Reload Events

13.10Understanding Plugin Load Order

13.11The Artefact API

13.11.1Asking About Available Artefacts

13.11.2Adding Your Own Artefact Types

13.12Binary Plugins

14.3RSS and Atom

15Grails and Spring

15.1The Underpinnings of Grails

15.2Configuring Additional Beans

15.3Runtime Spring with the Beans DSL

15.4The BeanBuilder DSL Explained

15.5Property Placeholder Configuration

15.6Property Override Configuration

16Grails and Hibernate

16.1Using Hibernate XML Mapping Files

16.2Mapping with Hibernate Annotations

16.3Adding Constraints

19Contributing to Grails

19.1Report Issues in JIRA

19.2Build From Source and Run Tests

19.3Submit Patches to Grails Core

19.4Submit Patches to Grails Documentation

Quick Reference (hide)