Search: integration of external DAM services

    // ... other configuration
    "allowImport": function( ctx ) {
        // Allow import only for images.
        if (ctx.activeObject.getInfo().type.toLowerCase() === 'rsimage') {
            return true;
        }
        return false;
    },
    // ... other configuration

    // OR

    "allowImport": true / false

{
    // ... other configuration
    "allowImport": function( ctx ) {
        // Allow import only for images.
        if (ctx.activeObject.getInfo().type.toLowerCase() === 'rsimage') {
            return true;
        }
        return false;
    },
    // ... other configuration
    "getImportInfo": function( ctx ) {
        var objInfo = ctx.activeObject.getInfo();

        // IMPORTANT. If the "url" is relative, this won't work.
        // To obtain the absolute url, use the ctx.getAbsoluteUrl( url ) method.

        return {
            "url": ctx.getAbsoluteUrl( objInfo.original_url ),
            "filename": objInfo.id + '.png', // See below
            "conflictResolutionMode": 'conflict.user', // See below
            "conflictAlternatives": ['conflict.autoRename', 'conflict.useExisting', 'conflict.replace', 'conflict.newVersion', 'conflict.doNotCreate'], // See below
            "attributes": "Here you can specify the XML metadata",
            "uniqueId": "Specify the uniqueness_string here",
            "info": {
                "otherCustomProperties": "Some value"
            }
        }
    }
}

/**
 * Plugin name: ResourceSpace
 * The plugin adds the possibility to integrate Resource Space DAM
 */

// Add a new domain in the search dialog.
eidosmedia.webclient.extensions.search.addDomain({
    "name": "resourcespace",
    "type": "resourcespace",
    "label": "ResourceSpace Search",
    "icon": "icon-foursquare",
    "itemsPerPage": 8,
    "allowNoInput": true,
    "useExternalSuggestion": false,
    "searchTemplate" : [{ type: "rsimage", template: "search-preview-image.html" }],
    /* It is possible to add Archives and conditions. Please refer to Domains configuration. */
    "allowImport": function( item ) {
        return true;
    },
    "getImportInfo": function( item ) {
        var objInfo = ctx.activeObject.getInfo();

        return {
            "url": objInfo.original_url,
            "attributes": "Here you can specify the XML metadata",
            "uniqueId": "Specify the uniqueness_string here",
            "info": {
                "otherCustomProperties": "Some value"
            }
        }
    },
    "controller": function( options, callbacks ) {

        var API_KEY = 'V0aRlntBV163dNJK5prQv5E1IXNUwGKudTIGZcq8xissufD8lBpQ2I1TgkRn_Xlvm8RvL_ezBOzTOS4s4IV40g';

        // If the user did not put any input, show an error.
        // In this specific case (resourceSpace), search without terms is allowed,
        // so the following code is commented
        /*
        if (!options.input) {
            callbacks.error( { message: 'No input provided' } );
            return;
        }
        */

        /*
            Archive management
            resourceSpace example did NOT use any archive, so this part is omitted.
            Another example (such as wikipedia), used the archive to build the link, as shown
            in the following (commented) example.
        */

        /*
            // Takes the first archive, or 'en' as default
            var archive = (options.archives && options.archives.length) ? options.archives[0] : 'en';

            // Build the url necessary for wikipedia.
            var url1 = 'http://' + (archive || 'en') +
                       '.wikipedia.org/w/api.php?action=query&list=search&callback=&srsearch=' +
                       encodeURI(options.input) + '&format=json&rawcontinue&srprop=snippet';
        */

        // Prepares the url
        var url = eidosmedia.webclient.app.context + "/resourcespacesearch/";

        // With the try..catch no error will escape!
        try {
            $.ajax({
              url: options.getUrl(),
              data: {
                "key": API_KEY,
                "search": options.input,
                "prettyfieldnames": true,
                "original": true,
                "previewsize": "thm"
              },
              success: function(response) {

                  // Do something with the response...
                  // Prepare JSON ( see the next paragraph for that ).
                  // If we used a default template, we would have to adapt the response JSON
                  // to Swing Templates, as shown here.

                  for( var j in response ) {
                      response[j].id = response[j]["original_link"];
                      response[j].type = "rsImage";
                      response[j].methodeType = "image";
                      response[j].title = response[j].Title;
                      response[j].hideStatus = true;
                      response[j].preview = response[j].content = response[j]["preview"];
                  }
                  // OR
                  // If we used a custom template, we could just use the JSON 'as-is'

                  // REMEMBER TO SET AT LEAST ID AND TYPE AND METHODE TYPE FOR EACH ITEM.
                  //for( var j in response ) {
                  //    response[j].id = response[j]["original_link"];
                  //    response[j].type = "rsImage";
                  //    response[j].methodeType = "image";
                  //}

                  // Call the successful callback.
                  callbacks.success( { items: response } );
              },
              error: function( ex ) {
                  // Call the error callback.
                  callbacks.error( ex );
              }
            });
        } catch( ex ) {
            // Call the error callback.
            callbacks.error( ex );
        }
    }
});

<Context docBase="com.eidosmedia.webclient.web-app"
    path="/swing" reloadable="false">
    <Resources
        className="org.apache.catalina.webresources.StandardRoot">
        <PreResources
            className="org.apache.catalina.webresources.DirResourceSet"
            base="/methode/meth01/extension/plugins" readOnly="true"
            webAppMount="/app/plugins" />
    </Resources>
</Context>