rename

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

Description

The rename command is an input command or event. It renames the entry; it cannot move an entry from one container to another in a hierarchical database. It is used for the following tasks:

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

Definition

  <!ELEMENT rename          (association?, new-name)>
  <!ATTLIST rename
            src-dn           CDATA           #IMPLIED
            src-entry-id     CDATA           #IMPLIED
            dest-dn          CDATA           #IMPLIED
            dest-entry-id    CDATA           #IMPLIED
            old-src-dn       CDATA           #IMPLIED
            remove-old-name  (%Boolean;)     "true"
            class-name       CDATA           #IMPLIED
            event-id         CDATA           #IMPLIED>
  
  <!ELEMENT new-name         (#PCDATA)>

Attributes

src-dn
Specifies the new distinguished name of the entry 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-dn
Specifies the old distinguished name of the entry in the name space of the sender.
remove-old-name
Specifies whether the old relative distinguished name should be deleted or retained. If not specified, defaults to "true" which removes the old name.
class-name
Specifies the base class of the entry being renamed.
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.
<new-name>
Specifies the new relative distinguished name for the entry.

Request Format

Command

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

  • <association>
  • src-dn which is the new distinguished name after the change
  • old-src-dn which is the distinguished name before the change
  • remove-old-name which determines whether the old name value is retained. This may not be relevant to a particular external application.
  • class-name
  • event-id
  • <new-name> which is the new relative distinguished name of the entry

Event

The publisher shim sends the following information with a rename command to the DirXML engine:

  • <association>
  • src-dn which is the new distinguished name after the change
  • remove-old-name which determines whether the old name value is retained. If not specified, defaults to removing the old name value.
  • class-name
  • event-id (optional)
  • <new-name> which is the new relative distinguished name of the entry

Reply Format

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

Parent

Example

  <rename class-name="User" src-dn="\Samuel" old-src-dn="\Sam">
     <association>1012</association>
     <new-name>Samuel</new-name>
  </rename>