Microsoft Identity Integration Server 2003 Developer Reference

CSEntry.CommitNewConnector

The CommitNewConnector method finishes the process of creating a connector and adding it to the ConnectorCollection object. This method is not available in the IMAExtensibleCallExport.ExportEntry(ModificationType, String[], CSEntry) method. 
[C#]
public void CommitNewConnector();

[Visual Basic .NET]
Public Sub CommitNewConnector()

Parameters

This method has no parameters.

Return Values

This method has no return values.

Exceptions

Exception type Condition
AttributeNotPresentException The attributes that contribute to the anchor are not set.
InvalidOperationException The DN property on the new connector has not been set.
MissingParentObjectException The rules extension has attempted to add a connector with a non-existent parent object.
NoCompatiblePartitionFoundException The rules extension attempts to add a connector that does not file the filter criteria for any partitions of the management agent.
ObjectAlreadyExistsException The rules extension attempts to add a connector where a CSEntry object with the specified distinguished name already exists in that connector space.

Remarks

After creating the connector with the ConnectorCollection.StartNewConnector method, call this method to add the new connector. If you do not call this method, the object is rolled back to the original attribute values.

Do not call this method when a management agent is in the process of being deleted.

Be aware that the attributes you set on the CSEntry object in the Provision method depend upon the data source to which the metaverse entry attributes are exported.

Because different management agents require different (relative) distinguished name formats, this method handles distinguished names based upon the type of management agent. The types are database management agents; XML without LDAP-style distinguished names; and the management agents that are neither database nor XML.

Management agent type Distinguished name handling notes
Database
  • The DN property is writeable between the calls to StartNewConnector(String) and CommitNewConnector, and the process may set it.
  • If the DN property is set, then the DN is considered a temporary DN.
  • If the DN property is not set, then a DN is constructed from anchor attributes. All attributes that contribute to the anchor must have been added to the CSEntry before the call to CommitNewConnector. If any of those attributes were not set, an AttributeNotPresentException exception is thrown. The values of the anchor attributes are combined to create the DN for the object. For details, see EscapeDNComponent.
  • After CommitNewConnector is called, the DN property is read-only.
XML
  • The DN property on the new connector is marked as read-only and thus cannot be set by your process.
  • The DN is constructed from the anchor attributes, and that behavior is exactly the same as the database case.
  • The DN property remains read-only after the call to CommitNewConnector.
All other types
  • The DN property on the new connector is writeable and must be set before the call to CommitNewConnector. If the DN property has not been set, CommitNewConnector throws an InvalidOperationException exception.
  • The DN property can be modified after the call to CommitNewConnector, in which case it is treated as a rename on the object.

Requirements

Product: Microsoft Identity Integration Server 2003
Namespace: Defined in Microsoft.MetadirectoryServices.
Assembly: Requires Microsoft.MetadirectoryServices (in Microsoft.MetadirectoryServices.dll).
.NET Framework: Requires .NET Framework 1.1.

See Also

ConnectorCollection, CSEntry, IMAExtensibleCallExport.ExportEntry(ModificationType, String[], CSEntry)