120 lines
4.0 KiB
C#
120 lines
4.0 KiB
C#
// Copyright (c) .NET Foundation. All rights reserved.
|
|
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
|
|
|
|
using System.IO;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace Microsoft.AspNet.Http
|
|
{
|
|
/// <summary>
|
|
/// Represents the incoming side of an individual HTTP request.
|
|
/// </summary>
|
|
public abstract class HttpRequest
|
|
{
|
|
/// <summary>
|
|
/// Gets the <see cref="HttpContext"/> this request;
|
|
/// </summary>
|
|
public abstract HttpContext HttpContext { get; }
|
|
|
|
/// <summary>
|
|
/// Gets or set the HTTP method.
|
|
/// </summary>
|
|
/// <returns>The HTTP method.</returns>
|
|
public abstract string Method { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or set the HTTP request scheme.
|
|
/// </summary>
|
|
/// <returns>The HTTP request scheme.</returns>
|
|
public abstract string Scheme { get; set; }
|
|
|
|
/// <summary>
|
|
/// Returns true if the RequestScheme is https.
|
|
/// </summary>
|
|
/// <returns>true if this request is using https; otherwise, false.</returns>
|
|
public abstract bool IsHttps { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or set the Host header. May include the port.
|
|
/// </summary>
|
|
/// <return>The Host header.</return>
|
|
public abstract HostString Host { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or set the RequestPathBase.
|
|
/// </summary>
|
|
/// <returns>The RequestPathBase.</returns>
|
|
public abstract PathString PathBase { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or set the request path from RequestPath.
|
|
/// </summary>
|
|
/// <returns>The request path from RequestPath.</returns>
|
|
public abstract PathString Path { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or set the query string.
|
|
/// </summary>
|
|
/// <returns>The query string.</returns>
|
|
public abstract QueryString QueryString { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets the query value collection parsed from RequestQueryString.
|
|
/// </summary>
|
|
/// <returns>The query value collection parsed from RequestQueryString.</returns>
|
|
public abstract IQueryCollection Query { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or set the RequestProtocol.
|
|
/// </summary>
|
|
/// <returns>The RequestProtocol.</returns>
|
|
public abstract string Protocol { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets the request headers.
|
|
/// </summary>
|
|
/// <returns>The request headers.</returns>
|
|
public abstract IHeaderDictionary Headers { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the collection of Cookies for this request.
|
|
/// </summary>
|
|
/// <returns>The collection of Cookies for this request.</returns>
|
|
public abstract IRequestCookieCollection Cookies { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the Content-Length header
|
|
/// </summary>
|
|
public abstract long? ContentLength { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the Content-Type header.
|
|
/// </summary>
|
|
/// <returns>The Content-Type header.</returns>
|
|
public abstract string ContentType { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or set the RequestBody Stream.
|
|
/// </summary>
|
|
/// <returns>The RequestBody Stream.</returns>
|
|
public abstract Stream Body { get; set; }
|
|
|
|
/// <summary>
|
|
/// Checks the content-type header for form types.
|
|
/// </summary>
|
|
public abstract bool HasFormContentType { get; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the request body as a form.
|
|
/// </summary>
|
|
public abstract IFormCollection Form { get; set; }
|
|
|
|
/// <summary>
|
|
/// Reads the request body if it is a form.
|
|
/// </summary>
|
|
/// <returns></returns>
|
|
public abstract Task<IFormCollection> ReadFormAsync(CancellationToken cancellationToken = new CancellationToken());
|
|
}
|
|
}
|