FPCWebListenerProperties Object

The FPCWebListenerProperties object provides access to the properties of a Web listener for incoming Web requests or outgoing Web requests.

A Web listener can be configured to use Basic authentication, Digest authentication, Advanced Digest authentication, Integrated authentication, or Secure Sockets Layer (SSL) certificate authentication, or any combination of these built-in Windows authentication methods to authenticate Web requests. Alternatively, a Web listener can be configured to use an authentication scheme defined by an FPCAuthenticationScheme object for authentication. The following authentication schemes are supplied with Forefront TMG:

Note   The Web listener for outgoing Web requests sent from a network can be configured to use only the built-in Windows authentication methods or the RADIUS authentication scheme.

This object can be accessed through the Properties property of an FPCWebListener object, where it contains the properties of a Web listener for incoming Web requests, and through the WebListenerProperties property of an FPCNetwork object, where it contains the properties of the Web listener for outgoing Web requests sent from the network.

Click here to see the Forefront TMG object hierarchy.

Methods

The FPCWebListenerProperties object defines the following methods.

Method Description

Refresh

Recursively reads all the properties of the Web listener from persistent storage, overwriting any changes that were not saved.

Save

Recursively writes the current values of all of the object's properties, including all the properties of its subobject and its elements, to persistent storage.

Properties

The FPCWebListenerProperties object defines the following properties.

Property Description

AllowAuthenticationOverHTTP

Gets or sets a Boolean value that indicates whether the Web listener allows client authentication over HTTP.

AlwaysAuthenticate

Gets or sets a Boolean value that indicates whether the Forefront TMG Web proxy always requires authentication before processing a request even if the policy does not require authentication.

AppliedSSLCertificates

Gets an FPCAppliedSSLCertificates collection that contains the SSL server certificates used to authenticate the Forefront TMG computer when a client connects to the Web listener through the SSL port.

AuthenticationSchemes

Gets an FPCRefs collection that contains references to the FPCAuthenticationScheme objects defining the authentication schemes available to the Web listener.

BasicAuthentication

Gets or sets a Boolean value that indicates whether Basic authentication is used.

BasicAuthPersistSingleRequest

Gets or sets a Boolean value that indicates whether Basic authentication persists across requests, thereby lasting throughout a session.

ClientCredentialsTimeout

Gets or sets the client credentials time-out period, in seconds, for the Web listener.

ConnectionTimeout

Gets or sets the time, in seconds, of inactivity allowed on a connection before the connection is closed.

DigestAuthentication

Gets or sets a Boolean value that indicates whether Digest authentication is used.

DigestAuthPersistSingleRequest

Gets or sets a Boolean value that indicates whether Digest authentication persists across requests, thereby lasting throughout a session.

DomainForAuthentication

Gets or sets the name of the domain for Basic authentication, Digest authentication, or an authentication scheme.

FormsBasedAuthenticationProperties

Gets an FPCFormsBasedAuthenticationProperties object that holds the forms-based authentication configuration settings for the Web listener.

IntegratedAuthPersistSingleRequest

Gets or sets a Boolean value that indicates whether authentication persists only within a single request when Integrated authentication is used.

IntegratedWindowsAuthentication

Gets or sets a Boolean value that indicates whether Windows Integrated authentication is used.

NumberOfConnections

Gets or sets the number of concurrent connections that may be accepted by the Web listener.

RedirectHTTPAsHTTPS

Gets a value from the FpcRedirectHTTPAsHTTPS enumerated type that specifies whether the Web proxy will redirect HTTP requests as HTTPS requests..

ResolveInArray

Gets or sets a Boolean value that indicates whether the Web proxy will attempt to retrieve the requested object from the cache of the current array using the Cache Array Routing Protocol (CARP) algorithm.

ReturnAuthRequiredIfAuthUserDenied

Gets or sets a Boolean value that indicates whether to return a Proxy Authentication Required message when a user is authenticated by the Web proxy but is denied access by the rules.

SingleRadiusServerAuthPerSession

Gets or sets a Boolean value that indicates whether the Forefront TMG Web proxy will validate user credentials with a RADIUS server to authenticate the user only once during a TCP connection or on each request.

SSLAcceleratorPort

Gets or sets the Secure Sockets Layer (SSL) accelerator port for the Web listener.

SSLCertificateAuthentication

Gets or sets a Boolean value that indicates whether SSL certificate authentication is used.

SSLClientCertificateRestrictions

Gets the FPCSSLClientCertificateRestrictions collection that contains the requirements for the SSL client certificates that the Web listener will accept for authentication.

SSLClientCertificateRestrictionsEnabled

Gets or sets a Boolean value that indicates whether the SSL client certificate restrictions configured for the Web listener are enabled.

SSLClientCertificatesIntermediateTrustList

Gets an FPCAppliedSSLCertificates collection that contains objects representing the SSL certificates in the Intermediate Certification Authorities store that the Web listener may use.

SSLClientCertificatesRootTrustList

Gets an FPCAppliedSSLCertificates collection that contains objects representing the SSL certificates in the Trusted Root Certification Authorities store that the Web listener may use.

SSLClientCertificateTimeout

Gets or sets the SSL client certificate time-out period, in seconds, for the Web listener.

SSLClientCertificateTimeoutEnabled

Gets or sets a Boolean value that indicates whether the SSL client certificate time-out period is enabled for the Web listener.

SSLPort

Gets or sets the SSL port for the Web listener.

SSLTerminationMode

Gets or sets a value from the FpcSSLTerminationMode enumerated type that specifies how SSL connections are terminated.

SSODomainNames

Gets an FPCDomainNameSet collection that contains the domain names used for single sign on (SSO).

SSOEnabled

Gets or sets a Boolean value that indicates whether single sign on (SSO) is enabled for the Web listener.

TCPPort

Gets or sets the TCP port for the Web listener.

UnlimitedNumberOfConnections

Gets or sets a Boolean value that indicates whether the Web listener may accept an unlimited number of concurrent connections.

UseSSLClientCertificatesTrustList

Gets or sets a Boolean value that indicates whether the Web listener will accept only SSL client certificates issued by the specified trusted certification authorities.

ValidateCredentialsForEveryHTTPRequest

Gets or sets a Boolean value that indicates whether client credentials will be validated for every HTTP request.

Interfaces for C++ Programming

This object implements the IFPCWebListenerProperties, IFPCWebListenerProperties2, and IFPCWebListenerProperties3 interfaces.

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.

See Also

COM Objects


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.

[an error occurred while processing this directive]