Browse Library
Sign In Start Free Trial
Close icon Search icon
Account
Browse Library Advanced Search Sign In Start Free Trial

Add to playlist

Create a Playlist

Modal Close icon
You need to login to use this feature.
  • Book Overview & Buying Learning Alfresco Web Scripts
  • Table Of Contents Toc
  • Feedback & Rating feedback
Learning Alfresco Web Scripts

Learning Alfresco Web Scripts

By : Ramesh Chauhan
4.5 (4)
Buy this Book
close
close
Learning Alfresco Web Scripts

Learning Alfresco Web Scripts

4.5 (4)
By: Ramesh Chauhan
Buy this Book

Overview of this book

If you are an Alfresco developer who has no experience with web scripts and you want to start developing Alfresco web scripts, then this book is definitely for you.
Table of Contents (12 chapters)
close
close
close
Preface
Icon
Preface
Icon
What this book covers
Icon
What you need for this book
Icon
Who this book is for
Icon
Conventions
Icon
Reader feedback
Icon
Customer support
Free Chapter
1
1. Getting Familiar with Web Scripts
chevron up
Icon
1. Getting Familiar with Web Scripts
Icon
Understanding web scripts
Icon
Reasons to use web scripts
Icon
Understanding when to use a web script
Icon
Understanding where web scripts can be used
Icon
Understanding how web scripts work
Icon
Types of web scripts
Icon
Summary
2
2. It's Time for the First Web Script
Icon
2. It's Time for the First Web Script
Icon
Creating your first web script in Alfresco
Icon
Understanding the web script URI
Icon
Adding arguments to a web script
Icon
Extending the first web script to use the controller
Icon
Behind the scenes of web script execution
Icon
Important things for any web script
Icon
Summary
3
3. Understanding the Web Script Framework
Icon
3. Understanding the Web Script Framework
Icon
Execution flow of web scripts
Icon
Components of the web script framework
Icon
Deployment architecture
Icon
Summary
4
4. Building Blocks of Web Scripts
Icon
4. Building Blocks of Web Scripts
Icon
The description document – it's a must!
Icon
Controller implementation – not mandatory!
Icon
Response templates – yes, they are required!
Icon
I18N for a web script – it's optional
Icon
Configuration document – it's optional
Icon
Naming conventions – the most important thing
Icon
Summary
5
5. Invoking Web Scripts
Icon
5. Invoking Web Scripts
Icon
Invoking a web script from a web browser
Icon
Executing a web script using web browser plugins
Icon
Executing a web script from standalone Java program
Icon
Calling web scripts from Spring-based services
Icon
Invoking a web script from Alfresco Share
Icon
Calling a web script from JSR-168 portals and the JSF page
Icon
Dealing with client limitations
Icon
Summary
6
6. Creating Java-backed Web Scripts
Icon
6. Creating Java-backed Web Scripts
Icon
Use case scenario
Icon
Web script functionality at a high level
Icon
Getting ready
Icon
Creating a description document
Icon
Creating a response template
Icon
Creating a Java controller
Icon
Configuring the controller for the web script
Icon
Deploying the web script
Icon
Testing the web script
Icon
DeclarativeWebScript versus AbstractWebScript
Icon
Using controllers smartly
Icon
Summary
7
7. Understanding JavaScript-based Web Scripts in Detail
Icon
7. Understanding JavaScript-based Web Scripts in Detail
Icon
Understanding what you can do with the JavaScript API
Icon
JavaScript APIs in Alfresco
Icon
A must-know ScriptNode API
Icon
Code examples
Icon
Creating your own root object
Icon
Summary
8
8. Deployment, Debugging, and Troubleshooting Web Scripts
Icon
8. Deployment, Debugging, and Troubleshooting Web Scripts
Icon
Deployment options
Icon
Debugging web scripts
Icon
Troubleshooting pointers
Icon
Web scripts on a production server
Icon
Summary
9
9. Mavenizing Web Scripts
Icon
9. Mavenizing Web Scripts
Icon
Setting up your environment
Icon
Creating the default project structure for AMP
Icon
Generating AMP from the default project
Icon
Setting up a development environment with Eclipse
Icon
Understanding the default project structure
Icon
Extending your default project to create web scripts
Icon
Applying AMP to the Alfresco WAR for testing
Icon
Summary
10
10. Extending the Web Script Framework
Icon
10. Extending the Web Script Framework
Icon
Custom implementation of the web script runtime
Icon
The custom implementation of a web script container
Icon
Custom authenticator implementation
Icon
Custom script processor implementation
Icon
Custom template processor implementation
Icon
Customizing formats
Icon
Summary
11
Index
Icon
Index

Understanding how web scripts work

Web scripts in Alfresco mostly use the model-view-controller pattern. However, it isn't mandatory to follow this pattern all the time. The way MVC pattern works in web scripts is as follows:

  • The controller is responsible for performing the required business logic as per the business requirement. After processing the business logic, controller populates the model object with the required data. Once this is done, controller will then forward the request to the view.

MVC in web scripts

The model-view-controller pattern in web scripts is explained as follows:

  • The controller is a server-side JavaScript or Java class or it could be both as well
  • The model is a data structure object passed between the controller and view
  • The view is a FreeMarker template that is responsible for generating the response in the required format

The mapping of the web script URI to the controller is done through a descriptor file. It is mainly an XML file that will have the required details for a web script such as URL, description, arguments, transaction, authentication, and response formats.

Response formats are mapped to FreeMarker templates through naming conventions. For example, a FreeMarker template that returns an HTML response will have the extension html.ftl.

Web scripts are registered and executed by the web script engine in Alfresco.

Note

A descriptor, optional controller, and one or more FreeMarker response templates collectively make a web script in general scenarios.

All these components are tied together through a specific document naming convention.

Making web scripts work

To make web scripts work, it is important to deploy the web script files at an appropriate location.

The descriptor file and the FreeMarker template as per the response format for a web script can be either placed on a filesystem or put into the Alfresco repository.

If a JavaScript-based controller is used for a web script, then it could be placed along with the descriptor and FreeMarker template on a filesystem or in the Alfresco repository.

If a Java-based controller is used for a web script, then the class file for the controller must be available on the class path.

Note

There are two types of controllers available for web scripts: JavaScript-based controllers and Java-based controllers. It is possible to have none of them, either of them, or even both of them for a web script.

End of Section 6
Next Section

Create a Note

Modal Close icon
You need to login to use this feature.
notes
bookmark search playlist font-size

Change the font size

margin-width

Change margin width

day-mode

Change background colour

Close icon Search
Country selected
Close icon Your notes and bookmarks

Delete Bookmark

Modal Close icon
Are you sure you want to delete it?
Cancel
Yes, Delete

Delete Note

Modal Close icon
Are you sure you want to delete it?
Cancel
Yes, Delete

Edit Note

Modal Close icon
Write a note (max 255 characters)
Cancel
Update Note

Confirmation

Modal Close icon
claim successful
Order Page Read Now

Buy this book with your credits?

Modal Close icon
Are you sure you want to buy this book with one of your credits?
Close
YES, BUY