Novell Documentation: Novell Nsure Identity Manager Driver Kit

modify

Specifies an input that modifies an entry's attributes.

Description

The <modify> element is an input command or event. It is used for the following tasks:

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

Definition

  <!ELEMENT modify          (association?, modify-attr+)>
  <!ATTLIST modify
             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 modify in the name space of the sender.
src-entry-id: Specifies the entry ID 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.
class-name: Specifies the base class of the entry being modified. This attribute is required for modify events.
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. This element is required for modify events.
modify-attr: Specifies the attributes to modify.

Request Format

Command

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

src-dn
class-name
event-id
<association>
<modify-attr> (1 or more)
- For <remove-value>, 1 or more <value>
- For <add-value>, 1 or more <value>
- For <remove-all-values>, no values

Event

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

src-dn
class-name (required because a modify can turn into an add)
event-id (optional)
<association>
1 or more <modify-attr> elements
- For <add-value>, 1 or more <value> elements
- For <remove-value,> 1 or more <value> elements
- For <remove-all-values>, no values

Reply Format

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

Parent

input

Example

The following example illustrates a <modify> element.

  <modify class-name="User" src-dn="\Sam">
     <association>1012</association>
     <modify-attr attr-name="Given Name">
        <remove-all-values/>
        <add-value>
           <value>Samuel</value>
        </add-value>
     </modify-attr>
     <modify-attr attr-name="Telephone Number">
        <remove-value>
           <value>555-1212</value>
        </remove-value>
        <add-value>
           <value>555-1764</value>
           <value>555-1765</value>
        </add-value>
     </modify-attr>
  </modify>