From e2dcddc5ac43846baea0f9b1a0fc62844dd9ee1d Mon Sep 17 00:00:00 2001
From: Luke Pulverenti <luke.pulverenti@gmail.com>
Date: Sat, 23 Mar 2013 22:45:00 -0400
Subject: made compression and caching available to plugin api endpoints

---
 MediaBrowser.Common/Net/IHasResultFactory.cs  | 17 +++++
 MediaBrowser.Common/Net/IHttpResultFactory.cs | 92 ++++++++++++++++++++++++++-
 MediaBrowser.Common/Net/IRestfulService.cs    |  9 +--
 MediaBrowser.Common/Net/RouteInfo.cs          | 28 --------
 4 files changed, 109 insertions(+), 37 deletions(-)
 create mode 100644 MediaBrowser.Common/Net/IHasResultFactory.cs
 delete mode 100644 MediaBrowser.Common/Net/RouteInfo.cs

(limited to 'MediaBrowser.Common/Net')

diff --git a/MediaBrowser.Common/Net/IHasResultFactory.cs b/MediaBrowser.Common/Net/IHasResultFactory.cs
new file mode 100644
index 0000000000..d9da0c7e4e
--- /dev/null
+++ b/MediaBrowser.Common/Net/IHasResultFactory.cs
@@ -0,0 +1,17 @@
+using ServiceStack.ServiceHost;
+
+namespace MediaBrowser.Common.Net
+{
+    /// <summary>
+    /// Interface IHasResultFactory
+    /// Services that require a ResultFactory should implement this
+    /// </summary>
+    public interface IHasResultFactory : IRequiresRequestContext
+    {
+        /// <summary>
+        /// Gets or sets the result factory.
+        /// </summary>
+        /// <value>The result factory.</value>
+        IHttpResultFactory ResultFactory { get; set; }
+    }
+}
diff --git a/MediaBrowser.Common/Net/IHttpResultFactory.cs b/MediaBrowser.Common/Net/IHttpResultFactory.cs
index 565a2dce9c..55c0e5b9b3 100644
--- a/MediaBrowser.Common/Net/IHttpResultFactory.cs
+++ b/MediaBrowser.Common/Net/IHttpResultFactory.cs
@@ -1,9 +1,97 @@
-using System.IO;
+using ServiceStack.ServiceHost;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Threading.Tasks;
 
 namespace MediaBrowser.Common.Net
 {
+    /// <summary>
+    /// Interface IHttpResultFactory
+    /// </summary>
     public interface IHttpResultFactory
     {
-        object GetResult(Stream stream, string contentType);
+        /// <summary>
+        /// Throws the error.
+        /// </summary>
+        /// <param name="statusCode">The status code.</param>
+        /// <param name="errorMessage">The error message.</param>
+        /// <param name="responseHeaders">The response headers.</param>
+        void ThrowError(int statusCode, string errorMessage, IDictionary<string, string> responseHeaders = null);
+        
+        /// <summary>
+        /// Gets the result.
+        /// </summary>
+        /// <param name="content">The content.</param>
+        /// <param name="contentType">Type of the content.</param>
+        /// <param name="responseHeaders">The response headers.</param>
+        /// <returns>System.Object.</returns>
+        object GetResult(object content, string contentType, IDictionary<string,string> responseHeaders = null);
+
+        /// <summary>
+        /// Gets the optimized result.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="requestContext">The request context.</param>
+        /// <param name="result">The result.</param>
+        /// <param name="responseHeaders">The response headers.</param>
+        /// <returns>System.Object.</returns>
+        object GetOptimizedResult<T>(IRequestContext requestContext, T result, IDictionary<string, string> responseHeaders = null)
+            where T : class;
+
+        /// <summary>
+        /// Gets the optimized result using cache.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="requestContext">The request context.</param>
+        /// <param name="cacheKey">The cache key.</param>
+        /// <param name="lastDateModified">The last date modified.</param>
+        /// <param name="cacheDuration">Duration of the cache.</param>
+        /// <param name="factoryFn">The factory function that creates the response object.</param>
+        /// <param name="responseHeaders">The response headers.</param>
+        /// <returns>System.Object.</returns>
+        object GetOptimizedResultUsingCache<T>(IRequestContext requestContext, Guid cacheKey, DateTime lastDateModified, TimeSpan? cacheDuration, Func<T> factoryFn, IDictionary<string, string> responseHeaders = null)
+            where T : class;
+
+        /// <summary>
+        /// Gets the cached result.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <param name="requestContext">The request context.</param>
+        /// <param name="cacheKey">The cache key.</param>
+        /// <param name="lastDateModified">The last date modified.</param>
+        /// <param name="cacheDuration">Duration of the cache.</param>
+        /// <param name="factoryFn">The factory fn.</param>
+        /// <param name="contentType">Type of the content.</param>
+        /// <param name="responseHeaders">The response headers.</param>
+        /// <returns>System.Object.</returns>
+        object GetCachedResult<T>(IRequestContext requestContext, Guid cacheKey, DateTime lastDateModified, TimeSpan? cacheDuration, Func<T> factoryFn, string contentType, IDictionary<string, string> responseHeaders = null)
+            where T : class;
+
+        /// <summary>
+        /// Gets the static result.
+        /// </summary>
+        /// <param name="requestContext">The request context.</param>
+        /// <param name="cacheKey">The cache key.</param>
+        /// <param name="lastDateModified">The last date modified.</param>
+        /// <param name="cacheDuration">Duration of the cache.</param>
+        /// <param name="contentType">Type of the content.</param>
+        /// <param name="factoryFn">The factory fn.</param>
+        /// <param name="responseHeaders">The response headers.</param>
+        /// <param name="isHeadRequest">if set to <c>true</c> [is head request].</param>
+        /// <returns>System.Object.</returns>
+        object GetStaticResult(IRequestContext requestContext, Guid cacheKey, DateTime? lastDateModified,
+                               TimeSpan? cacheDuration, string contentType, Func<Task<Stream>> factoryFn,
+                               IDictionary<string, string> responseHeaders = null, bool isHeadRequest = false);
+
+        /// <summary>
+        /// Gets the static file result.
+        /// </summary>
+        /// <param name="requestContext">The request context.</param>
+        /// <param name="path">The path.</param>
+        /// <param name="responseHeaders">The response headers.</param>
+        /// <param name="isHeadRequest">if set to <c>true</c> [is head request].</param>
+        /// <returns>System.Object.</returns>
+        object GetStaticFileResult(IRequestContext requestContext, string path, IDictionary<string, string> responseHeaders = null, bool isHeadRequest = false);
     }
 }
