Implemented Changes Since mechanism.

Author: rafidzal

Code/Sif3Framework/Sif.Framework.EnvironmentProvider/Properties/AssemblyInfo.cs

@@ -10,7 +10,7 @@
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("Systemic Pty Ltd")]
 [assembly: AssemblyProduct("Sif.Framework.EnvironmentProvider")]
-[assembly: AssemblyCopyright("Copyright © Systemic Pty Ltd 2016")]
+[assembly: AssemblyCopyright("Copyright © Systemic Pty Ltd 2017")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
@@ -31,5 +31,5 @@
 //
 // You can specify all the values or you can default the Revision and Build Numbers 
 // by using the '*' as shown below:
-[assembly: AssemblyVersion("3.0.0.0")]
-[assembly: AssemblyFileVersion("3.0.0.0")]
+[assembly: AssemblyVersion("3.1.0.0")]
+[assembly: AssemblyFileVersion("3.1.0.0")]

Code/Sif3Framework/Sif.Framework.Tests/Properties/AssemblyInfo.cs

@@ -10,7 +10,7 @@
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("Systemic Pty Ltd")]
 [assembly: AssemblyProduct("Sif.Framework.Test")]
-[assembly: AssemblyCopyright("Copyright © Systemic Pty Ltd 2016")]
+[assembly: AssemblyCopyright("Copyright © Systemic Pty Ltd 2017")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("3.0.0.0")]
-[assembly: AssemblyFileVersion("3.0.0.0")]
+[assembly: AssemblyVersion("3.1.0.0")]
+[assembly: AssemblyFileVersion("3.1.0.0")]

Code/Sif3Framework/Sif.Framework/Consumers/Consumer.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Systemic Pty Ltd
+ * Copyright 2017 Systemic Pty Ltd
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
  */
 
 using log4net;
+using Sif.Framework.Extensions;
 using Sif.Framework.Model.DataModels;
 using Sif.Framework.Model.Query;
 using Sif.Framework.Model.Responses;
@@ -181,6 +182,23 @@ public void Unregister(bool? deleteOnUnregister = null)
             registrationService.Unregister(deleteOnUnregister);
         }
 
+        /// <summary>
+        /// <see cref="IConsumer{TSingle,TMultiple,TPrimaryKey}.GetChangesSinceMarker(string, string)">GetChangesSinceMarker</see>
+        /// </summary>
+        public string GetChangesSinceMarker(string zone = null, string context = null)
+        {
+
+            if (!RegistrationService.Registered)
+            {
+                throw new InvalidOperationException("Consumer has not registered.");
+            }
+
+            string url = EnvironmentUtils.ParseServiceUrl(EnvironmentTemplate) + "/" + TypeName + "s" + HttpUtils.MatrixParameters(zone, context);
+            WebHeaderCollection responseHeaders = HttpUtils.HeadRequest(url, RegistrationService.AuthorisationToken);
+
+            return responseHeaders[HttpUtils.RequestHeader.changesSinceMarker.ToDescription()];
+        }
+
         /// <summary>
         /// <see cref="IConsumer{TSingle,TMultiple,TPrimaryKey}.Create(TSingle, string, string)">Create</see>
         /// </summary>
@@ -298,7 +316,7 @@ public virtual TMultiple Query(uint? navigationPage = null, uint? navigationPage
         }
 
         /// <summary>
