delete

Specifies an input that deletes an entry in the target application.

Description

The delete command is an input command or event. It is used for the following tasks:

  • The DirXML engine sends the delete command to the subscriber shim to request that the external application delete an entry. The delete command must contain an association element.
  • The publisher shim sends the delete command as an event notification that an entry has been deleted in the external application. When the delete command is used for event notification, it must contain an association element.

Definition

  <!ELEMENT delete          (association?)> 
  <!ATTLIST delete 
              src-dn          CDATA            #IMPLIED 
              src-entry-id    CDATA            #IMPLIED 
              dest-dn         CDATA            #IMPLIED 
              dest-entry-id   CDATA            #IMPLIED 
              class-name      CDATA            #IMPLIED 
              event-id        CDATA            #IMPLIED>

Attributes

src-dn
Specifies the distinguished name of the entry to delete, in the name space of the sender.
src-entry-id
Specifies the entry ID of the entry that is being deleted. It is used internally by the DirXML engine and should be ignored by the driver.
dest-dn
Specifies the distinguished name of the entry in the name space of the receiver. For events, the driver should leave it empty.
dest-entry-id
Specifies the entry ID for the entry in the name space of the receiver. For events, the driver should leave it empty.
class-name
Specifies the base class of the entry being deleted.
event-id
Specifies an identifier used to identify a particular instance of the command or event.

Elements

association
Specifies the unique identifier for the entry in the external application.

Request Format

Command

The DirXML engine sends the following information to the subscriber shim with the delete command:

  • <association>
  • src-dn
  • event-id

Event

The publisher shim sends the following information to the DirXML engine with a delete event:

  • <association>
  • src-dn (optional, but encouraged)
  • class-name (optional, but encouraged)
  • event-id (optional)

Reply Format

The receiving application should respond to a <delete> command or event with a <status> element indicating whether the <delete> was processed successfully.

Parent

Example

The following example shows a <delete> element as an input from the driver.

  <delete class-name="User" src-dn="\Sam">
     <association>1012</association>
  </delete>