Skip to main content

Core Service Client Sample Code

[ This post presents a .NET client for Core Service. If you are looking for a Java client for Core Service, have a look at A Core Service Java Client ]

Let me start by saying this topic is not new, but because it is pretty cool technology, I thought I would also give a sample on it.

In Tridion 2011GA, you could create a Core Service client by going to Visual Studio and Add Service Reference... in your project's References. This would generate proxy classes on the "Core Service" Web Service.

In Tridion 2011 SP1, you no longer need to generate these classes, as they are already available in a DLL (namely %TRIDION_HOME%\bin\client\Tridion.ContentManager.CoreService.Client.dll).

In a normal scenario, one would need the Core Service configuration endpoints (from %TRIDION_HOME%\bin\client\Tridion.ContentManager.CoreService.Client.dll.config) be available to the client's runtime (either in app.config or web.config or some dll.config). Alternatively though, we can instantiate the client using programmatic configuration. Thus, we no longer need the config file, making the code more portable. In many situations, I see that only the 'hostname' of Tridion CM is needed, so that we can point to the machine where the Core Service is running (e.g. localhost).

I like creating a Disposable wrapper around a Core Service client, such that it's easy to use within a 'using' block. This gives great advantage of not having to deal with opening the channel, configuring it, closing it, etc. Check out my previous blog post about using this CoreServiceSession.

using System;
using System.ServiceModel;
using System.Xml;
using Tridion.ContentManager.CoreService.Client;

namespace YATB
{
    public class CoreServiceSession : IDisposable
    {
        private readonly SessionAwareCoreServiceClient _client;

        public CoreServiceSession()
        {
            var netTcpBinding = new NetTcpBinding
            {
                MaxReceivedMessageSize = 2147483647,
                ReaderQuotas = new XmlDictionaryReaderQuotas
                    {
                        MaxStringContentLength = 2147483647,
                        MaxArrayLength = 2147483647
                    }
            };

            var remoteAddress = new EndpointAddress("net.tcp://localhost:2660/CoreService/2011/netTcp");
            _client = new SessionAwareCoreServiceClient(netTcpBinding, remoteAddress);
        }

        public void Dispose()
        {
            if (_client.State == CommunicationState.Faulted)
            {
                _client.Abort();
            }
            else
            {
                _client.Close();
            }
        }

        public UserData GetCurrentUser()
        {
            return _client.GetCurrentUser();
        }

        public void SaveApplicationData(string subjectId, ApplicationData[] applicationData)
        {
            _client.SaveApplicationData(subjectId, applicationData);
        }

        public ApplicationData ReadApplicationData(string subjectId, string applicationId)
        {
            return _client.ReadApplicationData(subjectId, applicationId);
        }
    }
}

The code-above uses netTcp endpoint and all its properties are specified programmatically, but alternatively, you could use the basicHttp end point. The sample code for creating a basicHttp client programmatically is the following:

var basicHttpBinding = new BasicHttpBinding
{
    MaxReceivedMessageSize = 10485760,
    ReaderQuotas = new XmlDictionaryReaderQuotas
    {
        MaxStringContentLength = 10485760,
        MaxArrayLength = 10485760
    },
    Security = new BasicHttpSecurity
    {
        Mode = BasicHttpSecurityMode.TransportCredentialOnly,
        Transport = new HttpTransportSecurity
        {
            ClientCredentialType = HttpClientCredentialType.Windows
        }
    }
};

var remoteAddress = new EndpointAddress("http://localhost/webservices/CoreService2011.svc/basicHttp");
_client = new CoreServiceClient(basicHttpBinding, remoteAddress);


Comments

esteewhy said…
Is there any [theoretical] possibility to use Core Services from JS? (Security is not a concern as this is supposed to run from FF XUL/WebKit DevTools)
Mihai Cădariu said…
[Theoretically] there should be no problem accessing the Core Service from JS. It's nothing different than accessing a Web Service from .NET.

A very quick Google search on "WCF javascript client" yields the URL http://dotnetbyexample.blogspot.ro/2008/02/calling-wcf-service-from-javascript.html that describes how to create a simple WCF web service and its Javascript proxy class.
Nivlong said…
Thanks, Mihai. I can see where we need to implement .Dispose() for a CoreServiceSession. Do we do the same when using basicHttp?
Mihai Cădariu said…
I would do it... just to keep things proper ;)
Jan H said…
Can the CoreServiceSession.Dispose() method just call _client.Dispose()?
I think that SessionAwareCoreServiceClient.Dispose() and also CoreServiceConnection.Dispose() call ClientHelper.DisposeClient() which checks the client.State and then calls Abort() or Close(). At least, in SDL Web 8.5 it does, this might have changed over time.

Popular posts from this blog

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

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

Debugging a Tridion 2011 Event System

OK, so you wrote your Tridion Event System. Now it's time to debug it. I know this is a hypothetical situtation -- your code never needs any kind of debugging ;) but indulge me... Recently, Alvin Reyes ( @nivlong ) blogged about being difficult to know how exactly to debug a Tridion Event System. More exactly, the question was " What process do I attach to for debugging even system code? ". Unfortunately, there is no simple or generic answer for it. Different events are fired by different Tridion CM modules. These modules run as different programs (or services) or run inside other programs (e.g. IIS). This means that you will need to monitor (or debug) different processes, based on which events your code handles. So the usual suspects are: dllhost.exe (or dllhost3g.exe ) - running as the MTSUser is the SDL Tridion Content Manager COM+ application and it fires events on generic TOM objects (e.g. events based on Tridion.ContentManager.Extensibility.Events.CrudEven