Microsoft Internet Security and Acceleration Server 2004 SDK

FPCRoutingRule

The FPCRoutingRule object represents a single routing rule that has been defined in an ISA Server array. Routing rules determine whether a Web proxy client request is sent directly to the Internet, to another upstream proxy server, or to an alternate destination. You can use this object to access all attributes of each routing rule defined in an array.

This object is typically an element of an FPCRoutingRules collection.

Click here to see the ISA Server object hierarchy.

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 an object's data to and importing it from an XML document.

Methods

This object has no methods.

Properties

The FPCRoutingRule object has the following properties.

Property Description
DelegateBasicCredentials Gets or sets a Boolean value that indicates whether basic credentials are delegated.
Description Gets or sets the description of the rule.
DestinationDomainNameSets Gets an FPCRefs collection that contains references to the FPCDomainNameSet collections defining the domain name sets to which the rule applies as destinations.
DestinationSelectionIPs Gets an FPCSelectionIPs object that specifies the complete set of destination IP addresses to which the rule applies.
Enabled Gets or sets a Boolean value that indicates whether this rule is enabled.
IsDefault Gets a Boolean value that indicates whether the rule is preinstalled and cannot be deleted.
Name Gets or sets the name of the rule.
NonSecureProtocolRedirection Gets or sets the protocol used when delegating a request that came on a nonsecure channel.
Order Gets the ordinal position of the rule in the list of routing rules, which corresponds to their order of application.
PrimaryRoute Gets an FPCPrimaryRoute object that represents the primary route used to route requests from Web proxy clients.
SecureProtocolRedirection Gets or sets the protocol used when delegating a request that came on a secure channel.
SSLClientCertificate Gets or sets an FPCCertificate object that represents the SSL client certificate to use when the ISA Server Web proxy authenticates to the published server.
SSLRequireSecureChannel Gets or sets a value from the FpcSSLRequireSecureChannelMode enumerated type that indicates whether a secure channel is required and whether 128-bit encryption is required.
URLSets Gets an FPCRefs collection that contains references to the FPCURLSet collections defining the URL sets to which the rule applies.

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.
VendorParametersSets Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the object.

Remarks

This object implements the IFPCRoutingRule interface.

Requirements

Server: Requires Windows Server 2003 or Windows 2000.
Version: Requires Internet Security and Acceleration Server 2004.
Header: Declared in Msfpccom.idl.
Library: Use Microsoft Internet Security and Acceleration Server 2004 Administration Library.

See Also

COM Objects