Sign In Start Free Trial

Learning Alfresco Web Scripts

By : Ramesh Chauhan

4.5 (4)

Learning Alfresco Web Scripts

4.5 (4)

By: Ramesh Chauhan

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.

Preface

Preface

What this book covers

What you need for this book

Who this book is for

Conventions

Reader feedback

Customer support

Free Chapter

1. Getting Familiar with Web Scripts

1. Getting Familiar with Web Scripts

Understanding web scripts

Reasons to use web scripts

Understanding when to use a web script

Understanding where web scripts can be used

Understanding how web scripts work

Types of web scripts

Summary

2. It's Time for the First Web Script

2. It's Time for the First Web Script

Creating your first web script in Alfresco

Understanding the web script URI

Adding arguments to a web script

Extending the first web script to use the controller

Behind the scenes of web script execution

Important things for any web script

Summary

3. Understanding the Web Script Framework

3. Understanding the Web Script Framework

Execution flow of web scripts

Components of the web script framework

Deployment architecture

Summary

4. Building Blocks of Web Scripts

4. Building Blocks of Web Scripts

The description document – it's a must!

Controller implementation – not mandatory!

Response templates – yes, they are required!

I18N for a web script – it's optional

Configuration document – it's optional

Naming conventions – the most important thing

Summary

5. Invoking Web Scripts

5. Invoking Web Scripts

Invoking a web script from a web browser

Executing a web script using web browser plugins

Executing a web script from standalone Java program

Calling web scripts from Spring-based services

Invoking a web script from Alfresco Share

Calling a web script from JSR-168 portals and the JSF page

Dealing with client limitations

Summary

6. Creating Java-backed Web Scripts

6. Creating Java-backed Web Scripts

Use case scenario

Web script functionality at a high level

Getting ready

Creating a description document

Creating a response template

Creating a Java controller

Configuring the controller for the web script

Deploying the web script

Testing the web script

DeclarativeWebScript versus AbstractWebScript

Using controllers smartly

Summary

7. Understanding JavaScript-based Web Scripts in Detail

7. Understanding JavaScript-based Web Scripts in Detail

Understanding what you can do with the JavaScript API

JavaScript APIs in Alfresco

A must-know ScriptNode API

Code examples

Creating your own root object

Summary

8. Deployment, Debugging, and Troubleshooting Web Scripts

8. Deployment, Debugging, and Troubleshooting Web Scripts

Deployment options

Debugging web scripts

Troubleshooting pointers

Web scripts on a production server

Summary

9. Mavenizing Web Scripts

9. Mavenizing Web Scripts

Setting up your environment

Creating the default project structure for AMP

Generating AMP from the default project

Setting up a development environment with Eclipse

Understanding the default project structure

Extending your default project to create web scripts

Applying AMP to the Alfresco WAR for testing

Summary

10. Extending the Web Script Framework

10. Extending the Web Script Framework

Custom implementation of the web script runtime

The custom implementation of a web script container

Custom authenticator implementation

Custom script processor implementation

Custom template processor implementation

Customizing formats

Summary

Index

Index

Customer Reviews

4.5 (4)

5 star

50%

4 star

50%

3 star

0

2 star

0

1 star

0

Types of web scripts

There are two types of web script in Alfresco: Data web scripts and Presentation web scripts.

Data web script

Data web scripts provide an interface to the repository for the client applications to create, retrieve, update, and delete content/data in the repository. These web scripts typically send the response in formats such as XML and JSON, and client applications will have to parse it in order to use it further.

Data web scripts encapsulate access and modification of content/data residing in the repository. These web scripts are provided and exposed by the Alfresco repository server only.

Presentation web script

Presentation web scripts can be used to build user interfaces such as dashlets for Alfresco explorer, dashlets for Alfresco share, portlets for a JSR-168 portal, a UI component within Alfresco SURF, or a custom application.

These kinds of web scripts generally render HTML responses.

It is possible to host these web scripts on a separate presentation server or they can also be exposed by the Alfresco repository server.

Presentation web scripts generally make a call to Data web scripts in order to get the required data from the repository.

Note

Out-of-the-box web scripts available in an Alfresco installation can be found at ALFRESCO_HOME\tomcat\webapps\alfresco\WEB-INF\classes\alfresco\templates\webscripts\org\alfresco, where ALFRESCO_HOME is the base directory where Alfresco is installed.

If you are using Alfresco Community 5, you can find out-of-the-box web scripts under the alfresco package inside alfresco-remote-api-*.jar, which is available at ALFRESCO_HOME\tomcat\webapps\alfresco\WEB-INF\lib.

Search

Your notes and bookmarks