You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2017/09/09 00:32:04 UTC
[46/50] [abbrv] lucenenet git commit: Initial ReplicatorService
guidelines (lacking the use of the replicator)
Initial ReplicatorService guidelines (lacking the use of the replicator)
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/cce39cc7
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/cce39cc7
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/cce39cc7
Branch: refs/heads/master
Commit: cce39cc75bfb6b2d0eb339701c7156dc3cd03748
Parents: 5f06fda
Author: Jens Melgaard <ad...@it-links.dk>
Authored: Thu Aug 24 11:39:54 2017 +0200
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Sat Sep 9 06:57:03 2017 +0700
----------------------------------------------------------------------
src/Lucene.Net.Replicator/Http/replicator.md | 111 +++++++++++++++++++
.../Lucene.Net.Replicator.csproj | 3 +
2 files changed, 114 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/cce39cc7/src/Lucene.Net.Replicator/Http/replicator.md
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Replicator/Http/replicator.md b/src/Lucene.Net.Replicator/Http/replicator.md
new file mode 100644
index 0000000..3e055cf
--- /dev/null
+++ b/src/Lucene.Net.Replicator/Http/replicator.md
@@ -0,0 +1,111 @@
+# Using the ReplicatorService
+
+Because therer are a number of different hosting frameworks to choose from on .NET, and that they don't implement common
+interfaceses or base classes for requests and responses, the ReplicatorService instead provides abstractions so that it can
+be integrated easily into any of these framworks.
+
+So to integrate the replicator into any existing hosting framworks, the IReplicationRequest and IReplicationResponse interfaces
+must be implemented for a choosen framwork.
+
+## An AspNetCore Implementation
+
+Below is an example of how these wrappers can be implemented for the AspNetCore framwork.
+The example only convers the absolutely minimum needed in order for it to become functional within AspNetCore.
+
+It does not go as far as to implement custom middleware, action results for controllers or anything else, while this
+would be a natural to do, such implementations extends beyond the scope of this document.
+
+#### AspNetCore Request Wrapper
+
+The first thing to do is to wrap the AspNetCore Request object in a class that implements the IReplicationRequest interface.
+This is very straight forward.
+
+```csharp
+// Wrapper class for the Microsoft.AspNetCore.Http.HttpRequest
+public class AspNetCoreReplicationRequest : IReplicationRequest
+{
+ private readonly HttpRequest request;
+
+ // Inject the actual request object in the constructor.
+ public AspNetCoreReplicationRequest(HttpRequest request)
+ => this.request = request;
+
+ // Provide the full path relative to the host.
+ // In the common case in AspNetCore this should just return the full path, so PathBase + Path are concatenated and returned.
+ //
+ // The path expected by the ReplicatorService is {context}/{shard}/{action} where:
+ // - action may be Obtain, Release or Update
+ // - context is the same context that is provided to the ReplicatorService constructor and defaults to '/replicate'
+ public string Path
+ => request.PathBase + request.Path;
+
+ // Return values for parameters used by the ReplicatorService
+ // The ReplicatorService will call this with:
+ // - version: The index revision
+ // - sessionid: The ID of the session
+ // - source: The source index for the files
+ // - filename: The file name
+ //
+ // In this implementation a exception is thrown in the case that parameters are provided multiple times.
+ public string QueryParam(string name)
+ => request.Query[name].SingleOrDefault();
+}
+```
+
+#### AspNetCore Response Wrapper
+
+Secondly the AspNetCore Response object is wrapped in a class that implements the IReplicationResponse interface.
+This is also very straight forward.
+
+```csharp
+// Wrapper class for the Microsoft.AspNetCore.Http.HttpResponse
+public class AspNetCoreReplicationResponse : IReplicationResponse
+{
+ private readonly HttpResponse response;
+
+ // Inject the actual response object in the constructor.
+ public AspNetCoreReplicationResponse(HttpResponse response)
+ => this.response = response;
+
+ // Getter and Setter for the http Status code, in case of failure the ReplicatorService will set this
+ // Property.
+ public int StatusCode
+ {
+ get => response.StatusCode;
+ set => response.StatusCode = value;
+ }
+
+ // Return a stream where the ReplicatorService can write to for the response.
+ // Depending on the action either the file or the sesssion token will be written to this stream.
+ public Stream Body => response.Body;
+
+ // Called when the ReplicatorService is done writing data to the response.
+ // Here it is mapped to the flush method on the "body" stream on the response.
+ public void Flush() => response.Body.Flush();
+}
+```
+
+#### AspNetCore Utility Extension Method
+
+This part is not nessesary, however by providing a extension method as a overload to the ReplicatorService Perform method
+that instead takes the AspNetCore HttpRequest and HttpResponse response objects, it's easier to call the ReplicatorService
+from either AspNetCore Mvc controllers, inside of middleare or for the absolute minimal solution directly in the delegate of
+a IApplicationBuilder.Run method.
+
+```csharp
+public static class AspNetCoreReplicationServiceExtentions
+{
+ // Optionally, provide a extension method for calling the perform method directly using the specific request
+ // and response objects from AspNetCore
+ public static void Perform(this ReplicationService self, HttpRequest request, HttpResponse response)
+ => self.Perform(
+ new AspNetCoreReplicationRequest(request),
+ new AspNetCoreReplicationResponse(response));
+}
+```
+
+## Using the Implementation
+
+Now the implementation can be used wihin AspNetCore in order to service Lucene Replicator requests over http.
+
+TODO: Finish.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/cce39cc7/src/Lucene.Net.Replicator/Lucene.Net.Replicator.csproj
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Replicator/Lucene.Net.Replicator.csproj b/src/Lucene.Net.Replicator/Lucene.Net.Replicator.csproj
index 976690f..dc34b3e 100644
--- a/src/Lucene.Net.Replicator/Lucene.Net.Replicator.csproj
+++ b/src/Lucene.Net.Replicator/Lucene.Net.Replicator.csproj
@@ -74,6 +74,9 @@
<Reference Include="System.Net.Http" />
<Reference Include="System" />
<Reference Include="Microsoft.CSharp" />
+ <ItemGroup>
+ <None Include="Http\replicator.md" />
+ <None Include="packages.config" />
</ItemGroup>
</Project>