diff --git a/MediaBrowser.Common/Net/IRestfulService.cs b/MediaBrowser.Common/Net/IRestfulService.cs
index 9f37676450..7a1b267951 100644
--- a/MediaBrowser.Common/Net/IRestfulService.cs
+++ b/MediaBrowser.Common/Net/IRestfulService.cs
@@ -1,16 +1,11 @@
-using System.Collections.Generic;
+using ServiceStack.ServiceHost;
 
 namespace MediaBrowser.Common.Net
 {
     /// <summary>
     /// Interface IRestfulService
     /// </summary>
-    public interface IRestfulService
+    public interface IRestfulService : IService
     {
-        /// <summary>
-        /// Gets the routes.
-        /// </summary>
-        /// <returns>IEnumerable{RouteInfo}.</returns>
-        IEnumerable<RouteInfo> GetRoutes();
     }
 }
diff --git a/MediaBrowser.Common/Net/RouteInfo.cs b/MediaBrowser.Common/Net/RouteInfo.cs
deleted file mode 100644
index 379aff9c5e..0000000000
--- a/MediaBrowser.Common/Net/RouteInfo.cs
+++ /dev/null
@@ -1,28 +0,0 @@
-using System;
-
-namespace MediaBrowser.Common.Net
-{
-    /// <summary>
-    /// Class RouteInfo
-    /// </summary>
-    public class RouteInfo
-    {
-        /// <summary>
-        /// Gets or sets the path.
-        /// </summary>
-        /// <value>The path.</value>
-        public string Path { get; set; }
-
-        /// <summary>
-        /// Gets or sets the verbs.
-        /// </summary>
-        /// <value>The verbs.</value>
-        public string Verbs { get; set; }
-
-        /// <summary>
-        /// Gets or sets the type of the request.
-        /// </summary>
-        /// <value>The type of the request.</value>
-        public Type RequestType { get; set; }
-    }
-}
-- 
cgit v1.2.3