WCF - design a reliable, extendible and consistent data exchange between consumer and provider of services

Let me share with the community with what I've learnt and successfully implemented a generalised data response (data packet) exchanged between the consumer and the provider, in context to WCF services .. 

 The idea behind this concept is pretty simple! Instead of expecting a specific data type returned from the server call on its own, package that as part of a container that can facilitate not only the actual data expected by the consumer for a call to any service from the provider but additionally figure out if there were any validation/error that may have happened during that service call - all in one go! 

The following is a simple implementation within the context of using ASP.Net MVC on the front-end and Entity Framework as a ORM tool (data layer) ..


Step 1: PayLoad.cs (where the generic payload implementation lives)

    [DataContract(Name = "PayLoadListUsing={0}")]
    public class PayLoadList<TEntity>
    where TEntity : class, new()
    {
        private TEntity _entity;

         public PayLoadList()
        {
            _entity = new TEntity();
        }

         [DataMember]
        public IEnumerable<TEntity> Data {get; set; }
        //design a Validation Class and make that a data member of Payload

         //design an Error Class and make that a data member of Payload

         //add anything that is required to be part of the Payload ...
    }



Step 2: Declare an operation contract that leverages the generic payload

        [OperationContract]
        PayLoadList<Student> GetStudentList();

Step 3: Under the service implementation, assign the list of data (in this case, list of Students to the *Data* member of Payload

        public PayLoadList<Student> GetStudentList()
        {
            var ret = new PayLoadList<Student>();

             var students = DataManager.GetStudents();

             ret.Data = students;

             //ret.Error = _errorList 
            //ret.Validation = _validationList

             return ret;
        }

Step 4: Controller/UI

Leverage GetStudentList().Data to pass as a *model* for Controller.View


Comments

Post a Comment

Popular posts from this blog

Baseless merge!

Baseless merge in TFS ? or a Baseless Question? :-) A colleague came over wondering for what someone asked him to do - and that is to merge two branches. I believe, the tool allows you to do that however, I wouldn't recommend it simply because it is a sort of sibling-sibling merge rather than (what it is intended for) parent-child merge. Reference to support my perspective ... How do I merge two branches? To perform a merge, you can use the merge functionality in Source Control Explorer, or you can use the  merge  command-line tool. You can merge based on changeset, label, date, or version. You might find that your branching structure becomes deeper than one level. If this happens, keep in mind that it is only possible to merge one level at a time. For example, consider the following source tree structure: Development  – Container for isolation development branches. Feature A Source Feature B Source Main  – Main integration build bran...
Read more

QuadKey - what it is?

Image
To start with, let me share an excerpt from MSDN as below: Bing Maps Tile System (Reference:   https://msdn.microsoft.com/en-us/library/bb259689.aspx ) Bing Maps provides a world map that users can directly manipulate to pan and zoom. To make this interaction as fast and responsive as possible, we chose to pre-render the map at many different levels of detail, and to cut each map into tiles for quick retrieval and display. This document describes the projection, coordinate systems, and addressing scheme of the map tiles, which collectively are called the Bing Maps Tile System. So if you follow the above references Bing Maps Tile System, you would get an idea that  - how the world map is kind of apportioned into a tile system and depending on what level of detail or zoom you are interested in, you would get a <N> character long quad-key.  For what I am involved with currently, we care to go for the maximum allowable detail to uniquely identify each...
Read more

Binding ENUM to WPF control - ComboBox

I believe, I explored quite a bit on finding the best approach for my requirement of binding Enum to WPF ComboBox and thought to share the gradual steps here for a one-stop place which hopefully will help similar minded technical enthusiast .. The simplest approach: You want to just bind Enum as it appears (verbatim) to the WPF combo .. Let's define a sample enum as follows: namespace {    public enum TestEnum    {       String1,       String2,       String3,       String4    } } All we now need is a way to leverage Enum - GetValues method to provide a list of values that lets you bind directly to the ComboBox via ItemSource. < ObjectDataProvider x : Key ="dataFromEnum" MethodName ="GetValues" ObjectType ="{ x : Type sys : Enum }" > < ObjectDataProvider.MethodParameters > < x : Type TypeName ="local:TestEnum" /> </ ...
Read more