HttpRequestExtensions

Assembly: ServiceStack.dll

View Source

Declaration

public static class HttpRequestExtensions

Methods

GetItemOrCookie(IRequest, String)

Gets string value from Items[name] then Cookies[name] if exists. Useful when first setting the users response cookie in the request filter. To access the value for this initial request you need to set it in Items[].

View Source

Declaration

public static string GetItemOrCookie(this IRequest httpReq, string name)

Returns

System.String: string value or null if it doesn't exist

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	name

GetParam(IRequest, String)

Gets request parameter string value by looking in the following order:

• QueryString[name]
• FormData[name]
• Cookies[name]
• Items[name]

View Source

Declaration

public static string GetParam(this IRequest httpReq, string name)

Returns

System.String: string value or null if it doesn't exist

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	name

GetQueryStringOrForm(IRequest, String)

View Source

Declaration

public static string GetQueryStringOrForm(this IRequest httpReq, string name)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	name

GetParentAbsolutePath(IRequest)

View Source

Declaration

public static string GetParentAbsolutePath(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetAbsolutePath(IRequest)

View Source

Declaration

public static string GetAbsolutePath(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetParentPathUrl(IRequest)

View Source

Declaration

public static string GetParentPathUrl(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetPathUrl(IRequest)

View Source

Declaration

public static string GetPathUrl(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetUrlHostName(IRequest)

View Source

Declaration

public static string GetUrlHostName(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetPhysicalPath(IRequest)

View Source

Declaration

public static string GetPhysicalPath(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetVirtualNode(IRequest)

View Source

Declaration

public static IVirtualNode GetVirtualNode(this IRequest httpReq)

Returns

ServiceStack.IO.IVirtualNode

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetDirectoryPath(IRequest)

View Source

Declaration

public static string GetDirectoryPath(this IRequest request)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	request

GetLeftAuthority(Uri)

View Source

Declaration

public static string GetLeftAuthority(this Uri uri)

Returns

System.String

Parameters

Type	Name
System.Uri	uri

GetApplicationUrl(IRequest)

View Source

Declaration

public static string GetApplicationUrl(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetHttpMethodOverride(IRequest)

View Source

Declaration

public static string GetHttpMethodOverride(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetFormatModifier(IRequest)

View Source

Declaration

public static string GetFormatModifier(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

HasNotModifiedSince(IRequest, Nullable<DateTime>)

View Source

Declaration

public static bool HasNotModifiedSince(this IRequest httpReq, DateTime? dateTime)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.Nullable<System.DateTime>	dateTime

DidReturn304NotModified(IRequest, Nullable<DateTime>, IResponse)

View Source

Declaration

public static bool DidReturn304NotModified(this IRequest httpReq, DateTime? dateTime, IResponse httpRes)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.Nullable<System.DateTime>	dateTime
ServiceStack.Web.IResponse	httpRes

GetJsonpCallback(IRequest)

View Source

Declaration

public static string GetJsonpCallback(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

CookiesAsDictionary(IRequest)

View Source

Declaration

public static Dictionary<string, string> CookiesAsDictionary(this IRequest httpReq)

Returns

System.Collections.Generic.Dictionary<System.String,System.String>

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

ToStatusCode(Exception)

View Source

Declaration

public static int ToStatusCode(this Exception ex)

Returns

System.Int32

Parameters

Type	Name
System.Exception	ex

ToErrorCode(Exception)

View Source

Declaration

public static string ToErrorCode(this Exception ex)

Returns

System.String

Parameters

Type	Name
System.Exception	ex

ToWebServiceException(HttpError)

View Source

Declaration

public static WebServiceException ToWebServiceException(this HttpError error)

Returns

ServiceStack.WebServiceException

Parameters

Type	Name
ServiceStack.HttpError	error

ToWebServiceException(ValidationResult, Object, ValidationFeature)

View Source

Declaration

public static WebServiceException ToWebServiceException(this ValidationResult validationResult, object requestDto, ValidationFeature feature)

Returns

ServiceStack.WebServiceException

Parameters

Type	Name
ServiceStack.FluentValidation.Results.ValidationResult	validationResult
System.Object	requestDto
ServiceStack.Validation.ValidationFeature	feature

GetOperationNameFromLastPathInfo(String)

View Source

Declaration

public static string GetOperationNameFromLastPathInfo(string lastPathInfo)

Returns

System.String

Parameters

Type	Name
System.String	lastPathInfo

GetParentBaseUrl(IRequest)

View Source

Declaration

public static string GetParentBaseUrl(this IRequest request)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	request

SanitizedVirtualPath(String)

View Source

Declaration

public static string SanitizedVirtualPath(this string virtualPath)

Returns

System.String

Parameters

Type	Name
System.String	virtualPath

GetParentBaseUrl(HttpRequestBase)

View Source

Declaration

public static string GetParentBaseUrl(this HttpRequestBase request)

Returns

System.String

Parameters

Type	Name
System.Web.HttpRequestBase	request

GetApplicationUrl(HttpRequestBase)

View Source

Declaration

public static string GetApplicationUrl(this HttpRequestBase httpReq)

Returns

System.String

Parameters

Type	Name
System.Web.HttpRequestBase	httpReq

GetBaseUrl(HttpRequestBase)

View Source

Declaration

public static string GetBaseUrl(this HttpRequestBase request)

Returns

System.String

Parameters

Type	Name
System.Web.HttpRequestBase	request

GetUrlHostName(HttpRequestBase)

View Source

Declaration

public static string GetUrlHostName(this HttpRequestBase request)

Returns

System.String

Parameters

Type	Name
System.Web.HttpRequestBase	request

GetLastPathInfo(HttpRequestBase)

View Source

Declaration

public static string GetLastPathInfo(this HttpRequestBase request)

Returns

System.String

Parameters

Type	Name
System.Web.HttpRequestBase	request

GetOperationName(HttpRequestBase)

View Source

Declaration

public static string GetOperationName(this HttpRequestBase request)

Returns

System.String

Parameters

Type	Name
System.Web.HttpRequestBase	request

GetOperationName(HttpListenerRequest)

View Source

Declaration

public static string GetOperationName(this HttpListenerRequest request)

Returns

System.String

Parameters

Type	Name
System.Net.HttpListenerRequest	request

GetLastPathInfo(HttpListenerRequest)

View Source

Declaration

public static string GetLastPathInfo(this HttpListenerRequest request)

Returns

System.String

Parameters

Type	Name
System.Net.HttpListenerRequest	request

GetPathInfo(String, String, String)

View Source

Declaration

public static string GetPathInfo(string fullPath, string mode, string appPath)

Returns

System.String

Parameters

Type	Name
System.String	fullPath
System.String	mode
System.String	appPath

ResolvePathInfoFromMappedPath(String, String)

View Source

Declaration

public static string ResolvePathInfoFromMappedPath(string fullPath, string mappedPathRoot)

Returns

System.String

Parameters

Type	Name
System.String	fullPath
System.String	mappedPathRoot

IsContentType(IRequest, String)

View Source

Declaration

public static bool IsContentType(this IRequest request, string contentType)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Web.IRequest	request
System.String	contentType

HasAnyOfContentTypes(IRequest, String[])

View Source

Declaration

public static bool HasAnyOfContentTypes(this IRequest request, params string[] contentTypes)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Web.IRequest	request
System.String[]	contentTypes

GetFlattenedRequestParams(IRequest)

Duplicate params have their values joined together in a comma-delimited string

View Source

Declaration

public static Dictionary<string, string> GetFlattenedRequestParams(this IRequest request)

Returns

System.Collections.Generic.Dictionary<System.String,System.String>

Parameters

Type	Name
ServiceStack.Web.IRequest	request

GetQueryStringContentType(IRequest)

View Source

Declaration

public static string GetQueryStringContentType(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

ResolveItem(IRequest, String, Func<IRequest, Object>)

Use this to treat Request.Items[] as a cache by returning pre-computed items to save calculating them multiple times.

View Source

Declaration

public static object ResolveItem(this IRequest httpReq, string itemKey, Func<IRequest, object> resolveFn)

Returns

System.Object

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	itemKey
System.Func<ServiceStack.Web.IRequest,System.Object>	resolveFn

GetResponseContentType(IRequest)

View Source

Declaration

public static string GetResponseContentType(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

SetView(IRequest, String)

View Source

Declaration

public static void SetView(this IRequest httpReq, string viewName)

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	viewName

GetView(IRequest)

View Source

Declaration

public static string GetView(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

SetErrorView(IRequest, String)

Specify the View to render HTML error responses with

View Source

Declaration

public static void SetErrorView(this IRequest httpReq, string viewName)

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	viewName

GetErrorView(IRequest)

Get the View to render HTML error responses with

View Source

Declaration

public static string GetErrorView(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

SetTemplate(IRequest, String)

View Source

Declaration

public static void SetTemplate(this IRequest httpReq, string templateName)

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	templateName

GetTemplate(IRequest)

View Source

Declaration

public static string GetTemplate(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

ResolveAbsoluteUrl(IRequest, String)

View Source

Declaration

public static string ResolveAbsoluteUrl(this IRequest httpReq, string virtualPath = null)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	virtualPath

GetRawUrl(IRequest)

View Source

Declaration

public static string GetRawUrl(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetAbsoluteUrl(IRequest, String)

View Source

Declaration

public static string GetAbsoluteUrl(this IRequest httpReq, string url)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.String	url

GetReturnUrl(IRequest)

View Source

Declaration

public static string GetReturnUrl(this IRequest req)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	req

InferBaseUrl(String, String)

View Source

Declaration

public static string InferBaseUrl(this string absoluteUri, string fromPathInfo = null)

Returns

System.String

Parameters

Type	Name
System.String	absoluteUri
System.String	fromPathInfo

GetBaseUrl(IRequest)

View Source

Declaration

public static string GetBaseUrl(this IRequest httpReq)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

UseHttps(IRequest)

View Source

Declaration

public static bool UseHttps(this IRequest httpReq)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

NormalizeScheme(String, Boolean)

View Source

Declaration

public static string NormalizeScheme(this string url, bool useHttps)

Returns

System.String

Parameters

Type	Name
System.String	url
System.Boolean	useHttps

ToRequestAttributes(String[])

View Source

Declaration

public static RequestAttributes ToRequestAttributes(string[] attrNames)

Returns

ServiceStack.RequestAttributes

Parameters

Type	Name
System.String[]	attrNames

GetAttributes(IRequest)

View Source

Declaration

public static RequestAttributes GetAttributes(this IRequest request)

Returns

ServiceStack.RequestAttributes

Parameters

Type	Name
ServiceStack.Web.IRequest	request

GetAttributes(IPAddress)

View Source

Declaration

public static RequestAttributes GetAttributes(IPAddress ipAddress)

Returns

ServiceStack.RequestAttributes

Parameters

Type	Name
System.Net.IPAddress	ipAddress

IsInLocalSubnet(IPAddress)

View Source

Declaration

public static bool IsInLocalSubnet(this IPAddress ipAddress)

Returns

System.Boolean

Parameters

Type	Name
System.Net.IPAddress	ipAddress

ToRequestContext(IRequest)

View Source

Declaration

public static RequestContext ToRequestContext(this IRequest req)

Returns

System.Web.Routing.RequestContext

Parameters

Type	Name
ServiceStack.Web.IRequest	req

ToHttpContextBase(IRequest)

View Source

Declaration

public static HttpContextBase ToHttpContextBase(this IRequest req)

Returns

System.Web.HttpContextBase

Parameters

Type	Name
ServiceStack.Web.IRequest	req

ToHttpResponseBase(IResponse)

View Source

Declaration

public static HttpResponseBase ToHttpResponseBase(this IResponse res)

Returns

System.Web.HttpResponseBase

Parameters

Type	Name
ServiceStack.Web.IResponse	res

ToHttpContextBase(HttpRequestBase)

View Source

Declaration

public static HttpContextBase ToHttpContextBase(this HttpRequestBase aspnetHttpReq)

Returns

System.Web.HttpContextBase

Parameters

Type	Name
System.Web.HttpRequestBase	aspnetHttpReq

ToHttpContextBase(HttpContext)

View Source

Declaration

public static HttpContextBase ToHttpContextBase(this HttpContext httpContext)

Returns

System.Web.HttpContextBase

Parameters

Type	Name
System.Web.HttpContext	httpContext

ToRequest(HttpContext, String)

View Source

Declaration

public static IHttpRequest ToRequest(this HttpContext httpCtx, string operationName = null)

Returns

ServiceStack.Web.IHttpRequest

Parameters

Type	Name
System.Web.HttpContext	httpCtx
System.String	operationName

ToRequest(HttpContextBase, String)

View Source

Declaration

public static IHttpRequest ToRequest(this HttpContextBase httpCtx, string operationName = null)

Returns

ServiceStack.Web.IHttpRequest

Parameters

Type	Name
System.Web.HttpContextBase	httpCtx
System.String	operationName

ToRequest(HttpRequestBase, String)

View Source

Declaration

public static IHttpRequest ToRequest(this HttpRequestBase httpCtx, string operationName = null)

Returns

ServiceStack.Web.IHttpRequest

Parameters

Type	Name
System.Web.HttpRequestBase	httpCtx
System.String	operationName

ToRequest(HttpListenerContext, String)

View Source

Declaration

public static IHttpRequest ToRequest(this HttpListenerContext httpCtxReq, string operationName = null)

Returns

ServiceStack.Web.IHttpRequest

Parameters

Type	Name
System.Net.HttpListenerContext	httpCtxReq
System.String	operationName

ToResponse(HttpContext)

View Source

Declaration

public static IHttpResponse ToResponse(this HttpContext httpCtx)

Returns

ServiceStack.Web.IHttpResponse

Parameters

Type	Name
System.Web.HttpContext	httpCtx

ToResponse(HttpRequestBase)

View Source

Declaration

public static IHttpResponse ToResponse(this HttpRequestBase aspReq)

Returns

ServiceStack.Web.IHttpResponse

Parameters

Type	Name
System.Web.HttpRequestBase	aspReq

ToResponse(HttpListenerContext)

View Source

Declaration

public static IHttpResponse ToResponse(this HttpListenerContext httpCtx)

Returns

ServiceStack.Web.IHttpResponse

Parameters

Type	Name
System.Net.HttpListenerContext	httpCtx

GetSoapMessage(IRequest)

View Source

Declaration

public static Message GetSoapMessage(this IRequest httpReq)

Returns

System.ServiceModel.Channels.Message

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq

GetPathAndQuery(HttpRequestBase)

View Source

Declaration

public static string GetPathAndQuery(this HttpRequestBase request)

Returns

System.String

Parameters

Type	Name
System.Web.HttpRequestBase	request

GetOperationType(IRequest)

View Source

Declaration

public static Type GetOperationType(this IRequest req)

Returns

System.Type

Parameters

Type	Name
ServiceStack.Web.IRequest	req

IsMultiRequest(IRequest)

View Source

Declaration

public static bool IsMultiRequest(this IRequest req)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Web.IRequest	req

SetAutoBatchCompletedHeader(IRequest, Int32)

View Source

Declaration

public static void SetAutoBatchCompletedHeader(this IRequest req, int completed)

Parameters

Type	Name
ServiceStack.Web.IRequest	req
System.Int32	completed

SetRoute(IRequest, RestPath)

View Source

Declaration

public static void SetRoute(this IRequest req, RestPath route)

Parameters

Type	Name
ServiceStack.Web.IRequest	req
ServiceStack.Host.RestPath	route

GetRoute(IRequest)

View Source

Declaration

public static RestPath GetRoute(this IRequest req)

Returns

ServiceStack.Host.RestPath

Parameters

Type	Name
ServiceStack.Web.IRequest	req

IsHtml(IRequest)

View Source

Declaration

public static bool IsHtml(this IRequest req)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Web.IRequest	req

GetRequestValue(IHttpRequest, String)

View Source

Declaration

public static string GetRequestValue(this IHttpRequest req, string name)

Returns

System.String

Parameters

Type	Name
ServiceStack.Web.IHttpRequest	req
System.String	name

EachRequest<T>(IRequest, Action<T>)

View Source

Declaration

public static void EachRequest<T>(this IRequest httpReq, Action<T> action)

Parameters

Type	Name
ServiceStack.Web.IRequest	httpReq
System.Action<<T>>	action

Type Parameters

• T

GetClaimsPrincipal(IRequest)

View Source

Declaration

public static ClaimsPrincipal GetClaimsPrincipal(this IRequest req)

Returns

System.Security.Claims.ClaimsPrincipal

Parameters

Type	Name
ServiceStack.Web.IRequest	req

GetClaims(IRequest)

View Source

Declaration

public static IEnumerable<Claim> GetClaims(this IRequest req)

Returns

System.Collections.Generic.IEnumerable<System.Security.Claims.Claim>

Parameters

Type	Name
ServiceStack.Web.IRequest	req

HasRole(IEnumerable<Claim>, String)

View Source

Declaration

public static bool HasRole(this IEnumerable<Claim> claims, string role)

Returns

System.Boolean

Parameters

Type	Name
System.Collections.Generic.IEnumerable<System.Security.Claims.Claim>	claims
System.String	role

HasScope(IEnumerable<Claim>, String)

View Source

Declaration

public static bool HasScope(this IEnumerable<Claim> claims, string scope)

Returns

System.Boolean

Parameters

Type	Name
System.Collections.Generic.IEnumerable<System.Security.Claims.Claim>	claims
System.String	scope

HasClaim(IEnumerable<Claim>, String, String)

View Source

Declaration

public static bool HasClaim(this IEnumerable<Claim> claims, string type, string value)

Returns

System.Boolean

Parameters

Type	Name
System.Collections.Generic.IEnumerable<System.Security.Claims.Claim>	claims
System.String	type
System.String	value

CanReadRequestBody(IRequest)

View Source

Declaration

public static bool CanReadRequestBody(this IRequest req)

Returns

System.Boolean

Parameters

Type	Name
ServiceStack.Web.IRequest	req