HttpCachePolicyWrapper Class (System.Web)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
HttpCachePolicyWrapper Class

Encapsulates the HTTP intrinsic object that contains methods for setting cache-specific HTTP headers and for controlling the ASP.NET page output cache.

Inheritance Hierarchy
System.Object
  System.Web.HttpCachePolicyBase
    System.Web.HttpCachePolicyWrapper

Namespace:  System.Web
Assembly:  System.Web (in System.Web.dll)
Syntax
Visual Basic
Public Class HttpCachePolicyWrapper _
	Inherits HttpCachePolicyBase
C#
public class HttpCachePolicyWrapper : HttpCachePolicyBase
Visual C++
public ref class HttpCachePolicyWrapper : public HttpCachePolicyBase
F#
type HttpCachePolicyWrapper =  
    class
        inherit HttpCachePolicyBase
    end

The HttpCachePolicyWrapper type exposes the following members.

Constructors
  Name Description
Public method HttpCachePolicyWrapper Initializes a new instance of the HttpCachePolicyWrapper class.
Top
Properties
  Name Description
Public property VaryByContentEncodings Gets the list of Content-Encoding headers that will be used to vary the output cache. (Overrides HttpCachePolicyBase.VaryByContentEncodings.)
Public property VaryByHeaders Gets the list of all HTTP headers that will be used to vary cache output. (Overrides HttpCachePolicyBase.VaryByHeaders.)
Public property VaryByParams Gets the list of parameters received by an HTTP GET or HTTP POST that affect caching. (Overrides HttpCachePolicyBase.VaryByParams.)
Top
Methods
  Name Description
Public method AddValidationCallback Registers a validation callback for the current response. (Overrides HttpCachePolicyBase.AddValidationCallback(HttpCacheValidateHandler, Object).)
Public method AppendCacheExtension Appends the specified text to the Cache-Control HTTP header. (Overrides HttpCachePolicyBase.AppendCacheExtension(String).)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetAllowResponseInBrowserHistory Makes the response available in the browser history cache, regardless of the HttpCacheability setting made on the server. (Overrides HttpCachePolicyBase.SetAllowResponseInBrowserHistory(Boolean).)
Public method SetCacheability(HttpCacheability) Sets the Cache-Control header to the specified HttpCacheability value. (Overrides HttpCachePolicyBase.SetCacheability(HttpCacheability).)
Public method SetCacheability(HttpCacheability, String) Sets the Cache-Control header to the specified HttpCacheability value and appends an extension to the directive. (Overrides HttpCachePolicyBase.SetCacheability(HttpCacheability, String).)
Public method SetETag Sets the ETag HTTP header to the specified string. (Overrides HttpCachePolicyBase.SetETag(String).)
Public method SetETagFromFileDependencies Sets the ETag HTTP header based on the time stamps of the handler's file dependencies. (Overrides HttpCachePolicyBase.SetETagFromFileDependencies().)
Public method SetExpires Sets the Expires HTTP header to an absolute date and time. (Overrides HttpCachePolicyBase.SetExpires(DateTime).)
Public method SetLastModified Sets the Last-Modified HTTP header to the specified date and time. (Overrides HttpCachePolicyBase.SetLastModified(DateTime).)
Public method SetLastModifiedFromFileDependencies Sets the Last-Modified HTTP header based on the time stamps of the handler's file dependencies. (Overrides HttpCachePolicyBase.SetLastModifiedFromFileDependencies().)
Public method SetMaxAge Sets the Cache-Control: max-age HTTP header to the specified time span. (Overrides HttpCachePolicyBase.SetMaxAge(TimeSpan).)
Public method SetNoServerCaching Stops all origin-server caching for the current response. (Overrides HttpCachePolicyBase.SetNoServerCaching().)
Public method SetNoStore Sets the Cache-Control: no-store HTTP header. (Overrides HttpCachePolicyBase.SetNoStore().)
Public method SetNoTransforms Sets the Cache-Control: no-transform HTTP header. (Overrides HttpCachePolicyBase.SetNoTransforms().)
Public method SetOmitVaryStar Specifies whether the response contains the vary:* header when varying by parameters. (Overrides HttpCachePolicyBase.SetOmitVaryStar(Boolean).)
Public method SetProxyMaxAge Sets the Cache-Control: s-maxage HTTP header to the specified time span. (Overrides HttpCachePolicyBase.SetProxyMaxAge(TimeSpan).)
Public method SetRevalidation Sets the Cache-Control HTTP header to either the must-revalidate or the proxy-revalidate directives, based on the specified enumeration value. (Overrides HttpCachePolicyBase.SetRevalidation(HttpCacheRevalidation).)
Public method SetSlidingExpiration Sets cache expiration to absolute or sliding. (Overrides HttpCachePolicyBase.SetSlidingExpiration(Boolean).)
Public method SetValidUntilExpires Specifies whether the ASP.NET cache should ignore HTTP Cache-Control headers sent by the client that invalidate the cache. (Overrides HttpCachePolicyBase.SetValidUntilExpires(Boolean).)
Public method SetVaryByCustom Specifies a text string to vary cached output responses by. (Overrides HttpCachePolicyBase.SetVaryByCustom(String).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

The HttpCachePolicyWrapper class derives from the HttpCachePolicyBase class and serves as a wrapper for the HttpCachePolicy class. This class exposes the functionality of the HttpCachePolicy class while also exposing the HttpCachePolicyBase type. The HttpCachePolicyBase class enables you to replace the original implementation of the HttpCachePolicy class in your application with a custom implementation, such as when you perform unit testing outside the ASP.NET pipeline.

Version Information

.NET Framework

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Web Namespace