FPCCacheRule object
Applies to: desktop apps only
The FPCCacheRule object represents a single cache rule. A cache rule defines cache policy for all content or specific content groups, including:
- How objects are provided from the cache.
- Whether objects should be stored in the cache.
- The size of objects that can be stored in the cache.
- Whether Secure Sockets Layer (SSL) responses will be stored in the cache.
- Whether content supplied after user authentication by the Web server will be stored in the cache.
- The configuration settings in an FPCFTPCacheConfiguration object for FTP caching.
- The configuration settings in an FPCHTTPCacheConfiguration object for HTTP caching.
This object is an element of an FPCCacheRules collection.
.png "Ff824412.bkbutton(en-us,VS.85).png")
Click here to see the Forefront TMG object hierarchy.
For more information about the COM objects related to caching, see Introduction to the Forefront TMG Cache Objects.
Inheritance
This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.
Members
The FPCCacheRule object has these types of members:
- Methods
- Properties
Methods
The FPCCacheRule object has these methods.
| Method | Description |
|---|---|
| SetSizeBound | Sets the minimum or maximum size of the objects that can be cached. |
Properties
The FPCCacheRule object has these properties.
| Property | Access type | Description |
|---|---|---|
| Read/write | Gets or sets a Boolean value that indicates whether content supplied after user authentication by the Web server or an upstream proxy server will be cached. |
|
| Read/write | Gets or sets a Boolean value that indicates whether content received using the Background Intelligent Transfer Service (BITS) will be cached. |
|
| Read/write | Gets or sets a Boolean value that indicates whether content for offline browsing with response code 302 or 307 will be cached. |
|
| Read/write | Gets or sets a Boolean value that indicates whether dynamic responses will be cached even if their headers mark them as not cacheable. |
|
| Read/write | Gets or sets a Boolean value that indicates whether responses are cached when the incoming or outgoing request uses SSL. |
|
| Read/write | Gets or sets the description of the rule. |
|
| Read-only | Gets an FPCRefs collection that contains references to the FPCDomainNameSet collections defining the domain name sets included in or excluded from the request destinations to which the rule applies. |
|
| Read-only | Gets an FPCSelectionIPs object that specifies the complete set of destination IP addresses to which the rule applies. |
|
| Read/write | Gets or sets a Boolean value that indicates whether the rule is enabled. |
|
| Read-only | Gets an FPCFTPCacheConfiguration object that defines the configuration settings for FTP caching. |
|
| Read-only | Gets an FPCHTTPCacheConfiguration object that defines the configuration settings for HTTP caching. |
|
| Read-only | Gets a Boolean value that indicates whether the rule is preinstalled and cannot be deleted. |
|
| Read/write | Gets or sets the name of the cache rule. |
|
| Read/write | Gets or sets a Boolean value that indicates whether responses will never be cached. |
|
| Read-only | Gets the maximum size of an object that can be cached. |
|
| Read-only | Gets a Boolean value that indicates whether the object size limit is enabled. |
|
| Read-only | Gets a value from the FpcSizeUnits enumerated type that specifies the units in which the ObjectSizeLimit property is expressed. |
|
| Read-only | Gets the ordinal position of the rule in the list of cache rules, which corresponds to their order of application. |
|
| Read-only | Gets an FPCRefs collection that contains references to the FPCURLSet collections defining the URL sets included in or excluded from the request destinations to which the rule applies. |
|
| Read/write | Gets or sets a value from the FpcCacheAction enumerated type that specifies the conditions under which an object should be retrieved from the cache. |
Methods Inherited from FPCPersist
| Name | Description |
|---|---|
| CancelWaitForChanges | Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only). |
| CanImport | Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document. |
| Export | Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document. |
| ExportToFile | Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML file. |
| GetServiceRestartMask | Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect. |
| Import | Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage. |
| ImportFromFile | Recursively copies the values of all the properties of the object and of its subobjects from the specified XML file to persistent storage. |
| LoadDocProperties | Provides the XML document's properties so that you can know what information can be imported from the document. |
| Refresh | Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved. |
| Save | Recursively writes the current values of all the properties of the object and its subobjects to persistent storage. |
| WaitForChanges | Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only). |
Properties Inherited from FPCPersist
| Name | Description |
|---|---|
| PersistentName | Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy. |
| VendorParameterSets | Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the object. |
Interfaces for C++ Programming
This object implements the IFPCCacheRule and IFPCCacheRule2 interfaces.
Requirements
Minimum supported client |
Windows Vista, None supported |
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only) |
Version |
Forefront Threat Management Gateway (TMG) 2010 |
IDL |
Msfpccom.idl |
See also
Build date: 7/12/2010