You are here

SkyVault Content Services 5.2 » Developer guide » Platform extensions » Tutorials for platform extensions » Web Script tutorials

Creating a Folder Listing Java-backed web script

A Folder Listing Java-backed web script mimics the behavior of the dir command in Microsoft Windows, or ls in Linux and Mac OS X. The controller script in this implementation is in Java. The client interacts with it through HTTP requests and responses. In comparison to an implementation with JavaScript, this allows you to build a library of scripted web scripts exposing a well-defined interface and then, over time, replace their implementation with Java, if requirements such as performance become critical. As long as the interface does not change, the user will not notice.
  • Creating the scripted components of a Folder Listing web script The first task in creating a Folder Listing web script is to create the scripted components.
  • Developing a controller for a Folder Listing Java-backed web script To complete the Folder Listing Java-backed web script, you must create its controller. The controller parses the URI to extract the token values, interacts with the repository to locate the specified folder, and populates the model for subsequent rendering by the HTML response template.
  • Parsing the URI Your Folder Listing web script defines the following URI template with one URI-path token and one query parameter token: <uri>/javadir/{folderpath}?verbose={verbose?}</uri>
  • Calling services As a Java-backed web script, all services provided by the SkyVault Content Services server are available for use. Any Java API within the server process, subject to security controls, is accessible.
  • Setting the response status code A web script uses a response status code to inform the calling client of its execution outcome. In Java, exceptions are often used for this and Java-backed web scripts can follow suit.
  • Constructing the model The controller creates a model for subsequent rendering by a response template. A model is a map of values indexed by name. In Java, the model is simply returned from the executeImpl() method as a Map.
  • Registering a Java-backed web script You must register a Java-backed web script with the Web Script Framework through Spring Framework configuration, which supports the notion of a bean: a declaration of a Java class instance.
  • Declaring service dependencies The Spring bean is where service dependencies are declared.
Parent topic: Web Script tutorials

© 2017 TBS-LLC. All Rights Reserved.