FPCPrimaryRoute
Internet Security and Acceleration Server 2004/2006 SDK
The FPCPrimaryRoute object represents the primary route used to route requests from Web proxy clients. The primary route can be direct to the requested destination, it can include an upstream proxy server, or it can redirect Web proxy client requests to a specified host. If the upstream proxy server on the primary route is running ISA Server Enterprise Edition, the Web requests can be directed to other members of its array.
This object is accessed through the PrimaryRoute property of an FPCRoutingRule object.
Click here to see the ISA Server object hierarchy.
Methods
The FPCPrimaryRoute object defines the following methods.
| Method | Description |
|---|---|
| Refresh | Recursively reads all of the properties of the object and of its subobjects from persistent storage, overwriting any changes made after the last call to the Save method. |
| Save | Recursively writes the current values of all properties of the object and its subobjects to persistent storage. |
| SetAutoPollConfig | Sets the configuration for automatic polling of the upstream proxy server on the primary route for information about the availability of upstream array members. |
| SetRedirectHostAndPorts | Sets the name of the host for redirecting requests from Web proxy clients and the ports on which it listens. |
| SetServerAndPort | Sets the name of the upstream proxy server on the primary route and the ports on which it listens. |
Properties
The FPCPrimaryRoute object has the following properties.
| Property | Description |
|---|---|
| AuthenticationEnabled | Gets or sets a Boolean value that indicates whether the authentication of downstream clients by the upstream proxy server on the primary route is enabled. |
| AuthenticationType | Gets or sets a value from the FpcAuthType enumerated type that specifies the type of authentication that the upstream proxy server on the primary route uses if authentication is enabled. |
| AutomaticPollConfig | Gets a Boolean value that indicates whether polling of the upstream server for information about the availability of upstream array members on the primary route is enabled. |
| BackupRoute | Gets an FPCBackupRoute object that represents the backup route, which is used to route Web proxy client requests when the upstream proxy server on the primary route is unavailable. |
| Credentials | Gets an FPCCredentials object that represents the credentials to be supplied by the ISA Server computer for authenticating a connection to the upstream proxy server on the primary route. |
| EnableAutoDial | Gets or sets a Boolean value that indicates whether automatic dialing is enabled. |
| PollAtUrl | Gets the URL at which to poll for information about the availability of upstream array members on the primary route. This property is valid only if the AutomaticPollConfig property is set to True. |
| RedirectHost | Gets the name of the host for redirecting requests from Web proxy clients. |
| RedirectHostPort | Gets the port on which the host for redirecting requests from Web proxy clients listens. |
| RedirectHostSSLPort | Gets the port on which the host for redirecting requests from Web proxy clients listens for SSL connections. |
| RouteServerName | Gets the name of the upstream proxy server on the primary route. |
| RouteServerPort | Gets the port on which the upstream proxy server on the primary route listens. |
| RouteServerSSLPort | Gets the port on which the upstream proxy server on the primary route listens for SSL connections. |
| RouteType | Gets or sets a value from the FpcPrimaryRouteType enumerated type that specifies whether requests from Web proxy clients are sent directly to the requested destination, to an upstream proxy server, or to a specified host. |
Interfaces for C++ Programming
This object implements the IFPCPrimaryRoute interface.
Requirements
| Client | Requires Windows XP. |
|---|---|
| Server | Requires Windows Server 2003. Requires Windows Server 2003 or Windows 2000 for ISA Server 2004 Standard Edition. |
| Version | Requires Internet Security and Acceleration (ISA) Server 2006 or ISA Server 2004. |
| IDL | Declared in Msfpccom.idl. |
