GetExternalFileService Class

Base class for services retrieving a files from external storages.

Inheritance Hierarchy

System.Object
  CMS.Routing.Web.ActionResultServiceBase
    CMS.Routing.Web.AdvancedGetFileService
      CMS.Routing.Web.GetExternalFileService

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

Syntax

public abstract class GetExternalFileService : AdvancedGetFileService

The GetExternalFileService type exposes the following members.

Constructors

	Name	Description
Protected method	GetExternalFileService	Initializes a new instance of a GetExternalFileService.

Properties

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

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(). (Inherited from AdvancedGetFileService.)
Protected method	GetBaseCacheKey	Returns the base cache key (created with all parameters considered to be valid for proper caching). (Inherited from AdvancedGetFileService.)
Protected method	GetCacheDependency	Creates the cache dependency from the given keys. (Inherited from AdvancedGetFileService.)
Protected method	GetCachedOutputData	Gets the cached data for the current request. (Inherited from AdvancedGetFileService.)
Protected method	GetExternalFile	Returns an object representing a file on external storage. Returns null if the file on the filePath does not exist.
Protected method	GetFileServiceResult	Processes the incoming HTTP request and returns a CMSActionResult describing the action to be executed for the request. (Overrides AdvancedGetFileService.GetFileServiceResult().)
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. (Inherited from AdvancedGetFileService.)
Protected method	LoadSiteName	Loads the site name from the query string. (Inherited from AdvancedGetFileService.)
Protected method	NotModified	Responds HTTP code 304 Not Modified. (Inherited from AdvancedGetFileService.)
Protected method	PrepareFileContentResult	Prepares the CMSFileContentResult object with common properties populated. (Inherited from AdvancedGetFileService.)
Protected method	PreparePhysicalFileResult	Prepares the CMSPhysicalFileResult object with common properties populated. (Inherited from AdvancedGetFileService.)
Protected method	ReadFileContent	Reads filePath and returns bytes array. (Inherited from AdvancedGetFileService.)
Protected method	SaveOutputDataToCache	Saves the data for current request to cache. (Inherited from AdvancedGetFileService.)
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. (Inherited from AdvancedGetFileService.)
Protected method	Unauthorized	Responds HTTP code 401 Unauthorized. (Inherited from ActionResultServiceBase.)