-        /// <see cref="IConsumer{TSingle,TMultiple,TPrimaryKey}.QueryByExample(TSingle, uint?, uint?, string, string)">Query</see>
+        /// <see cref="IConsumer{TSingle,TMultiple,TPrimaryKey}.QueryByExample(TSingle, uint?, uint?, string, string)">QueryByExample</see>
         /// </summary>
         public virtual TMultiple QueryByExample(TSingle obj, uint? navigationPage = null, uint? navigationPageSize = null, string zone = null, string context = null)
         {
@@ -319,7 +337,7 @@ public virtual TMultiple QueryByExample(TSingle obj, uint? navigationPage = null
         }
 
         /// <summary>
-        /// <see cref="IConsumer{TSingle,TMultiple,TPrimaryKey}.QueryByServicePath(IEnumerable{EqualCondition}, uint?, uint?, string, string)">Query</see>
+        /// <see cref="IConsumer{TSingle,TMultiple,TPrimaryKey}.QueryByServicePath(IEnumerable{EqualCondition}, uint?, uint?, string, string)">QueryByServicePath</see>
         /// </summary>
         public virtual TMultiple QueryByServicePath(IEnumerable<EqualCondition> conditions, uint? navigationPage = null, uint? navigationPageSize = null, string zone = null, string context = null)
         {
@@ -357,6 +375,36 @@ public virtual TMultiple QueryByServicePath(IEnumerable<EqualCondition> conditio
             return DeserialiseMultiple(xml);
         }
 
+        /// <summary>
+        /// <see cref="IConsumer{TSingle,TMultiple,TPrimaryKey}.QueryChangesSince(string, out string, uint?, uint?, string, string)">QueryChangesSince</see>
+        /// </summary>
+        public TMultiple QueryChangesSince(string changesSinceMarker, out string nextChangesSinceMarker, uint? navigationPage = null, uint? navigationPageSize = null, string zone = null, string context = null)
+        {
+
+            if (!RegistrationService.Registered)
+            {
+                throw new InvalidOperationException("Consumer has not registered.");
+            }
+
+            string changesSinceParameter = (changesSinceMarker == null ? string.Empty : "?changesSinceMarker=" + changesSinceMarker);
+            string url = EnvironmentUtils.ParseServiceUrl(EnvironmentTemplate) + "/" + TypeName + "s" + HttpUtils.MatrixParameters(zone, context) + changesSinceParameter;
+            WebHeaderCollection responseHeaders;
+            string xml;
+
+            if (navigationPage.HasValue && navigationPageSize.HasValue)
+            {
+                xml = HttpUtils.GetRequestAndHeaders(url, RegistrationService.AuthorisationToken, out responseHeaders, (int)navigationPage, (int)navigationPageSize);
+            }
+            else
+            {
+                xml = HttpUtils.GetRequestAndHeaders(url, RegistrationService.AuthorisationToken, out responseHeaders);
+            }
+
+            nextChangesSinceMarker = responseHeaders[HttpUtils.RequestHeader.changesSinceMarker.ToDescription()];
+
+            return DeserialiseMultiple(xml);
+        }
+
         /// <summary>
         /// <see cref="IConsumer{TSingle,TMultiple,TPrimaryKey}.Update(TSingle, string, string)">Update</see>
         /// </summary>

Code/Sif3Framework/Sif.Framework/Consumers/IConsumer.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Systemic Pty Ltd
+ * Copyright 2017 Systemic Pty Ltd
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -44,6 +44,15 @@ public interface IConsumer<TSingle, TMultiple, TPrimaryKey> : IPayloadSerialisab
         /// <param name="deleteOnUnregister">True to remove session data on unregister; false to leave session data.</param>
         void Unregister(bool? deleteOnUnregister = null);
 
+        /// <summary>
+        /// Retrieve the current Changes Since marker.
+        /// <para>HEAD /StudentPersonals</para>
+        /// </summary>
+        /// <param name="zone">Zone associated with the request.</param>
+        /// <param name="context">Zone context.</param>
+        /// <returns>Changes Since marker.</returns>
+        string GetChangesSinceMarker(string zone = null, string context = null);
+
         /// <summary>
         /// Create a single object.
         /// <para>POST /StudentPersonals/StudentPersonal</para>
@@ -111,6 +120,19 @@ public interface IConsumer<TSingle, TMultiple, TPrimaryKey> : IPayloadSerialisab
         /// <returns>Retrieved objects.</returns>
         TMultiple QueryByServicePath(IEnumerable<EqualCondition> conditions, uint? navigationPage = null, uint? navigationPageSize = null, string zone = null, string context = null);
 
+        /// <summary>
+        /// Retrieve multiple objects based on the Changes Since marker.
+        /// <para>GET /StudentPersonals</para>
+        /// </summary>
+        /// <param name="changesSinceMarker">Changes Since marker.</param>
+        /// <param name="nextChangesSinceMarker">Next Changes Since marker.</param>
+        /// <param name="navigationPage">Current paging index.</param>
+        /// <param name="navigationPageSize">Page size.</param>
+        /// <param name="zone">Zone associated with the request.</param>
+        /// <param name="context">Zone context.</param>
+        /// <returns>Retrieved objects.</returns>
+        TMultiple QueryChangesSince(string changesSinceMarker, out string nextChangesSinceMarker, uint? navigationPage = null, uint? navigationPageSize = null, string zone = null, string context = null);
+
         /// <summary>
         /// Update a single object.
         /// <para>PUT /StudentPersonals/{id}</para>

Code/Sif3Framework/Sif.Framework/Extensions/Extension.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Systemic Pty Ltd
+ * Copyright 2017 Systemic Pty Ltd
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,9 @@
  */
 
 using Sif.Framework.WebApi;
+using Sif.Framework.WebApi.ActionResults;
 using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 using System.Linq;
 using System.Web.Http;
@@ -29,6 +31,40 @@ namespace Sif.Framework.Extensions
     static class Extension
     {
 
+        /// <summary>
+        /// Extension to add a custom header to an action result.
+        /// </summary>
+        /// <param name="actionResult">Action result.</param>
+        /// <param name="headerName">Name of the header.</param>
+        /// <param name="headerValue">Value associated with the header.</param>
+        /// <returns>Action result with a custom header.</returns>
+        public static IHttpActionResult AddHeader(this IHttpActionResult actionResult, string headerName, string headerValue)
+        {
+            return AddHeader(actionResult, headerName, new[] { headerValue });
+        }
+
+        /// <summary>
+        /// Extension to add a custom header to an action result.
+        /// </summary>
+        /// <param name="actionResult">Action result.</param>
+        /// <param name="headerName">Name of the header.</param>
+        /// <param name="headerValues">Values associated with the header.</param>
+        /// <returns>Action result with a custom header.</returns>
+        public static IHttpActionResult AddHeader(this IHttpActionResult actionResult, string headerName, ICollection<string> headerValues)
+        {
+            return new CustomHeaderResult(actionResult, headerName, headerValues);
+        }
+
+        /// <summary>
+        /// Extension to clear the content of an action result but the leave the content length.
+        /// </summary>
+        /// <param name="actionResult">Action result.</param>
+        /// <returns>Action result with empty content.</returns>
+        public static IHttpActionResult ClearContent(this IHttpActionResult actionResult)
+        {
+            return new EmptyContentResult(actionResult);
+        }
+
         /// <summary>
         /// Extension of types to check whether one is assignable from a generic type.
         /// </summary>

Code/Sif3Framework/Sif.Framework/Properties/AssemblyInfo.cs

@@ -10,7 +10,7 @@
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("Systemic Pty Ltd")]
 [assembly: AssemblyProduct("Sif.Framework")]
-[assembly: AssemblyCopyright("Copyright © Systemic Pty Ltd 2016")]
+[assembly: AssemblyCopyright("Copyright © Systemic Pty Ltd 2017")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 

Code/Sif3Framework/Sif.Framework/Providers/IProvider.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 Systemic Pty Ltd
+ * Copyright 2017 Systemic Pty Ltd
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -97,10 +97,11 @@ interface IProvider<TSingle, TMultiple, TPrimaryKey>
         /// <para>500 - Failure, internal service error</para>
         /// </summary>
         /// <param name="obj">Example object to base the query on.</param>
+        /// <param name="changesSinceMarker">Changes Since marker.</param>
         /// <param name="zone">Zone associated with the request.</param>
         /// <param name="context">Zone context.</param>
         /// <returns>All objects, objects that match the properties of the example object or no objects (TMultiple).</returns>
-        IHttpActionResult Get(TSingle obj, string[] zone = null, string[] context = null);
+        IHttpActionResult Get(TSingle obj, string changesSinceMarker = null, string[] zone = null, string[] context = null);
 
         /// <summary>
         /// Retrieve multiple objects using Service Paths.
@@ -196,6 +197,23 @@ interface IProvider<TSingle, TMultiple, TPrimaryKey>
         /// <returns>Response containing status of each object deleted (deleteResponseType).</returns>
         IHttpActionResult Delete(deleteRequestType deleteRequest, string[] zone = null, string[] context = null);
 
+        /// <summary>
+        /// Retrieve the message headers associated with a call to retrieve all objects.
+        /// <para>HEAD api/{controller}</para>
+        /// <para/>
+        /// <para>200 - Success, ok</para>
+        /// <para>204 - Success, no content</para>
+        /// <para>400 - Failue, bad request</para>
+        /// <para>401 - Failure, unauthorised</para>
+        /// <para>403 - Failure, forbidden</para>
+        /// <para>413 - Failure, response too large</para>
+        /// <para>500 - Failure, internal service error</para>
+        /// </summary>
+        /// <param name="zone">Zone associated with the request.</param>
+        /// <param name="context">Zone context.</param>
+        /// <returns>No objects, just message header information (void).</returns>
+        IHttpActionResult Head(string[] zone = null, string[] context = null);
+
     }
 
 }