How does url.context is initialized in aikau widget?

Question

Aikau example defines the following:

{
  name: "alfresco/forms/controls/DojoSelect",
  config: {
     label: "List Type",
     name: "prop_dl_dataListItemType",
     value: "dl:event",
     optionsConfig: {
        publishTopic: "ALF_GET_FORM_CONTROL_OPTIONS",
        publishPayload: {
           url: url.context + "/proxy/alfresco/api/classes/dl_dataListItem/subclasses",
           itemsAttribute: "",
           labelAttribute: "title",
           valueAttribute: "name"
        }
     }
  }

}

Pay attention to url.context. I have not found any url definition in example sources. It seems that url implicitly initialized somewhere. But where exactly? What other fields/methods url object has?

It's related to the Surf root object. http://docs.alfresco.com/5.1/references/APISurf-rootscoped.html — izodev, Dec 05 '16 at 06:05

score 1 · Answer 1 · edited Jun 20 '20 at 09:12

1

Aikau will be building the URL on the service.js file. For example, you can take a look at the CRUDService.js file and refer getUrlFromPayload method and this method is called like,

 onGetAll: function alfresco_services_CrudService__onGetAll(payload) {
var url = this.getUrlFromPayload(payload); .... }

and it will be passed the request object, to make the request.

Hope this help you.

edited Jun 20 '20 at 09:12

Community

1
1

answered Dec 05 '16 at 08:53

Muralidharan Deenathayalan

1,486
1
8
17

score 1 · Answer 2 · answered Dec 05 '16 at 11:48

The url object is available in all JavaScript controllers of WebScripts. It is one of a number of built-in objects that are provided for convenience (others include "remote" and "user" for example). The url.context will be configured to the context of the application being run. So typically the value returned would be "share" (as this is the default application context).

The application context is typically required when defining the URL for APIs defined either on the Share tier (i.e. /share/services/...) or the Repository tier (i.e. /share/proxy/alfresco/...).

The url.context should be used as it is possible to configure applications to have alternative context roots so it is better to code to something that Surf can handle for you.

Surf and WebScripts have been around for a lot longer than Aikau and they unfortunately have suffered from a lack of good documentation.

The Java class that back the url object is "org.springframework.extensions.webscripts.DefaultURLHelper" (which extends "org.springframework.extensions.webscripts.URLHelper"). Other attributes that are available include:

pageContext
uri
queryString
args
templateArgs

How does url.context is initialized in aikau widget?

2 Answers2