You are here

Creating request processing web scripts

When performing an HTTP POST to a web script, the posted request body often contains content that needs processing by the web script. To allow access to the request body, the Web Script Framework provides a special root object named requestbody that represents the content of the request. The requestbody is a ScriptContent object allowing access to the request content either as a string or as a content stream.
This task demonstrates request processing by creating a web script, which simply responds with the content of the HTTP request.
  1. Log in to Alfresco Share:
    1. Open a web browser and enter the URL: http://localhost:8080/share
    2. If prompted, log in with the user name admin and password admin.
  2. Navigate to Data Dictionary > Web Scripts Extensions > org > example.
  3. Create a web script description document for your request body sample:
    1. In the Create menu, select XML.
    2. Enter the name for the web script in the Name field: requestbody.post.desc.xml
    3. Type the following in the content box:

      <webscript>
        <shortname>Request Body Sample</shortname>
        <description>Render the request body in the response</description>
        <url>/requestbody</url>
        <authentication>user</authentication>
      </webscript>
    4. Click Create.
    5. Navigate back to the org/example folder using the breadcrumb trail.
  4. Create a controller script for your request body sample:
    1. In the Create menu, select Plain Text.
    2. Enter the name in the Name field: requestbody.post.js
    3. Type the following in the content box:

      model.requestcontent = requestbody.content;
    4. Click Create.
    5. Navigate back to the org/example folder using the breadcrumb trail.
  5. Create an HTML response template for your request body sample:
    1. In the Create menu, select Plain Text.
    2. Enter the name in the Name field: requestbody.post.html.ftl
    3. Type the following in the content box:

      ${requestcontent}
    4. Click Create.
    5. Navigate back to the org/example folder using the breadcrumb trail.
  6. Register the web scripts with Alfresco.
    1. In a new web browser tab, enter the URL: http://localhost:8080/alfresco/service/index
    2. If prompted, log in with the user name admin and password admin.
    3. Click Refresh Web Scripts.

    A message indicates there is an additional web script.

    Your example consists of just two lines of code. The controller script extracts the request content from the requestbody root object and places it into the Web script model under the name requestcontent. The response template simply outputs the model value into the response.

  7. Test this web script with cURL by typing the following in your command line:

                
    curl -uadmin:admin -H "Content-Type: application/json" --data-binary "{\"request\":\"body\"}" "http://localhost:8080/alfresco/service/requestbody"
    
    

    This posts a request body of {"request": "body"} to your web script, which in turn responds with: {"request": "body"}

Often the content posted in a request is structured using data formats such as XML or JSON, which the web script has to parse. Parser code is generally painful to develop, so the Web Script Framework provides a mechanism known as a Format Reader that parses a request of a given MIME type into an object that represents the request content. The object is then supplied to the controller script, which can interrogate the object to extract request content.