AdvancedGetFileService Class

Base class for services retrieving a file.

Inheritance Hierarchy

System.Object
  CMS.Routing.Web.ActionResultServiceBase
    CMS.Routing.Web.AdvancedGetFileService
      CMS.OnlineForms.Internal.GetBizFormFileServiceBase
      CMS.Routing.Web.GetExternalFileService
      CMS.Routing.Web.GetMetafileService

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

Syntax

public abstract class AdvancedGetFileService : ActionResultServiceBase, 
	IReadOnlySessionState, IRequiresSessionState

The AdvancedGetFileService type exposes the following members.

Constructors

	Name	Description
Protected method	AdvancedGetFileService

Properties

	Name	Description
Protected property	AllowCache	Returns true if the process allows cache.
Protected property	AllowClientCache	Returns true if client cache is allowed for the current request.
Protected property	CacheMinutes	Cache minutes.
Protected property	ClientCacheMinutes	Cache minutes.
Protected property	CurrentSite	Current site.
Protected property	CurrentSiteName	Current site name.
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.
Protected property	Height	Image height.
Protected property	IsLiveSite	Indicates if live site mode.
Protected 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.
Protected property	LogExceptions	Logs the exceptions caused by the process.
Protected property	MaxSideSize	Image maximum side size.
Protected property	OutputDataCacheItemName	Cache item name for the file output data.
Protected property	RequestStatusEnum	Gets current request URL rewriting status. (Overrides ActionResultServiceBase.RequestStatusEnum.)
Protected property	RevalidateClientCache	Gets or sets the value representing if client HTTP cache should be revalidated.
Protected property	Width	Image width.

Methods

	Name	Description
Protected method	ETagsMatch	Checks if given and requested ETags match and object has current timestamp. (Inherited from ActionResultServiceBase.)
Protected method	FileNotFound	Responds HTTP code 404 Not Found. (Inherited from ActionResultServiceBase.)
Protected method	Forbidden	Responds HTTP code 403 Forbidden. (Inherited from ActionResultServiceBase.)
Public method	GetActionResult	Process the request. (Inherited from ActionResultServiceBase.)
Protected method	GetActionResultInternal	Checks domain policy for current site and calls GetFileServiceResult(). (Overrides ActionResultServiceBase.GetActionResultInternal().)
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	GetFileServiceResult	Returns a CMSActionResult by specific service retrieving file contents.
Protected method	GetIfModifiedSinceRequestHeader	Returns the value of If-Modified-Since HTTP header or null if the header not found. (Inherited from ActionResultServiceBase.)
Protected method	HasIfModifiedSinceRequestHeader	Returns true when non-empty If-Modified-Since header is present in current request. (Inherited from ActionResultServiceBase.)
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.
Protected method	NotModified	Responds HTTP code 304 Not Modified.
Protected method	PrepareFileContentResult	Prepares the CMSFileContentResult object with common properties populated.
Protected method	PreparePhysicalFileResult	Prepares the CMSPhysicalFileResult object with common properties populated.
Protected method	ReadFileContent	Reads filePath and returns bytes array.
Protected method	SaveOutputDataToCache	Saves the data for current request to cache.
Protected method	SetCacheabilityAndRevalidation	Sets the cacheability restriction based on the options provided as arguments and AllowCache property. Revalidation is set based on the RevalidateClientCache property.
Protected method	Unauthorized	Responds HTTP code 401 Unauthorized. (Inherited from ActionResultServiceBase.)