FPCLdapMatchingPatterns Collection

Article
08/13/2010

The FPCLdapMatchingPatterns collection contains an ordered set of all the FPCLdapMatchingPattern objects defined in a Forefront TMG array. Each FPCLdapMatchingPattern object represents a logon string pattern that is mapped to a Lightweight Directory Access Protocol (LDAP) server set. When the logon string supplied by an LDAP user matches the pattern specified in one of the FPCLdapMatchingPattern objects, Forefront TMG queries the LDAP servers in the associated LDAP server set to authenticate the user.

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 in this collection to find a pattern that matches the user name supplied by the user. When a match is found, Forefront TMG uses the LDAP server set specified in the LDAPServersSet property of the matching FPCLdapMatchingPattern object to authenticate the user. If no match is found, authentication fails. Note that if the user name does not contain any slash (\) or at sign (@) characters, Forefront TMG adds the default domain of the Web listener to the user name. (For example, stephanie becomes contoso\stephanie.)

The logon string pattern specified in an FPCLdapMatchingPattern object may contain asterisks, as in contoso\* and *@domain.com.

The FPCLdapMatchingPatterns collection is accessed through the LdapMatchingPatterns property of the FPCRuleElements object.

Dd436155.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 FPCLdapMatchingPatterns collection defines the following methods.

Method	Description
Add	Creates a new FPCLdapMatchingPattern object in the collection and returns a reference to it.
Item	Retrieves the requested FPCLdapMatchingPattern object from the collection.
MoveDown	Moves the specified logon string pattern one step down the list of logon string patterns, which corresponds to the order in which the logon string patterns are tested to find the matching pattern and the associated LDAP server set.
MoveUp	Moves the specified logon string pattern one step up the list of logon string patterns, which corresponds to the order in which the logon string patterns are tested to find the matching pattern and the associated LDAP server set.
Remove	Removes the specified FPCLdapMatchingPattern object from the collection.

Properties

The FPCLdapMatchingPatterns collection defines the following properties.

Property	Description
_NewEnum	Gets an enumerator object for the collection.
Count	Gets the number of FPCLdapMatchingPattern 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 object's properties can be imported from the specified XML document.
Export	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties 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 of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties 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 of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties 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 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.
VendorParameterSets	Gets an FPCVendorParametersSets object that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This collection implements the IFPCLdapMatchingPatterns 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.