diff options
author | Justin Clark-Casey (justincc) | 2011-12-05 20:44:20 +0000 |
---|---|---|
committer | Justin Clark-Casey (justincc) | 2011-12-05 20:44:20 +0000 |
commit | 4567555c49cb560dd6f109bbfec42086af3de56f (patch) | |
tree | bfb0a6fd21d2070940399c0e36dc7d0de1e7eb0d /OpenSim/Framework/Servers/HttpServer/Interfaces | |
parent | For the GetTexture capability, if a data range is requested that covers the w... (diff) | |
download | opensim-SC-4567555c49cb560dd6f109bbfec42086af3de56f.zip opensim-SC-4567555c49cb560dd6f109bbfec42086af3de56f.tar.gz opensim-SC-4567555c49cb560dd6f109bbfec42086af3de56f.tar.bz2 opensim-SC-4567555c49cb560dd6f109bbfec42086af3de56f.tar.xz |
Implement IOSHttpRequest and IOSHttpResponse http interfaces and use instead of OSHttpRequest/OSHttpResponse.
This is required for the substitution of different HTTP servers or the newer HttpServer.dll without having to commit to a particular implementation.
This is also required to write regression tests that involve the HTTP layer.
If you need to recompile, all you need to do is replace OSHttpRequest/OSHttpResponse references with IOSHttpRequest/IOSHttpResponse.
Diffstat (limited to 'OpenSim/Framework/Servers/HttpServer/Interfaces')
3 files changed, 199 insertions, 2 deletions
diff --git a/OpenSim/Framework/Servers/HttpServer/Interfaces/IOSHttpRequest.cs b/OpenSim/Framework/Servers/HttpServer/Interfaces/IOSHttpRequest.cs new file mode 100644 index 0000000..caf0edd --- /dev/null +++ b/OpenSim/Framework/Servers/HttpServer/Interfaces/IOSHttpRequest.cs | |||
@@ -0,0 +1,59 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSimulator Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using System.Collections; | ||
30 | using System.Collections.Specialized; | ||
31 | using System.IO; | ||
32 | using System.Net; | ||
33 | using System.Text; | ||
34 | using System.Web; | ||
35 | |||
36 | namespace OpenSim.Framework.Servers.HttpServer | ||
37 | { | ||
38 | public interface IOSHttpRequest | ||
39 | { | ||
40 | string[] AcceptTypes { get; } | ||
41 | Encoding ContentEncoding { get; } | ||
42 | long ContentLength { get; } | ||
43 | long ContentLength64 { get; } | ||
44 | string ContentType { get; } | ||
45 | HttpCookieCollection Cookies { get; } | ||
46 | bool HasEntityBody { get; } | ||
47 | NameValueCollection Headers { get; } | ||
48 | string HttpMethod { get; } | ||
49 | Stream InputStream { get; } | ||
50 | bool IsSecured { get; } | ||
51 | bool KeepAlive { get; } | ||
52 | NameValueCollection QueryString { get; } | ||
53 | Hashtable Query { get; } | ||
54 | string RawUrl { get; } | ||
55 | IPEndPoint RemoteIPEndPoint { get; } | ||
56 | Uri Url { get; } | ||
57 | string UserAgent { get; } | ||
58 | } | ||
59 | } \ No newline at end of file | ||
diff --git a/OpenSim/Framework/Servers/HttpServer/Interfaces/IOSHttpResponse.cs b/OpenSim/Framework/Servers/HttpServer/Interfaces/IOSHttpResponse.cs new file mode 100644 index 0000000..33a1663 --- /dev/null +++ b/OpenSim/Framework/Servers/HttpServer/Interfaces/IOSHttpResponse.cs | |||
@@ -0,0 +1,138 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSimulator Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | using System.Collections; | ||
30 | using System.Collections.Specialized; | ||
31 | using System.IO; | ||
32 | using System.Net; | ||
33 | using System.Text; | ||
34 | using System.Web; | ||
35 | |||
36 | namespace OpenSim.Framework.Servers.HttpServer | ||
37 | { | ||
38 | public interface IOSHttpResponse | ||
39 | { | ||
40 | /// <summary> | ||
41 | /// Content type property. | ||
42 | /// </summary> | ||
43 | /// <remarks> | ||
44 | /// Setting this property will also set IsContentTypeSet to | ||
45 | /// true. | ||
46 | /// </remarks> | ||
47 | string ContentType { get; set; } | ||
48 | |||
49 | /// <summary> | ||
50 | /// Boolean property indicating whether the content type | ||
51 | /// property actively has been set. | ||
52 | /// </summary> | ||
53 | /// <remarks> | ||
54 | /// IsContentTypeSet will go away together with .NET base. | ||
55 | /// </remarks> | ||
56 | // public bool IsContentTypeSet | ||
57 | // { | ||
58 | // get { return _contentTypeSet; } | ||
59 | // } | ||
60 | // private bool _contentTypeSet; | ||
61 | |||
62 | /// <summary> | ||
63 | /// Length of the body content; 0 if there is no body. | ||
64 | /// </summary> | ||
65 | long ContentLength { get; set; } | ||
66 | |||
67 | /// <summary> | ||
68 | /// Alias for ContentLength. | ||
69 | /// </summary> | ||
70 | long ContentLength64 { get; set; } | ||
71 | |||
72 | /// <summary> | ||
73 | /// Encoding of the body content. | ||
74 | /// </summary> | ||
75 | Encoding ContentEncoding { get; set; } | ||
76 | |||
77 | bool KeepAlive { get; set; } | ||
78 | |||
79 | /// <summary> | ||
80 | /// Get or set the keep alive timeout property (default is | ||
81 | /// 20). Setting this to 0 also disables KeepAlive. Setting | ||
82 | /// this to something else but 0 also enable KeepAlive. | ||
83 | /// </summary> | ||
84 | int KeepAliveTimeout { get; set; } | ||
85 | |||
86 | /// <summary> | ||
87 | /// Return the output stream feeding the body. | ||
88 | /// </summary> | ||
89 | /// <remarks> | ||
90 | /// On its way out... | ||
91 | /// </remarks> | ||
92 | Stream OutputStream { get; } | ||
93 | |||
94 | string ProtocolVersion { get; set; } | ||
95 | |||
96 | /// <summary> | ||
97 | /// Return the output stream feeding the body. | ||
98 | /// </summary> | ||
99 | Stream Body { get; } | ||
100 | |||
101 | /// <summary> | ||
102 | /// Set a redirct location. | ||
103 | /// </summary> | ||
104 | string RedirectLocation { set; } | ||
105 | |||
106 | /// <summary> | ||
107 | /// Chunk transfers. | ||
108 | /// </summary> | ||
109 | bool SendChunked { get; set; } | ||
110 | |||
111 | /// <summary> | ||
112 | /// HTTP status code. | ||
113 | /// </summary> | ||
114 | int StatusCode { get; set; } | ||
115 | |||
116 | /// <summary> | ||
117 | /// HTTP status description. | ||
118 | /// </summary> | ||
119 | string StatusDescription { get; set; } | ||
120 | |||
121 | bool ReuseContext { get; set; } | ||
122 | |||
123 | /// <summary> | ||
124 | /// Add a header field and content to the response. | ||
125 | /// </summary> | ||
126 | /// <param name="key">string containing the header field | ||
127 | /// name</param> | ||
128 | /// <param name="value">string containing the header field | ||
129 | /// value</param> | ||
130 | void AddHeader(string key, string value); | ||
131 | |||
132 | /// <summary> | ||
133 | /// Send the response back to the remote client | ||
134 | /// </summary> | ||
135 | void Send(); | ||
136 | } | ||
137 | } | ||
138 | |||
diff --git a/OpenSim/Framework/Servers/HttpServer/Interfaces/IStreamHandler.cs b/OpenSim/Framework/Servers/HttpServer/Interfaces/IStreamHandler.cs index 2e1bc0b..a449c2d 100644 --- a/OpenSim/Framework/Servers/HttpServer/Interfaces/IStreamHandler.cs +++ b/OpenSim/Framework/Servers/HttpServer/Interfaces/IStreamHandler.cs | |||
@@ -45,13 +45,13 @@ namespace OpenSim.Framework.Servers.HttpServer | |||
45 | public interface IStreamedRequestHandler : IRequestHandler | 45 | public interface IStreamedRequestHandler : IRequestHandler |
46 | { | 46 | { |
47 | // Handle request stream, return byte array | 47 | // Handle request stream, return byte array |
48 | byte[] Handle(string path, Stream request, OSHttpRequest httpRequest, OSHttpResponse httpResponse); | 48 | byte[] Handle(string path, Stream request, IOSHttpRequest httpRequest, IOSHttpResponse httpResponse); |
49 | } | 49 | } |
50 | 50 | ||
51 | public interface IStreamHandler : IRequestHandler | 51 | public interface IStreamHandler : IRequestHandler |
52 | { | 52 | { |
53 | // Handle request stream, return byte array | 53 | // Handle request stream, return byte array |
54 | void Handle(string path, Stream request, Stream response, OSHttpRequest httpReqbuest, OSHttpResponse httpResponse); | 54 | void Handle(string path, Stream request, Stream response, IOSHttpRequest httpReqbuest, IOSHttpResponse httpResponse); |
55 | } | 55 | } |
56 | 56 | ||
57 | public interface IGenericHTTPHandler : IRequestHandler | 57 | public interface IGenericHTTPHandler : IRequestHandler |