FPCLdapServersSet Collection

Article
08/13/2010

The FPCLdapServersSet collection contains an ordered set of FPCLdapServer objects. Each FPCLdapServer object represents a Lightweight Directory Access Protocol (LDAP) server that Forefront TMG computers belonging to a workgroup can use for authenticating domain users.

When Active Directory® directory service authentication is required and the Forefront TMG computer belongs to a workgroup or to a domain in a forest other than the one that contains the user's account, the Forefront TMG computer must connect to a domain controller over an LDAP protocol (LDAP, LDAPS, LDAP-GC, and LDAPS-GC are supported) to authenticate the user, and the domain controller acts as an LDAP server. Because each domain controller is only able to authenticate the users in its domain, Forefront TMG by default queries the global catalog for the forest to validate the user's credentials. The user must enter credentials recognized by Active Directory in one of these formats:

SAM account name (domain\username)
User principal name (username@domain.com)
Distinguished name

When an LDAP user supplies a user name in one of these formats (for example, contoso\stephanie or stephanie@contoso.com), Forefront TMG tests the logon string patterns defined in the FPCLdapMatchingPatterns collection to find a pattern that matches the user name supplied by the user. When a match is found, Forefront TMG attempts to establish a connection with an LDAP server defined in the LDAP server set associated with the matching logon string pattern in the order defined by the collection using the credentials specified in the Credentials property, and after a connection with an LDAP server is established, Forefront TMG sends a query to validate the user using the credentials supplied by the user. If no matching logon string pattern is found, authentication fails.

The FPCLdapServersSet collection representing the LDAP server set associated with a specific logon string pattern is referenced through the FPCRef object held in the LDAPServersSet property of the applicable FPCLdapMatchingPattern object.

The FPCLdapServersSet collection is an element of an FPCLdapServersSets collection, and a new collection representing an LDAP server set can be created by calling the Add method of the FPCLdapServersSets collection.

Each FPCLdapServersSet collection can be assigned to a specific group of users.

Dd436174.bkbutton(en-us,MSDN.10).png 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 an object's data to and importing it from XML documents.

Methods

The FPCLdapServersSet collection defines the following methods.

Method	Description
Add	Creates a new FPCLdapServer object in the collection and returns a reference to it.
Item	Retrieves the requested FPCLdapServer object from the collection.
MoveDown	Moves the specified server one step down the list of LDAP servers, which corresponds to the order in which LDAP servers handle an authentication request.
MoveUp	Moves the specified server one step up the list of LDAP servers, which corresponds to the order in which LDAP servers handle an authentication request.
Remove	Removes the specified FPCLdapServer object from the collection.

Properties

The FPCLdapServersSet collection defines the following properties.

Property	Description
_NewEnum	Gets an enumerator object for the collection.
Count	Gets the number of FPCLdapServer objects in the collection.
Credentials	Gets an FPCCredentials object that represents the credentials to be supplied by the Forefront TMG computer for authenticating a connection to an LDAP server in the collection.
Domain	Gets or sets the domain that will be the starting point for directory searches on the LDAP servers.
Name	Gets or sets the name of the LDAP server set.

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 and its elements can be imported from the specified XML document.
Export	Writes the stored values of all the properties of the collection and its elements to the specified XML document.
ExportToFile	Writes the stored values of all the properties of the collection and its elements 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	Copies the values of all the properties of the collection and its elements from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all the properties of the collection and its elements 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	Reads the values of all the properties of the collection and its elements from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all the properties of the collection and its elements to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the collection 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 object that can hold sets of custom data for extending the collection.

Interfaces for C++ Programming

This collection implements the IFPCLdapServersSet interface.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.