IRequest.cs

//Copyright (c) ServiceStack, Inc. All Rights Reserved.
//License: https://raw.github.com/ServiceStack/ServiceStack/master/license.txt

using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.IO;
using System.Threading.Tasks;
using ServiceStack.Configuration;

namespace ServiceStack.Web
{
    /// <summary>
    /// A thin wrapper around each host's Request e.g: ASP.NET, HttpListener, MQ, etc
    /// </summary>
    public interface IRequest : IResolver
    {
        /// <summary>
        /// The underlying ASP.NET or HttpListener HttpRequest
        /// </summary>
        object OriginalRequest { get; }

        /// <summary>
        /// The Response API for this Request
        /// </summary>
        IResponse Response { get; }

        /// <summary>
        /// The name of the service being called (e.g. Request DTO Name)
        /// </summary>
        string OperationName { get; set; }

        /// <summary>
        /// The Verb / HttpMethod or Action for this request
        /// </summary>
        string Verb { get; }

        /// <summary>
        /// Different Attribute Enum flags classifying this Request
        /// </summary>
        RequestAttributes RequestAttributes { get; set; }

        /// <summary>
        /// Optional preferences for the processing of this Request
        /// </summary>
        IRequestPreferences RequestPreferences { get; }

        /// <summary>
        /// The Request DTO, after it has been deserialized.
        /// </summary>
        object Dto { get; set; }

        /// <summary>
        /// The request ContentType
        /// </summary>
        string ContentType { get; }

        /// <summary>
        /// Whether this was an Internal Request
        /// </summary>
        bool IsLocal { get; }

        /// <summary>
        /// The UserAgent for the request
        /// </summary>
        string UserAgent { get; }

        /// <summary>
        /// A Dictionary of HTTP Cookies sent with this Request
        /// </summary>
        IDictionary<string, System.Net.Cookie> Cookies { get; }

        /// <summary>
        /// The expected Response ContentType for this request
        /// </summary>
        string ResponseContentType { get; set; }

        /// <summary>
        /// Whether the ResponseContentType has been explicitly overridden or whether it was just the default
        /// </summary>
        bool HasExplicitResponseContentType { get; }

        /// <summary>
        /// Attach any data to this request that all filters and services can access.
        /// </summary>
        Dictionary<string, object> Items { get; }

        /// <summary>
        /// The HTTP Headers in a NameValueCollection
        /// </summary>
        NameValueCollection Headers { get; }

        /// <summary>
        /// The ?query=string in a NameValueCollection
        /// </summary>
        NameValueCollection QueryString { get; }

        /// <summary>
        /// The HTTP POST'ed Form Data in a NameValueCollection
        /// </summary>
        NameValueCollection FormData { get; }
        /// <summary>
        /// Buffer the Request InputStream so it can be re-read
        /// </summary>
        bool UseBufferedStream { get; set; }

        /// <summary>
        /// The entire string contents of Request.InputStream
        /// </summary>
        /// <returns></returns>
        string GetRawBody();

        /// <summary>
        /// The entire string contents of Request.InputStream async
        /// </summary>
        /// <returns></returns>
        Task<string> GetRawBodyAsync();

        /// <summary>
        /// Relative URL containing /path/info?query=string
        /// </summary>
        string RawUrl { get; }

        /// <summary>
        /// The Absolute URL for the request
        /// </summary>
        string AbsoluteUri { get; }

        /// <summary>
        /// The Remote IP as reported by Request.UserHostAddress
        /// </summary>
        string UserHostAddress { get; }

        /// <summary>
        /// The Remote Ip as reported by X-Forwarded-For, X-Real-IP or Request.UserHostAddress
        /// </summary>
        string RemoteIp { get; }

        /// <summary>
        /// The value of the Authorization Header used to send the Api Key, null if not available
        /// </summary>
        string Authorization { get; }

        /// <summary>
        /// e.g. is https or not
        /// </summary>
        bool IsSecureConnection { get; }

        /// <summary>
        /// Array of different Content-Types accepted by the client
        /// </summary>
        string[] AcceptTypes { get; }

        /// <summary>
        /// The normalized /path/info for the request
        /// </summary>
        string PathInfo { get; }

        /// <summary>
        /// The original /path/info as sent
        /// </summary>
        string OriginalPathInfo { get; }

        /// <summary>
        /// The Request Body Input Stream
        /// </summary>
        Stream InputStream { get; }

        /// <summary>
        /// The size of the Request Body if provided
        /// </summary>
        long ContentLength { get; }

        /// <summary>
        /// Access to the multi-part/formdata files posted on this request
        /// </summary>
        IHttpFile[] Files { get; }

        /// <summary>
        /// The value of the Referrer, null if not available
        /// </summary>
        Uri UrlReferrer { get; }
    }
}