src/DotNetOpenAuth/Messaging/IDirectSslWebRequestHandler.cs

   1 //-----------------------------------------------------------------------
   2 // <copyright file="IDirectSslWebRequestHandler.cs" company="Andrew Arnott">
   3 //     Copyright (c) Andrew Arnott. All rights reserved.
   4 // </copyright>
   5 //-----------------------------------------------------------------------
   6
   7 namespace DotNetOpenAuth.Messaging {
   8         using System.IO;
   9         using System.Net;
  10
  11         /// <summary>
  12         /// A contract for <see cref="HttpWebRequest"/> handling,
  13         /// with added support for SSL-only requests.
  14         /// </summary>
  15         public interface IDirectSslWebRequestHandler : IDirectWebRequestHandler {
  16                 /// <summary>
  17                 /// Prepares an <see cref="HttpWebRequest"/> that contains an POST entity for sending the entity.
  18                 /// </summary>
  19                 /// <param name="request">The <see cref="HttpWebRequest"/> that should contain the entity.</param>
  20                 /// <param name="requireSsl">if set to <c>true</c> all requests made with this instance must be completed using SSL.</param>
  21                 /// <returns>
  22                 /// The writer the caller should write out the entity data to.
  23                 /// </returns>
  24                 TextWriter GetRequestStream(HttpWebRequest request, bool requireSsl);
  25
  26                 /// <summary>
  27                 /// Processes an <see cref="HttpWebRequest"/> and converts the
  28                 /// <see cref="HttpWebResponse"/> to a <see cref="DirectWebResponse"/> instance.
  29                 /// </summary>
  30                 /// <param name="request">The <see cref="HttpWebRequest"/> to handle.</param>
  31                 /// <param name="requireSsl">if set to <c>true</c> all requests made with this instance must be completed using SSL.</param>
  32                 /// <returns>An instance of <see cref="DirectWebResponse"/> describing the response.</returns>
  33                 DirectWebResponse GetResponse(HttpWebRequest request, bool requireSsl);
  34         }
  35 }