HttpResponseMessageProperty.cs 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415
  1. //----------------------------------------------------------------------------
  2. // Copyright (c) Microsoft Corporation. All rights reserved.
  3. //----------------------------------------------------------------------------
  4. namespace System.ServiceModel.Channels
  5. {
  6. using System;
  7. using System.Collections.Generic;
  8. using System.Net;
  9. using System.Net.Http;
  10. using System.Net.Http.Headers;
  11. using System.Runtime;
  12. public sealed class HttpResponseMessageProperty : IMessageProperty, IMergeEnabledMessageProperty
  13. {
  14. TraditionalHttpResponseMessageProperty traditionalProperty;
  15. HttpResponseMessageBackedProperty httpBackedProperty;
  16. bool useHttpBackedProperty;
  17. bool initialCopyPerformed;
  18. public HttpResponseMessageProperty()
  19. : this((WebHeaderCollection)null)
  20. {
  21. }
  22. internal HttpResponseMessageProperty(WebHeaderCollection originalHeaders)
  23. {
  24. this.traditionalProperty = new TraditionalHttpResponseMessageProperty(originalHeaders);
  25. this.useHttpBackedProperty = false;
  26. }
  27. internal HttpResponseMessageProperty(HttpResponseMessage httpResponseMessage)
  28. {
  29. this.httpBackedProperty = new HttpResponseMessageBackedProperty(httpResponseMessage);
  30. this.useHttpBackedProperty = true;
  31. }
  32. public static string Name
  33. {
  34. get { return "httpResponse"; }
  35. }
  36. public WebHeaderCollection Headers
  37. {
  38. get
  39. {
  40. return this.useHttpBackedProperty ?
  41. this.httpBackedProperty.Headers :
  42. this.traditionalProperty.Headers;
  43. }
  44. }
  45. public HttpStatusCode StatusCode
  46. {
  47. get
  48. {
  49. return this.useHttpBackedProperty ?
  50. this.httpBackedProperty.StatusCode :
  51. this.traditionalProperty.StatusCode;
  52. }
  53. set
  54. {
  55. int valueInt = (int)value;
  56. if (valueInt < 100 || valueInt > 599)
  57. {
  58. throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new ArgumentOutOfRangeException("value", value,
  59. SR.GetString(SR.ValueMustBeInRange, 100, 599)));
  60. }
  61. if (this.useHttpBackedProperty)
  62. {
  63. this.httpBackedProperty.StatusCode = value;
  64. }
  65. else
  66. {
  67. this.traditionalProperty.StatusCode = value;
  68. }
  69. }
  70. }
  71. internal bool HasStatusCodeBeenSet
  72. {
  73. get
  74. {
  75. return this.useHttpBackedProperty ?
  76. true :
  77. this.traditionalProperty.HasStatusCodeBeenSet;
  78. }
  79. }
  80. public string StatusDescription
  81. {
  82. get
  83. {
  84. return this.useHttpBackedProperty ?
  85. this.httpBackedProperty.StatusDescription :
  86. this.traditionalProperty.StatusDescription;
  87. }
  88. set
  89. {
  90. if (this.useHttpBackedProperty)
  91. {
  92. this.httpBackedProperty.StatusDescription = value;
  93. }
  94. else
  95. {
  96. this.traditionalProperty.StatusDescription = value;
  97. }
  98. }
  99. }
  100. public bool SuppressEntityBody
  101. {
  102. get
  103. {
  104. return this.useHttpBackedProperty ?
  105. this.httpBackedProperty.SuppressEntityBody :
  106. this.traditionalProperty.SuppressEntityBody;
  107. }
  108. set
  109. {
  110. if (this.useHttpBackedProperty)
  111. {
  112. this.httpBackedProperty.SuppressEntityBody = value;
  113. }
  114. else
  115. {
  116. this.traditionalProperty.SuppressEntityBody = value;
  117. }
  118. }
  119. }
  120. public bool SuppressPreamble
  121. {
  122. get
  123. {
  124. return this.useHttpBackedProperty ?
  125. false :
  126. this.traditionalProperty.SuppressPreamble;
  127. }
  128. set
  129. {
  130. if (!this.useHttpBackedProperty)
  131. {
  132. this.traditionalProperty.SuppressPreamble = value;
  133. }
  134. }
  135. }
  136. private HttpResponseMessage HttpResponseMessage
  137. {
  138. get
  139. {
  140. if (this.useHttpBackedProperty)
  141. {
  142. return this.httpBackedProperty.HttpResponseMessage;
  143. }
  144. return null;
  145. }
  146. }
  147. internal static HttpResponseMessage GetHttpResponseMessageFromMessage(Message message)
  148. {
  149. HttpResponseMessage httpResponseMessage = null;
  150. HttpResponseMessageProperty property = message.Properties.GetValue<HttpResponseMessageProperty>(HttpResponseMessageProperty.Name);
  151. if (property != null)
  152. {
  153. httpResponseMessage = property.HttpResponseMessage;
  154. if (httpResponseMessage != null)
  155. {
  156. httpResponseMessage.CopyPropertiesFromMessage(message);
  157. message.EnsureReadMessageState();
  158. }
  159. }
  160. return httpResponseMessage;
  161. }
  162. IMessageProperty IMessageProperty.CreateCopy()
  163. {
  164. if (!this.useHttpBackedProperty ||
  165. !this.initialCopyPerformed)
  166. {
  167. this.initialCopyPerformed = true;
  168. return this;
  169. }
  170. return this.httpBackedProperty.CreateTraditionalResponseMessageProperty();
  171. }
  172. bool IMergeEnabledMessageProperty.TryMergeWithProperty(object propertyToMerge)
  173. {
  174. // The ImmutableDispatchRuntime will merge MessageProperty instances from the
  175. // OperationContext (that were created before the response message was created) with
  176. // MessageProperty instances on the message itself. The message's version of the
  177. // HttpResponseMessageProperty may hold a reference to an HttpResponseMessage, and this
  178. // cannot be discarded, so values from the OperationContext's property must be set on
  179. // the message's version without completely replacing the message's property.
  180. if (this.useHttpBackedProperty)
  181. {
  182. HttpResponseMessageProperty responseProperty = propertyToMerge as HttpResponseMessageProperty;
  183. if (responseProperty != null)
  184. {
  185. if (!responseProperty.useHttpBackedProperty)
  186. {
  187. this.httpBackedProperty.MergeWithTraditionalProperty(responseProperty.traditionalProperty);
  188. responseProperty.traditionalProperty = null;
  189. responseProperty.httpBackedProperty = this.httpBackedProperty;
  190. responseProperty.useHttpBackedProperty = true;
  191. }
  192. return true;
  193. }
  194. }
  195. return false;
  196. }
  197. private class TraditionalHttpResponseMessageProperty
  198. {
  199. public const HttpStatusCode DefaultStatusCode = HttpStatusCode.OK;
  200. public const string DefaultStatusDescription = null; // null means use description from status code
  201. WebHeaderCollection headers;
  202. WebHeaderCollection originalHeaders;
  203. HttpStatusCode statusCode;
  204. public TraditionalHttpResponseMessageProperty(WebHeaderCollection originalHeaders)
  205. {
  206. this.originalHeaders = originalHeaders;
  207. this.statusCode = DefaultStatusCode;
  208. this.StatusDescription = DefaultStatusDescription;
  209. }
  210. public WebHeaderCollection Headers
  211. {
  212. get
  213. {
  214. if (this.headers == null)
  215. {
  216. this.headers = new WebHeaderCollection();
  217. if (this.originalHeaders != null)
  218. {
  219. this.headers.Add(originalHeaders);
  220. this.originalHeaders = null;
  221. }
  222. }
  223. return this.headers;
  224. }
  225. }
  226. public HttpStatusCode StatusCode
  227. {
  228. get
  229. {
  230. return this.statusCode;
  231. }
  232. set
  233. {
  234. this.statusCode = value;
  235. this.HasStatusCodeBeenSet = true;
  236. }
  237. }
  238. public bool HasStatusCodeBeenSet { get; private set; }
  239. public string StatusDescription { get; set; }
  240. public bool SuppressEntityBody { get; set; }
  241. public bool SuppressPreamble { get; set; }
  242. }
  243. private class HttpResponseMessageBackedProperty
  244. {
  245. private HttpHeadersWebHeaderCollection headers;
  246. public HttpResponseMessageBackedProperty(HttpResponseMessage httpResponseMessage)
  247. {
  248. Fx.Assert(httpResponseMessage != null, "The 'httpResponseMessage' property should never be null.");
  249. this.HttpResponseMessage = httpResponseMessage;
  250. }
  251. public HttpResponseMessage HttpResponseMessage { get; private set; }
  252. public WebHeaderCollection Headers
  253. {
  254. get
  255. {
  256. if (this.headers == null)
  257. {
  258. this.headers = new HttpHeadersWebHeaderCollection(this.HttpResponseMessage);
  259. }
  260. return this.headers;
  261. }
  262. }
  263. public HttpStatusCode StatusCode
  264. {
  265. get
  266. {
  267. return this.HttpResponseMessage.StatusCode;
  268. }
  269. set
  270. {
  271. this.HttpResponseMessage.StatusCode = value;
  272. }
  273. }
  274. public string StatusDescription
  275. {
  276. get
  277. {
  278. return this.HttpResponseMessage.ReasonPhrase;
  279. }
  280. set
  281. {
  282. this.HttpResponseMessage.ReasonPhrase = value;
  283. }
  284. }
  285. public bool SuppressEntityBody
  286. {
  287. get
  288. {
  289. HttpContent content = this.HttpResponseMessage.Content;
  290. if (content != null)
  291. {
  292. long? contentLength = content.Headers.ContentLength;
  293. if (!contentLength.HasValue ||
  294. (contentLength.HasValue && contentLength.Value > 0))
  295. {
  296. return false;
  297. }
  298. }
  299. return true;
  300. }
  301. set
  302. {
  303. HttpContent content = this.HttpResponseMessage.Content;
  304. if (value && content != null &&
  305. (!content.Headers.ContentLength.HasValue ||
  306. content.Headers.ContentLength.Value > 0))
  307. {
  308. HttpContent newContent = new ByteArrayContent(EmptyArray<byte>.Instance);
  309. foreach (KeyValuePair<string, IEnumerable<string>> header in content.Headers)
  310. {
  311. newContent.Headers.AddHeaderWithoutValidation(header);
  312. }
  313. this.HttpResponseMessage.Content = newContent;
  314. content.Dispose();
  315. }
  316. else if (!value && content == null)
  317. {
  318. this.HttpResponseMessage.Content = new ByteArrayContent(EmptyArray<byte>.Instance);
  319. }
  320. }
  321. }
  322. public HttpResponseMessageProperty CreateTraditionalResponseMessageProperty()
  323. {
  324. HttpResponseMessageProperty copiedProperty = new HttpResponseMessageProperty();
  325. copiedProperty.Headers.Add(this.Headers);
  326. if (this.StatusCode != TraditionalHttpResponseMessageProperty.DefaultStatusCode)
  327. {
  328. copiedProperty.StatusCode = this.StatusCode;
  329. }
  330. copiedProperty.StatusDescription = this.StatusDescription;
  331. copiedProperty.SuppressEntityBody = this.SuppressEntityBody;
  332. return copiedProperty;
  333. }
  334. public void MergeWithTraditionalProperty(TraditionalHttpResponseMessageProperty propertyToMerge)
  335. {
  336. if (propertyToMerge.HasStatusCodeBeenSet)
  337. {
  338. this.StatusCode = propertyToMerge.StatusCode;
  339. }
  340. if (propertyToMerge.StatusDescription != TraditionalHttpResponseMessageProperty.DefaultStatusDescription)
  341. {
  342. this.StatusDescription = propertyToMerge.StatusDescription;
  343. }
  344. this.SuppressEntityBody = propertyToMerge.SuppressEntityBody;
  345. WebHeaderCollection headersToMerge = propertyToMerge.Headers;
  346. foreach (string headerKey in headersToMerge.AllKeys)
  347. {
  348. this.Headers[headerKey] = headersToMerge[headerKey];
  349. }
  350. }
  351. }
  352. }
  353. }