Implement message payload compression.

Implemented message payload compression.

Author: rafidzal

Code/Sif3Framework/Sif.Framework/Model/Settings/ConfigFileBasedFrameworkSettings.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 Systemic Pty Ltd
+ * Copyright 2016 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.
@@ -14,14 +14,9 @@
  * limitations under the License.
  */
 
-using log4net;
 using Sif.Framework.Model.Infrastructure;
-using Sif.Framework.Utils;
 using System;
-using System.Collections.Generic;
 using System.Configuration;
-using System.Linq;
-using System.Reflection;
 
 namespace Sif.Framework.Model.Settings
 {
@@ -31,7 +26,6 @@ namespace Sif.Framework.Model.Settings
     /// </summary>
     abstract class ConfigFileBasedFrameworkSettings : IFrameworkSettings
     {
-        private static readonly ILog log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
         private Configuration configuration;
 
         /// <summary>
@@ -171,6 +165,19 @@ public string AuthenticationMethod
 
         }
 
+        /// <summary>
+        /// <see cref="Sif.Framework.Model.Settings.IFrameworkSettings.CompressPayload"/>
+        /// </summary>
+        public bool CompressPayload
+        {
+
+            get
+            {
+                return GetBooleanSetting(SettingsPrefix + ".payload.compress", false);
+            }
+
+        }
+
         /// <summary>
         /// <see cref="Sif.Framework.Model.Settings.IFrameworkSettings.ConsumerName"/>
         /// </summary>

Code/Sif3Framework/Sif.Framework/Model/Settings/IFrameworkSettings.cs

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 Systemic Pty Ltd
+ * Copyright 2016 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.
@@ -35,6 +35,11 @@ public interface IFrameworkSettings
         /// </summary>
         string AuthenticationMethod { get; }
 
+        /// <summary>
+        /// Compress payload flag if it exists; false otherwise.
+        /// </summary>
+        bool CompressPayload { get; }
+
         /// <summary>
         /// Consumer name if it exists; null otherwise.
         /// </summary>

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

@@ -32,8 +32,8 @@
 // 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")]
 
 // Configure log4net using the .config file
 [assembly: log4net.Config.XmlConfigurator(Watch = true)]

Code/Sif3Framework/Sif.Framework/SifFramework.config

@@ -15,6 +15,7 @@
     <add key="consumer.environment.template.dataModelNamespace" value="http://www.sifassociation.org/uk/datamodel/2.0"/>
     <add key="consumer.environment.template.supportedInfrastructureVersion" value="3.2"/>
     <add key="consumer.paging.navigationPageSize" value="20"/>
+    <add key="consumer.payload.compress" value="false"/>
   </appSettings>
   <sifFramework>
     <consumer>

Code/Sif3Framework/Sif.Framework/Utils/HttpUtils.cs

@@ -70,6 +70,12 @@ private static HttpWebRequest CreateHttpWebRequest(RequestMethod requestMethod,
             request.Accept = "application/xml";
             request.Headers.Add("Authorization", authorisationToken);
 
+            if (SettingsManager.ConsumerSettings.CompressPayload)
+            {
+                request.AutomaticDecompression = DecompressionMethods.GZip | DecompressionMethods.Deflate;
+                request.Headers.Add(HttpRequestHeader.AcceptEncoding, "gzip,deflate");
+            }
+
             if (navigationPage.HasValue)
             {
                 request.Headers.Add("navigationPage", navigationPage.Value.ToString());

Code/Sif3FrameworkDemo/Sif.Framework.Demo.Au.Consumer/SifFramework.config

@@ -17,6 +17,7 @@
     <add key="consumer.environment.template.solutionId" value="Sif3Framework"/>
     <add key="consumer.environment.template.supportedInfrastructureVersion" value="3.2"/>
     <add key="consumer.paging.navigationPageSize" value="5"/>
+    <add key="consumer.payload.compress" value="false"/>
   </appSettings>
   <sifFramework>
     <consumer>

Code/Sif3FrameworkDemo/Sif.Framework.Demo.Hits.Consumer/SifFramework.config

@@ -18,6 +18,7 @@
     <add key="consumer.environment.template.supportedInfrastructureVersion" value="3.1"/>
     <add key="consumer.environment.template.userToken" value="6dd11373-95fd-44d0-84b5-f6a238d78a6a"/>
     <add key="consumer.paging.navigationPageSize" value="5"/>
+    <add key="consumer.payload.compress" value="false"/>
   </appSettings>
   <sifFramework>
     <consumer>

Code/Sif3FrameworkDemo/Sif.Framework.Demo.Uk.Consumer/SifFramework.config

@@ -6,7 +6,6 @@
     </sectionGroup>
   </configSections>
   <appSettings>
-
     <!-- Settings used to register this Consumer with the Sif3Framework EnvironmentProvider. -->
     <add key="consumer.environmentType" value="DIRECT"/>
     <add key="consumer.environment.deleteOnUnregister" value="true"/>
@@ -16,9 +15,10 @@
     <add key="consumer.environment.template.authenticationMethod" value="Basic"/>
     <add key="consumer.environment.template.consumerName" value="Sif3DemoApp"/>
     <add key="consumer.environment.template.dataModelNamespace" value="http://www.sifassociation.org/uk/datamodel/2.0"/>
+    <add key="consumer.environment.template.solutionId" value="Sif3Framework"/>
     <add key="consumer.environment.template.supportedInfrastructureVersion" value="3.2"/>
     <add key="consumer.paging.navigationPageSize" value="5"/>
-    
+    <add key="consumer.payload.compress" value="false"/>
     <add key="consumer.events.supported" value="true"/>
   </appSettings>
   <sifFramework>

Code/Sif3FrameworkDemo/Sif.Framework.Demo.Us.Consumer/SifFramework.config

@@ -6,15 +6,18 @@
     </sectionGroup>
   </configSections>
   <appSettings>
+    <!-- Settings used to register this Consumer with the Sif3Framework EnvironmentProvider. -->
     <add key="consumer.environment.deleteOnUnregister" value="true"/>
     <add key="consumer.environment.sharedSecret" value="SecretDem0"/>
     <add key="consumer.environment.url" value="http://localhost:62921/api/environments/environment"/>
     <add key="consumer.environment.template.applicationKey" value="Sif3UsDemoApp"/>
     <add key="consumer.environment.template.authenticationMethod" value="Basic"/>
     <add key="consumer.environment.template.consumerName" value="Sif3UsDemoK12StudentConsumer"/>
     <add key="consumer.environment.template.dataModelNamespace" value="http://www.sifassociation.org/datamodel/na/3.2"/>
-    <add key="consumer.environment.template.supportedInfrastructureVersion" value="3.0.1"/>
+    <add key="consumer.environment.template.solutionId" value="Sif3Framework"/>
+    <add key="consumer.environment.template.supportedInfrastructureVersion" value="3.2"/>
     <add key="consumer.paging.navigationPageSize" value="5"/>
+    <add key="consumer.payload.compress" value="false"/>
   </appSettings>
   <sifFramework>
     <consumer>