Kauri Documentation

1 Documentation Home
- 1.1 Kauri 0.4 Documentation
2 Getting started
- 2.1 Welcome
- 2.2 Installing Kauri
- 2.3 Running samples
- 2.4 Developer environment setup
- 2.5 Creating a Kauri project
- 2.6 Essential Kauri theory
- 2.7 Structure of a Kauri project
- 2.8 Source mode
  - 2.8.1 Try it
- 2.9 Static resources
- 2.10 Dynamic resources
  - 2.10.1 Examples
  - 2.10.2 About JAX-RS in Kauri
    - 2.10.2.1 Decentralized URI management, routing
    - 2.10.2.2 About the objects returned from resource methods
3 Step by step: Kauri prototyping and application building
- 3.1 How to use this tutorial
  - 3.1.1 Do as you go
  - 3.1.2 Only read
- 3.2 Generate the project structure.
  - 3.2.1 Creation of a template application
- 3.3 Wire-framing with templates
  - 3.3.1 Drawing a first wire-frame
- 3.4 Adding security to an application
- 3.5 Add caching
4 Kauri concepts
- 4.1 Adhering to Web architecture
- 4.2 Routing and resource classes
- 4.3 The Kauri Runtime: modules
- 4.4 Templates
- 4.5 Forms
- 4.6 Holistic approach
- 4.7 Technology choices
- 4.8 Developer convenience
  - 4.8.1 Quick test cycle
  - 4.8.2 Project templates
- 4.9 Open Source
- 4.10 Other
5 Prototyping
- 5.1 Prototyping: step-by-step
- 5.2 Prototyping: how it works
6 Routing
- 6.1 What is routing?
- 6.2 The full picture: how a request is routed
- 6.3 Routing first steps
  - 6.3.1 Outline
  - 6.3.2 The steps to introduce routing
- 6.4 JAX-RS first steps
  - 6.4.1 About JAX-RS
  - 6.4.2 Trying it out
  - 6.4.3 More on JAX-RS
  - 6.4.4 Relationship between JAX-RS and Kauri routing
- 6.5 Some background
  - 6.5.1 Routing structure
  - 6.5.2 Groovy as routing configuration syntax
- 6.6 Default routing
- 6.7 Routing examples
- 6.8 Spring integration
- 6.9 URI template syntax
- 6.10 Routing reference
  - 6.10.1 Basic syntax rules
  - 6.10.2 Setting generic properties on routing components
  - 6.10.3 Variables available in the script
  - 6.10.4 Advanced things
- 6.11 Common parameters
- 6.12 directory
- 6.13 filter
- 6.14 guard
- 6.15 jaxRs
- 6.16 mode
- 6.17 pages
- 6.18 read
- 6.19 redirector
- 6.20 resource
- 6.21 restlet
- 6.22 router
- 6.23 template
- 6.24 Routing module
  - 6.24.1 Introduction
  - 6.24.2 Routing configuration options
  - 6.24.3 Step by step: supplying a template engine to the routing
  - 6.24.4 Multiple routers in one module
  - 6.24.5 Extending the routing DSL
7 Representation builder
- 7.1 What is a representation
- 7.2 The need for a representation builder module
  - 7.2.1 Moving the mechanics of representation production out of resource classes
  - 7.2.2 Creating representations in case of errors and exceptions
- 7.3 First steps
  - 7.3.1 Adding the module
    - 7.3.1.1 Add the representation builder module to wiring.xml
    - 7.3.1.2 Import representation builder in your module and install it
  - 7.3.2 Making use of the representation builder
    - 7.3.2.1 Creating a KauriRepresentation instance
    - 7.3.2.2 Configure logical name to actual representation mapping
- 7.4 Some background
- 7.5 Default configuration
- 7.6 Configuration reference
8 Templates
- 8.1 Introduction
- 8.2 Template features
- 8.3 Usage
- 8.4 Syntax reference
9 Database resources
- 9.1 Introduction
- 9.2 Interface
- 9.3 JPA database resources
- 9.4 Mock database resources
10 Forms
- 10.1 Concepts
- 10.2 Standard Usage
  - 10.2.1 Defining the form configuration
  - 10.2.2 Creating the form
    - 10.2.2.1 Creating the Kauri form by giving the id to the Form constructor
    - 10.2.2.2 Creating the Kauri form with jQuery
- 10.3 Hacker-Guide
- 10.4 Building Custom Controls
- 10.5 Forms Reference
  - 10.5.1 Form configuration object
11 Internationalization (i18n)
- 11.1 i18n first steps
- 11.2 Locale settings
  - 11.2.1 Setting and retrieving active locale settings
  - 11.2.2 Reusable snippet
- 11.3 Resource bundles
- 11.4 Templates integration
- 11.5 Server API
- 11.6 Client API
  - 11.6.1 i18n REST-service
    - 11.6.1.1 Getting a bundle
    - 11.6.1.2 Getting lists of locales and timezones
12 Security
- 12.1 Introduction
- 12.2 More security
- 12.3 Security: first steps
- 12.4 Security configuration
- 12.5 Authentication methods
- 12.6 Security context
- 12.7 Technical overview
13 Runtime
- 13.1 wiring.xml reference
  - 13.1.1 Index
  - 13.1.2 Element description
- 13.2 connectors.xml reference
  - 13.2.1 Index
  - 13.2.2 Element description
- 13.3 classloading.xml reference
- 13.4 Spring config reference
  - 13.4.1 Introduction
    - 13.4.1.1 Purpose
    - 13.4.1.2 Namespace
  - 13.4.2 Element description
14 Configuration
- 14.1 Introduction
- 14.2 Configuration: first steps
- 14.3 Defining configuration
- 14.4 Accessing config from Java and Spring
- 14.5 Accessing config from templates
- 14.6 Accessing config from router.groovy
- 14.7 Configuration of the configuration system
15 Temporary Resources
- 15.1 Usage
- 15.2 API and Services
16 Error handling
- 16.1 Different ways of handling error situations
- 16.2 Throwing an exception versus setting response status
17 Caching of static resources
- 17.1 Introduction
- 17.2 Best practices
- 17.3 Add Caching to kauri module
  - 17.3.1 Add caching headers via router.groovy
  - 17.3.2 Enable usage of semi-static resources
18 Packaging Kauri applications
- 18.1 Packaged Kauri application
- 18.2 Packaging as a servlet webapp
19 Service wrapper
- 19.1 Introduction
- 19.2 Usage
20 TODO - WRITE UP AND ORGANIZE
- 20.1 Kauri Project/Application Structure
21 Kauri hackers
- 21.1 Kauri source code
- 21.2 Coding style
  - 21.2.1 js guide
- 21.3 Subversion configuration
  - 21.3.1 Subversion configuration
- 21.4 Building restlet-snapshot
- 21.5 Running modules from source in your IDE
  - 21.5.1 Running From Source-Directory
  - 21.5.2 JUnit "Module" Tests
- 21.6 Maven Dependency plugin
- 21.7 Release Building
- 21.8 Javascript Maven Plugin
22 Glossary of Terms
- 22.1 Terms in use
23 Upgrading from 0.3

Kauri Documentation
	Home	Next
	Book Index	1 Documentation Home

	Home	Next
		1 Documentation Home

Kauri Documentation

Table of Contents