Skip to main content

JQuery JavaScript Client for CoreService

In my previous post, I presented a JavaScript CoreService client that was using the out-of-the-box Visual Studio project and a WCF generated JS proxies using the Microsoft AJAX framework.

In this blog post, I write about a JQuery client for CoreService that is lighter and only depends on JQuery. I took my inspiration from Yoav's blog post Creating a Webservice Proxy with jQuery

The server part remains untouched. This means I can only focus on the JavaScript client.

CoreService is secured with Basic or Federated authentication. I am focusing on Basic auth in this post, mainly because it is so simple to use from JS.

The main entry point in the code is the ServiceProxy class. This is where we define the constructor and where we set the endpoint to use for CoreService and the username, password combination to use.

The ServiceProxy makes use of the JQuery's $.ajax function, where it performs a POST to the CoreService endpoint, sets the payload to send, Authorization header and the success, failed callback functions.

ServiceProxy = function (adminUser, adminPassword, endpoint) {
    this._basicAuth = "Basic " + btoa(adminUser + ":" + adminPassword);
    this._baseURL = endpoint;
};

ServiceProxy.prototype =
{
    _defaultErrorHandler: function (xhr, status, error) {
        alert(xhr.status + " " + xhr.statusText + "\r\n" + xhr.responseText);
    },

    _doAjax: function (method, data, fnSuccess, fnError, isAsync) {
        if (!data) data = {};
        if (isAsync == undefined) isAsync = true;
        if (!fnError) fnError = this._defaultErrorHandler;

        $.ajax({
            type: "POST",
            url: this._baseURL + method,
            data: data,
            contentType: "application/json; charset=utf-8",
            headers: { "Authorization": this._basicAuth },
            success: fnSuccess,
            error: fnError,
            async: isAsync
        });
    },

    getCurrentUser: function (success, error) {
        this._doAjax("GetCurrentUser", null, success, error);
    }
};

The code above also declares method getCurrentUser, which calls the CoreService GetCurrentUser method without posting any payload.

The HTML

The sample code below connects to the CoreService endpoint defined earlier and performs a sample call to retrieve the current user.

Notice that the JS code only requires the JQuery library and the ServiceProxy we defined earlier.

Since we are declaring contentType as application/json, JQuery will parse and decode the JSON response from the web-service into a JavaScript object.

<!DOCTYPE html>
<html>
<head>
    <script src="jquery-1.10.2.js"></script>
    <script src="ServiceProxy.js"></script>
</head>
<body>
    <script type="text/javascript">
        var proxy = new ServiceProxy("mihai@adfs", "p@assword",
            "https://web85.playground/webservices/CoreService201603.svc/rest/");

        function userSuccess(result) {
            if (!result) {
                alert("no result");
                return;
            }

            if (result.hasOwnProperty("d")) {
                result = result.d;
            }

            alert("Retrieved user: " + result.Id + " | " + result.Description);
        }

        $(document).ready(function () {
            proxy.getCurrentUser(userSuccess);
        });
    </script>
</body>
</html>




Comments

Popular posts from this blog

Scaling Policies

This post is part of a bigger topic Autoscaling Publishers in AWS . In a previous post we talked about the Auto Scaling Groups , but we didn't go into details on the Scaling Policies. This is the purpose of this blog post. As defined earlier, the Scaling Policies define the rules according to which the group size is increased or decreased. These rules are based on instance metrics (e.g. CPU), CloudWatch custom metrics, or even CloudWatch alarms and their states and values. We defined a Scaling Policy with Steps, called 'increase_group_size', which is triggered first by the CloudWatch Alarm 'Publish_Alarm' defined earlier. Also depending on the size of the monitored CloudWatch custom metric 'Waiting for Publish', the Scaling Policy with Steps can add a difference number of instances to the group. The scaling policy sets the number of instances in group to 1 if there are between 1000 and 2000 items Waiting for Publish in the queue. It also sets the

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as

Toolkit - Dynamic Content Queries

This post if part of a series about the  File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents the Dynamic Content Query capability. The requirements for the Toolkit API are that it should be able to provide CustomMeta queries, pagination, and sorting -- all on the file system, without the use third party tools (database, search engines, indexers, etc). Therefore I had to implement a simple database engine and indexer -- which is described in more detail in post Writing My Own Database Engine . The querying logic does not make use of cache. This means the query logic is executed every time. When models are requested, the models are however retrieved using the ModelFactory and those are cached. Query Class This is the main class for dynamic content queries. It is the entry point into the execution logic of a query. The class takes as parameter a Criterion (presented below) which triggers the execution of query in all sub-criteria of a Criterio