C# Class BlueCollar.Dashboard.DashboardHandlerBase

Base IDashboardHandler implementation.
Inheritance: IDashboardHandler
Show file Open project: ChadBurggraf/blue-collar

Public Methods

Method Description
Dispose ( ) : void

Disposes of resources used by this instance.

ProcessRequest ( HttpContext context ) : void

Enables processing of HTTP Web requests by a custom HttpHandler that implements the IHttpHandler interface.

ProcessRequest ( System.Web.HttpContextBase context ) : void

Enables processing of HTTP Web requests by a custom HttpHandler that implements the IHttpHandler interface.

Protected Methods

Method Description
BadRequest ( ) : void

Throws a 400 HttpException.

DashboardHandlerBase ( IRepositoryFactory repositoryFactory ) : System

Initializes a new instance of the DashboardHandlerBase class.

Dispose ( bool disposing ) : void

Disposes of resources used by this instance.

EncodeString ( string value ) : byte[]

Gets the given string value as an array of bytes.

GetCacheKey ( System.Web.HttpContextBase httpContext ) : string

Gets the cache key to use for this instance's response.

NotFound ( ) : void

Throws a 404 HttpException.

PerformRequest ( System.Web.HttpContextBase context ) : byte[]

Performs the concrete request operation and returns the output as a byte array.

PrepareResponse ( System.Web.HttpContextBase context, HandlerOutput output ) : void

Prepares an HTTP context's response.

ShouldCompressResponse ( ) : bool

Gets a value indicating whether the response should be compressed if the client accepts compression.

Method Details

BadRequest() protected method

Throws a 400 HttpException.
protected BadRequest ( ) : void
return void

DashboardHandlerBase() protected method

Initializes a new instance of the DashboardHandlerBase class.
protected DashboardHandlerBase ( IRepositoryFactory repositoryFactory ) : System
repositoryFactory IRepositoryFactory The repository factory to use.
return System

Dispose() public method

Disposes of resources used by this instance.
public Dispose ( ) : void
return void

Dispose() protected method

Disposes of resources used by this instance.
protected Dispose ( bool disposing ) : void
disposing bool A value indicating whether to dispose of managed resources.
return void

EncodeString() protected static method

Gets the given string value as an array of bytes.
protected static EncodeString ( string value ) : byte[]
value string The string value to get.
return byte[]

GetCacheKey() protected method

Gets the cache key to use for this instance's response.
protected GetCacheKey ( System.Web.HttpContextBase httpContext ) : string
httpContext System.Web.HttpContextBase The HTTP context to get the cache key for.
return string

NotFound() protected method

Throws a 404 HttpException.
protected NotFound ( ) : void
return void

PerformRequest() protected abstract method

Performs the concrete request operation and returns the output as a byte array.
protected abstract PerformRequest ( System.Web.HttpContextBase context ) : byte[]
context System.Web.HttpContextBase The HTTP context to perform the request for.
return byte[]

PrepareResponse() protected method

Prepares an HTTP context's response.
protected PrepareResponse ( System.Web.HttpContextBase context, HandlerOutput output ) : void
context System.Web.HttpContextBase The HTTP context to prepare.
output HandlerOutput The cached output the response is being prepared for, if applicable.
return void

ProcessRequest() public method

Enables processing of HTTP Web requests by a custom HttpHandler that implements the IHttpHandler interface.
public ProcessRequest ( HttpContext context ) : void
context System.Web.HttpContext An object that provides references to the intrinsic server objects (for example, Request, Response, Session, and Server) used to service HTTP requests.
return void

ProcessRequest() public method

Enables processing of HTTP Web requests by a custom HttpHandler that implements the IHttpHandler interface.
public ProcessRequest ( System.Web.HttpContextBase context ) : void
context System.Web.HttpContextBase An object that provides references to the intrinsic server objects (for example, Request, Response, Session, and Server) used to service HTTP requests.
return void

ShouldCompressResponse() protected method

Gets a value indicating whether the response should be compressed if the client accepts compression.
protected ShouldCompressResponse ( ) : bool
return bool