Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

HttpCachePolicyBase Class

Serves as the base class for classes that contain methods for setting cache-specific HTTP headers and for controlling the ASP.NET page output cache.

Namespace:  System.Web
Assembly:  System.Web (in System.Web.dll)
public abstract class HttpCachePolicyBase

The HttpCachePolicyBase type exposes the following members.

  NameDescription
Protected methodHttpCachePolicyBaseInitializes the class for use by an inherited class instance. This constructor can only be called by an inherited class.
Top
  NameDescription
Public propertyVaryByContentEncodingsWhen overridden in a derived class, gets the list of Content-Encoding headers that are used to vary the output cache.
Public propertyVaryByHeadersWhen overridden in a derived class, gets the list of all HTTP headers that are used to vary cache output.
Public propertyVaryByParamsWhen overridden in a derived class, gets the list of parameters that are received by an HTTP GET or POST verb that affect caching.
Top
  NameDescription
Public methodAddValidationCallbackWhen overridden in a derived class, registers a validation callback for the current response.
Public methodAppendCacheExtensionWhen overridden in a derived class, appends the specified text to the Cache-Control HTTP header.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSetAllowResponseInBrowserHistoryWhen overridden in a derived class, makes the response available in the browser history cache, regardless of the HttpCacheability setting made on the server.
Public methodSetCacheability(HttpCacheability)When overridden in a derived class, sets the Cache-Control header to the specified HttpCacheability value.
Public methodSetCacheability(HttpCacheability, String)When overridden in a derived class, sets the Cache-Control header to the specified HttpCacheability value and appends an extension to the directive.
Public methodSetETagWhen overridden in a derived class, sets the ETag HTTP header to the specified string.
Public methodSetETagFromFileDependenciesWhen overridden in a derived class, sets the ETag HTTP header based on the time stamps of the handler's file dependencies.
Public methodSetExpiresWhen overridden in a derived class, sets the Expires HTTP header to an absolute date and time.
Public methodSetLastModifiedWhen overridden in a derived class, sets the Last-Modified HTTP header to the specified date and time.
Public methodSetLastModifiedFromFileDependenciesWhen overridden in a derived class, sets the Last-Modified HTTP header based on the time stamps of the handler's file dependencies.
Public methodSetMaxAgeWhen overridden in a derived class, sets the Cache-Control: max-age HTTP header to the specified time span.
Public methodSetNoServerCachingWhen overridden in a derived class, stops all origin-server caching for the current response.
Public methodSetNoStoreWhen overridden in a derived class, sets the Cache-Control: no-store HTTP header.
Public methodSetNoTransformsWhen overridden in a derived class, sets the Cache-Control: no-transform HTTP header.
Public methodSetOmitVaryStarWhen overridden in a derived class, specifies whether the response contains the vary:* header when caching varies by parameters.
Public methodSetProxyMaxAgeWhen overridden in a derived class, sets the Cache-Control: s-maxage HTTP header to the specified time span.
Public methodSetRevalidationWhen overridden in a derived class, sets the Cache-Control HTTP header to either the must-revalidate or the proxy-revalidate directives, based on the specified enumeration value.
Public methodSetSlidingExpirationWhen overridden in a derived class, sets cache expiration to absolute or sliding.
Public methodSetValidUntilExpiresWhen overridden in a derived class, specifies whether the ASP.NET cache should ignore HTTP Cache-Control headers that are sent by the client that invalidate the cache.
Public methodSetVaryByCustomWhen overridden in a derived class, specifies a text string to vary cached output responses by.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The HttpCachePolicyBase class is an abstract class that contains the same members as the HttpCachePolicy class. The HttpCachePolicyBase class lets you create derived classes that are like the HttpCachePolicy class, but that you can customize and that work outside the ASP.NET pipeline. When you perform unit testing, you typically use a derived class to implement members with customized behavior that fulfills the scenario you are testing.

The HttpCachePolicyWrapper class derives from the HttpCachePolicyBase class. The HttpCachePolicyWrapper class serves as a wrapper for the HttpCachePolicy class. At run time, you typically use an instance of the HttpCachePolicyWrapper class to call members of the HttpCachePolicy object.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.