FPCRoutingRules Collection

The FPCRoutingRules collection provides access to the set of FPCRoutingRule objects that represent the routing rules, or Web chaining rules, defined in a Forefront TMG array. Web chaining rules determine whether a Web proxy client request is sent directly to the requested destination, to another upstream proxy server, or to a specified host.

Note Web chaining rules apply to requests from Web proxy clients, including requests from Web browsers running on Firewall client computers. If you want to foward requests from Firewall clients and SecureNAT clients that are not handled by the Forefront TMG Web proxy to an upstream Forefront TMG computer, you must configure firewall chaining by setting the properties of the FPCFirewallChaining object.

By using the MoveUp and MoveDown methods, you can adjust the order in which the Web chaining rules in the collection are applied.

Forefront TMG is installed with the Default Web chaining rule. This rule, together with the Default cache rule, initially specifies that all Web proxy client requests are sent as HTTP requests directly to the applicable Web server if a valid version of the requested object that can be returned to the client is not found in the Forefront TMG cache. The Default Web chaining rule is applied last, and its position in the list of rules cannot be changed. You can modify the Default Web chaining rule's action and how it redirects outgoing Web proxy client requests, but you cannot delete it.

The FPCRoutingRules collection is accessed through the RoutingRules property of an FPCNetworkConfiguration object.

Click here to see the Forefront TMG object hierarchy.

Inheritance

This collection 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.

Methods

The FPCRoutingRules collection defines the following methods.

Method	Description
Add	Creates a new FPCRoutingRule object, adds it to the collection, and returns a reference to it.
Item	Retrieves the requested FPCRoutingRule object from the collection.
MoveDown	Moves the specified routing rule one step down the list of rules, which corresponds to their order of application.
MoveUp	Moves the specified routing rule one step up the list of rules, which corresponds to their order of application.
Remove	Removes the specified FPCRoutingRule object from the collection.

Properties

The FPCRoutingRules collection defines the following properties.

Property	Description
_NewEnum	Gets an enumerator object for the collection.
Count	Gets the number of FPCRoutingRule objects in the collection.

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 properties of the collection, its elements, and their subobjects can be imported from the specified XML document.
Export	Recursively writes the stored values of all the properties of the collection, its elements, and their subobjects to the specified XML document.
ExportToFile	Recursively writes the stored values of all the properties of the collection, its elements, and their 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 collection, its elements, and their subobjects from the specified XML document to persistent storage.
ImportFromFile	Recursively copies the values of all the properties of the collection, its elements, and their 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 collection, its elements, and their subobjects from persistent storage, overwriting any changes that have not been saved.
Save	Recursively writes the current values of all the properties of the collection, its elements, and their 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 collection. 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 collection.

Interfaces for C++ Programming

This collection implements the IFPCRoutingRules interface.

Requirements

Client	Requires Windows Vista or Windows XP.
Server	Requires Windows Server 2008.
Version	Requires Forefront Threat Management Gateway (TMG).
IDL	Declared in Msfpccom.idl.