Book Image

Learning Alfresco Web Scripts

By : Ramesh Chauhan
Book Image

Learning Alfresco Web Scripts

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.

Related Content you might be interested in

Current Title:

Small book image
Learning Alfresco Web Scripts
Ramesh Chauhan
Nov, 2014 | 182 pages
No titles found
Table of Contents (12 chapters)
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
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
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
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
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
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
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
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
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
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
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
11
Index
Index

Deploying the web script

The web script components are now ready. In order to make them work together, these need to be deployed now. In your Alfresco installed directory, perform the following steps:

  1. Create a folder named example at the location tomcat\shared\classes\alfresco\extension\templates\webscripts.

  2. Put contentlocation.get.desc.xml, contentlocation.get.json.ftl, and contentlocation.get.xml.ftl at the location tomcat\shared\classes\alfresco\extension\templates\webscripts\example.

  3. Put custom-example-webscripts-context.xml at the location tomcat\shared\classes\alfresco\extension.

  4. Create folders com | example | content at the location tomcat\webapps\alfresco\WEB-INF\classes.

  5. Put the compiled Java class ContentLocationWebscript.class at the location tomcat\webapps\alfresco\WEB-INF\classes\com\example\content.

  6. Restart the server.

Registering the web script

As we just restarted the server, on a server startup, the web script gets registered. Now in order to confirm this, go to the URL http://localhost...

Previous Section
End of Section 10
Next Section