move

Specifies an input that moves an entry from one container to another.

Description

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

  • The DirXML engine sends the move command to the subscriber shim to request that the external application move an entry from one container to another. The move command must contain an <association> element.
  • The publisher shim sends a move event as notification that an entry has been moved to a different container in the external application. When the move command is used for event notification, it must contain an <association> element.

Definition

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

Attributes

src-dn
Specifies the distinguished name of the entry, after the move, in the name space of the sender.
src-entry-id
Specifies the entry ID of the entry in the name space of the sender. 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. It is used internally by the DirXML engine and should be ignored by the driver.
dest-entry-id
Specifies the entry ID of the entry in the name space of the receiver. It is used internally by the DirXML engine and should be ignored by the driver.
old-src-name
Specifies the distinguished name of the entry, before the move, in the name space of the sender.
class-name
Specifies the base class of the entry being moved.
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.
parent
Specifies the new container for the entry.

Request Format

Command

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

  • src-dn which is the new distinguished name after the move
  • old-src-dn which is the name before the move
  • class-name
  • event-id
  • <association>
  • <parent>
    • src-dn which is the parent name after the move
    • <association> of the parent if one exists. If one doesn't exist, the subscriber shim should return a status level of warning and not move the entry.

Event

The driver sends the following information with a move event to the DirXML engine:

  • class-name
  • event-id (optional)
  • <association> of the entry to move
  • <parent>
    • <association> of the parent

Reply Format

The receiving application should respond to the move command with a status command indicating whether the move was processed successfully.

Parent

Example

The following example illustrates a move command sent by the driver to the DirXML engine.

  <move class-name="User" src-dn="\Users\Samuel" old-src-dn="\Samuel">
     <association>1012</association>
     <parent src-dn="\Users\">
        <association>1013</association>
     </parent>
  </move>