Export (0) Print
Expand All

FPCLdapMatchingPattern

Internet Security and Acceleration Server 2004/2006 SDK

The 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, ISA Server queries the LDAP servers in the associated LDAP server set to authenticate the user. (This object is introduced in ISA Server 2006.)

When Active Directory® directory service authentication is required and the ISA Server computer belongs to a workgroup or to a domain in a forest other than the one that contains the user's account, the ISA Server 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, ISA Server 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), ISA Server tests the logon string patterns in the list of logon string patterns to find a pattern that matches the user name supplied by the user. When a match is found, ISA Server uses the LDAP server set specified in the LDAPServersSet property 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, ISA Server adds the default domain of the Web listener to the user name. (For example, stephanie becomes contoso\stephanie.)

The logon string pattern specified in the PatternString property may contain asterisks, as in contoso\* and *@domain.com.

The FPCLdapMatchingPattern object is an element of an FPCLdapMatchingPatterns collection, and a new object representing an LDAP server can be created by calling the Add method of this 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 XML documents.

Methods

The FPCLdapMatchingPattern object defines the following method.

Method Description
SetLDAPServersSet Sets the LDAP server set that will be associated with the logon string pattern.

Properties

The FPCLdapMatchingPattern object has the following properties.

Property Description
LDAPServersSet Gets an FPCRef object that references the FPCLDAPServersSet collection representing the LDAP server set associated with the logon string pattern.
Order Gets the ordinal position of the logon string pattern in the list of logon string patterns, which corresponds to the order in which the logon string patterns are tested to find the matching LDAP server set.
PatternString Gets or sets the logon string pattern.

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

Interfaces for C++ Programming

This object implements the IFPCLdapMatchingPattern interface.

Requirements

Client Requires Windows XP.
Server Requires Windows Server 2003.
Version Requires Internet Security and Acceleration Server 2006.
IDL

Declared in Msfpccom.idl.

See Also

COM Objects

Show:
© 2014 Microsoft