Spring Surf Developer Tools - Reference Documentation

Yong Qu

Michael Uzquiano


Copyright (C) 2005-2009 Alfresco Software Limited.

Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.

I. Welcome to Spring Surf Developer Tools
1. Introduction
1.1. What are Spring Surf Developer Tools?
1.2. Installation
1.3. First Steps: Your Own Spring Surf App in Under 5 Minutes
1.4. Exploring the Surf Roo Samples
1.5. Suggested Steps to Surf Productivity
2. Beginning With Spring Surf Developer Tools: The Tutorial
2.1. What You'll Learn
2.2. Tutorial Application Use Cases
2.3. Starting a Surf Project using Spring Roo
2.3.1. Step 1: Creating a Spring project
2.3.2. Step 2: Installing Surf artifacts and Surf Quick Start Sample Site
2.3.3. Step 3: Testing the Surf Quick Start Sample Site
2.3.4. Step 3: Modifying Header and Footer Component
2.3.5. Step 3: Creating a new template
2.3.6. Step 3: Creating a new page
2.3.7. Step 4: Creating a new component
2.3.8. Step 5: Adding components to a page
2.3.9. Step 6: Generating report on a page
2.3.10. Step 7: Associating pages
2.3.11. Step 8: Packaging the site
2.3.12. Step 8: Installing additional Surf addons
2.4. Building a Surf Project using Spring Tool Suite
2.4.1. Step 1: Setting up a basic Dynamic Web Project.
2.4.2. Step 2: Enabling the Dynamic Web Project with Spring Roo Nature.
2.4.3. Step 3: Creating a basic Spring project using Spring Roo
2.4.4. Step 4: Installing Surf artifacts.
2.4.5. Step 5: Enabling Maven Dependency Management
2.4.6. Step 6: Deploying and testing Surf project.
2.4.7. Step 1: Verifying Surf Project Template has been installed
2.4.8. Step 2: Creating a new Surf Project
2.4.9. Step 5: Enabling Maven Dependency Management
2.4.10. Step 6: Deploying and testing Surf project.
2.5. Summary
3. Application Architecture
3.1. Architectural Overview
3.2. Critical Technologies
4. Usage and Conventions
4.1. Usability Philosophy
4.2. IDE Usage
4.3. Build System Usage
4.4. File System Conventions
4.5. Recommended Practices
4.6. Diagnosing Surf Problems
4.7. Known Issues
5. Existing Building Blocks
6. Removing Spring Surf
7. Development Processes
7.1. Setting Up for Development
7.2. Building the Surf Platform Using Maven
7.3. Developing within Eclipse
7.4. Integrated Tomcat Testing
7.5. Subversion Policies
7.6. Site Deployment
7.7. Releasing
7.8. Help
7.9. How You Can Help
II. Appendices
A. Command Index
A.1. Component Commands
A.1.1. surf component create
A.1.2. surf component list
A.1.3. surf component property create
A.1.4. surf component resource create
A.1.5. surf webscript list
A.2. Content Commands
A.2.1. surf content association create
A.3. Page Commands
A.3.1. surf page association create
A.3.2. surf page association list
A.3.3. surf page create
A.3.4. surf page list
A.4. Report Commands
A.4.1. surf report page
A.5. Site Commands
A.5.1. surf site create
A.6. Surf Commands
A.6.1. surf addon install
A.6.2. surf addon list
A.6.3. surf install
A.7. Template Commands
A.7.1. surf template create
A.7.2. surf template instance create
A.7.3. surf template instance list
A.7.4. surf template list
A.7.5. surf template region list
B. RESTful API Reference
B.1. Package Webscript Global
B.1.1. Resource Webscript Message
B.1.1.1. Web Script Global messages bundle
B.1.2. Resource Others
B.1.2.1. Web Script Global messages bundle
B.2. Package Spring Surf Core
B.2.1. Resource Web Framework
B.2.1.1. Web Script Web Framework Console
B.2.1.2. Web Script Web Framework Maintenance
B.2.2. Resource Surf Object
B.2.2.1. Web Script Surf API - Delete an object
B.2.2.2. Web Script Surf API - Get an object
B.2.2.3. Web Script Surf API - Create an object
B.2.2.4. Web Script Surf API - Update an object
B.2.2.5. Web Script Surf API - Retrieve list of objects
B.3. Package Spring Surf Client
B.3.1. Resource Client
B.3.1.1. Web Script Surf - Client JS API
B.4. Package Spring Surf Format
B.4.1. Resource Format
B.4.1.1. Web Script Surf API - list of configured formats
B.5. Package Spring Surf Model Content
B.5.1. Resource Content Association
B.5.1.1. Web Script Surf API - removes a content association
B.5.1.2. Web Script Surf API - Adds a content association
B.5.2. Resource Others
B.5.2.1. Web Script Surf API - Retrieves Content Associations
B.6. Package Spring Surf Model Page
B.6.1. Resource Page Template
B.6.1.1. Web Script Surf API - Removes a page's template association
B.6.1.2. Web Script Surf API - Adds a page to template association
B.6.1.3. Web Script Surf API - Retrieves Page Templates
B.7. Package Spring Surf Model Site
B.7.1. Resource Site Configuration
B.7.1.1. Web Script Surf API - Retrieves Site Configuration
B.7.1.2. Web Script Surf API - Updates Site Configuration
B.8. Package Webscript Core
B.8.1. Resource Index
B.8.1.1. Web Script Web Scripts Home
B.8.1.2. Web Script Web Script Maintenance
B.8.1.3. Web Script All Web Scripts Index
B.8.1.4. Web Script Failed Web Scripts Index
B.8.1.5. Web Script Web Script Family Index
B.8.1.6. Web Script Web Script Lifecycle Index
B.8.1.7. Web Script Web Script Package Index
B.8.1.8. Web Script Web Script URI Index
B.8.2. Resource Javascript Debugger
B.8.2.1. Web Script Javascript Debugger
B.8.2.2. Web Script Javascript Debugger Maintenance
B.8.3. Resource Tools
B.8.3.1. Web Script Web Script Description
B.8.3.2. Web Script Display Web Script
B.8.3.3. Web Script Web Script Installer Form
B.8.3.4. Web Script Install Web Script
B.8.4. Resource Others
B.8.4.1. Web Script Web Script Package Documentation
C. JavaScript Root Object Reference
C.1. atom
C.2. jsonUtils
C.3. logger
C.4. remote
C.5. server
C.6. stringUtils
D. JavaScript API Reference
D.1. org.springframework.extensions.webscripts.ScriptLogger
D.2. org.springframework.extensions.webscripts.ScriptRemote
D.3. org.springframework.extensions.webscripts.ScriptRemoteConnector
D.4. org.springframework.extensions.webscripts.ScriptRenderContext
D.5. org.springframework.extensions.webscripts.ScriptSurf
D.6. org.springframework.extensions.webscripts.ScriptableUtils
D.7. org.springframework.extensions.webscripts.atom.AtomService
D.8. org.springframework.extensions.webscripts.json.JSONUtils
E. Template Root Object Reference
E.1. argreplace
E.2. atom
E.3. date
E.4. dateCompare
E.5. encodeuri
E.6. jsonUtils
E.7. server
E.8. stringUtils
E.9. xmldate
F. Template API Reference
F.1. org.springframework.extensions.webscripts.AbsoluteUrlMethod
F.2. org.springframework.extensions.webscripts.ArgReplaceMethod
F.3. org.springframework.extensions.webscripts.ClientUrlFunctionMethod
F.4. org.springframework.extensions.webscripts.DateCompareMethod
F.5. org.springframework.extensions.webscripts.FormatWriterMethod
F.6. org.springframework.extensions.webscripts.FreemarkerI18NMessageMethod
F.7. org.springframework.extensions.webscripts.ISO8601DateFormatMethod
F.8. org.springframework.extensions.webscripts.MessageMethod
F.9. org.springframework.extensions.webscripts.ScriptRenderContext
F.10. org.springframework.extensions.webscripts.ScriptSurf
F.11. org.springframework.extensions.webscripts.ScriptUrlMethod
F.12. org.springframework.extensions.webscripts.ScriptableUtils
F.13. org.springframework.extensions.webscripts.UrlEncodeMethod
F.14. org.springframework.extensions.webscripts.atom.AtomService
F.15. org.springframework.extensions.webscripts.json.JSONUtils
G. Upgrade Notes and Known Issues
G.1. Known Issues
H. Project Background
H.1. History
H.2. Mission Statement
I. Spring Surf Resources
I.1. Project Home Page
I.2. Downloads and Maven Repositories
I.3. Community Forums
I.4. Twitter
I.5. Source Repository
I.6. Source Web Browsing
I.7. Commercial Products and Services
I.8. Other