AdvancedGetFileHandler Class

Base page for GetFile pages.

Inheritance Hierarchy

System.Object
  CMS.Routing.Web.AdvancedGetFileHandler
    CMS.Routing.Web.GetMetaFileHandler

Namespace: CMS.Routing.Web
Assembly: CMS.Routing.Web (in CMS.Routing.Web.dll) Version: 10.0.0

Syntax

public abstract class AdvancedGetFileHandler : IHttpHandler, 
	IReadOnlySessionState, IRequiresSessionState

The AdvancedGetFileHandler type exposes the following members.

Constructors

	Name	Description
Protected method	AdvancedGetFileHandler

Fields

	Name	Description
Protected field	deviceResizeIsUsed	Indicates if max resize for mobile device is used.
Protected field	mAllowCache	If true, the caching is allowed.
Protected field	mCacheMinutes	Cache minutes
Protected field	mClientCacheMinutes	Client cache minutes
Protected field	mCompleted	Indicates whether request is completed
Protected field	mHeight	Height
Protected field	mMaxSideSize	Max. side size
Protected field	mResizeToDevice	Indicates whether resizing should be used for device
Protected field	mRevalidateClientCache	Indicates whether client cache should be revalidated
Protected field	mWidth	Width
Protected field	useCacheItemName	Cache item name for the request.

Properties

	Name	Description
Protected property	AcceptRange	Indicates if resumable downloads should be supported for current file.
Protected property Static member	AcceptRanges	Indicates whether range requests are enabled (ex. for resumable downloads). If false, the HTTP Handler ignores the Range HTTP Header and returns the entire contents.
Public property	AllowCache	Returns true if the process allows cache.
Public property	AllowClientCache	Returns true if client cache is allowed for the current request.
Public property	AreRangesValid	Indicates whether ranges are valid. TRUE: ranges are valid or request is not range request FALSE: all other cases
Public property	CacheItemName	Cache item name for current request.
Public property	CacheMinutes	Cache minutes.
Public property	ClientCacheMinutes	Cache minutes.
Protected property	Context	Returns the current context
Public property	CurrentSite	Current site.
Public property	CurrentSiteName	Current site name.
Public property	CurrentUser	Current User.
Public property	DataLength	Size of data.
Public property	ETag	HTTP header entity tag.
Protected property Static member	ExcludedResumableExtensions	List of file extensions for which the resumable downloads are disabled.
Protected property Static member	GetFileEndRequest	When true, the request is completed, when false, the Request.End is called.
Public property	Height	Image height.
Protected property	IsLiveSite	Indicates if live site mode.
Public property	IsMultipart	Indicates whether it is multipart range request.
Public property	IsRangeRequest	Indicates whether it is range request.
Public property	IsReusable	Indicates if handler is reusable.
Public property	LogCommunicationExceptions	Whether to log exception caused by communication problems (e.g. when remote host closes the connection). Log exceptions has to be set to TRUE.
Public property	LogExceptions	Logs the exceptions caused by the process.
Public property	MaxSideSize	Image maximum side size.
Public property	OutputDataCacheItemName	Cache item name for the file output data.
Protected property Static member	RangeRegExp	The range from HTTP header regular expression.
Public property	Ranges	2D Array in format {{START_RANGE,END_RANGE},{START_RANGE, END_RANGE}}.
Public property	ResizeToDevice	Indicates if max side size parameter should be changes to device profile dimensions.
Public property	Response	Returns the current response
Public property	RevalidateClientCache	Cache minutes.
Protected property	Sender	Gets or sets sender object that is used for writing data to the response.
Public property	Watermark	If set, watermark image is applied to the image. Name of the watermark image from ~/App_Themes/{theme}/Images/Watermarks
Public property	WatermarkPosition	Watermark position.
Public property	Width	Image width.

Methods

	Name	Description
Protected method	CompleteRequest	Completes the request.
Protected method	ETagsMatch	Responds with 304 Not Modified if ETags match and object has current timestamp.
Protected method	GetBaseCacheKey	Returns the base cache key (created with all parameters considered to be valid for proper caching).
Protected method	GetCacheDependency	Creates the cache dependency from the given keys.
Protected method	GetCachedOutputData	Gets the cached data for the current request.
Protected method	GetRange	Parses the range header from the request.
Protected method	HandleDeviceDimension	Handles max side size according to device profile dimensions.
Protected method	HandleDeviceResize	Changes MaxSideSize to device dimensions if device resizing is enabled.
Protected method	IsExtensionExcludedFromRanges	Indicates if file with given extension is excluded from resumable downloads.
Protected method	LoadSiteName	Loads the site name from the query string.
Public method	ProcessRequest	Processes the handler request
Protected method	ProcessRequestInternal	Processes the handler request
Protected method	RespondNotModified	Responds with the not modified code.
Protected method	SaveOutputDataToCache	Saves the data for current request to cache.
Protected method	SetCacheability	Sets the cache-ability with dependence on connection type IE browser doesn't support No-Cache if current connection is secured
Protected method	SetDisposition	Sets response header according to file type.
Protected method	SetResponseContentType	Sets content type of the response based on file MIME type
Protected method	SetRevalidation	Sets the revalidation of the client caches.
Protected method	SetTimeStamps	Sets the last modified and expires header to the response
Protected method	WriteBytes	Streams the byte array to the response.
Protected method	WriteFile	Streams the data file to the response.