NCLHELP.HLB  —  Directory Module, DSA  Superior Reference
 A Superior Reference entity provides a reference to a DSA that
 holds a naming context that is higher in the DIT than all of
 the naming contexts held locally.

 The DSA that holds superior information should have further
 knowledge information that enables the user request to be
 redirected to the relevant DSA. Such a DSA might have
 knowledge about parts of the DIT that this DSA does not know
 about.

1  –  Characteristics

 A Superior Reference entity has one characteristic attribute:
 Access Point.

 You can use the ADD, SET, SHOW and REMOVE directives on this
 attribute.

 Syntax:

 ADD DSA SUPERIOR REFERENCE ACCESS POINT {<value>}
 REMOVE DSA SUPERIOR REFERENCE ACCESS POINT {<value>}
 SET DSA SUPERIOR REFERENCE ACCESS POINT {<value>}
 SHOW DSA SUPERIOR REFERENCE ACCESS POINT

 where <value> is the value. The Access Point attribute is
 single-valued.

1.1  –  Access Point

 This specifies the Access Point of the DSA which holds
 a naming context which is superior to all of the naming
 contexts held within this DSA. There is no default value.
 The attribute is single-valued.

 Syntax:

 ADD    DSA SUPERIOR REFERENCE ACCESS POINT {<value>}
 REMOVE DSA SUPERIOR REFERENCE ACCESS POINT {<value>}
 SET    DSA SUPERIOR REFERENCE ACCESS POINT {<value>}
 SHOW   DSA SUPERIOR REFERENCE ACCESS POINT

 where <value> is the access point of a DSA that holds a master
 copy of a naming context that is higher than all naming contexts
 on this DSA, and is specified as follows:

    [ae title  = "<distinguished name of DSA>",
      presentation address = '<presentation address>']

 The AE Title and Presentation Address attributes are both
 mandatory. Note that you must specify the AE Title and
 Presentation Address in the order shown above.

 Specify all valid NSAPs for the DSA in the access point. This
 improves the network efficiency of the DSA, ensuring that if
 a connection to the relevant DSA already exists, it is always
 re-used.

 Refer to DSA Common_Datatypes for more information
 on how to specify an AE Title and a Presentation Address.

2  –  Directives

 You can use the CREATE, DELETE, SET and SHOW directives
 with the Superior Reference entity.

 The CREATE and DELETE directives are used to create and delete a
 Superior Reference entity.

 The SET and SHOW directives are used to set or display the Superior
 Reference characteristic attribute, respectively.

 Note that the only characteristic attribute of the Superior Reference
 entity is single valued. The ADD and REMOVE directives can therefore
 only be used to remove the single value, or to add a value if there is
 no existing value.

2.1  –  ADD

 Use the ADD directive to add value to the
 Access Point attribute if it does not already have one.

 Syntax:

 ADD DSA SUPERIOR REFERENCE <attr> {<value>}

 where <attr> is the name of the Characteristic
 attribute and <value> is the value you want to add to
 the attribute. Note that the Access Point attribute
 is single-valued, so you can only use the ADD directive
 if the Access Point currently has no value.

2.2  –  CREATE

 Use this directive to create a Superior Reference entity.

 Syntax:

 	CREATE DSA SUPERIOR REFERENCE <argument> <value>

2.2.1  –  Arguments

 The CREATE directive has one argument: ACCESS POINT. This argument
 is optional, although a Superior Reference entity without an
 Access Point attribute serves no purpose. You can specify the
 Access Point attribute using the SET directive instead.

 The ACCESS POINT argument identifies a DSA holding a naming context
 which is superior to all the naming contexts contained within this
 DSA. Specify the ACCESS POINT argument in the following format:

 	ACCESS POINT  <access point>

 where <access point> is the access point of the DSA and is
 specified as follows:

    {[ae title  = "<distinguished name of DSA>",
      presentation address = '<presentation address>']}

 The AE Title and Presentation Address attributes are both mandatory.
 Note that you must specify the AE Title and Presentation
 Address in the order shown above.

 Specify all valid NSAPs for the DSA in the access point. This
 improves the network efficiency of the DSA, ensuring that if
 a connection to the relevant DSA already exists, it is always
 re-used.

 Refer to DSA Common_Datatypes for more information on
 how to specify an AE Title and a Presentation Address.

2.2.2  –  Errors

 The CREATE directive returns one of the following errors:

 REASON:         Already Exists
 DESCRIPTION:    The Superior Reference entity already exists.

 REASON:         Wrong State
 DESCRIPTION:    The DSA entity is not in the correct state.

 The DSA entity must be in state ON, ENABLING, DISABLING
 or OFF when you create a Superior Reference entity.
 Any other state causes a failure. The response indicates the
 current state of the DSA.

2.3  –  DELETE

 Use this directive to delete the Superior Reference entity.

 Syntax:

 	DELETE DSA SUPERIOR REFERENCE

2.3.1  –  Errors

 The Delete directive returns one error only:

 REASON:         Wrong State
 DESCRIPTION:    The DSA entity is not in the correct state.

 The DSA entity must be in state ON, ENABLING, DISABLING or
 OFF when you delete a Superior Reference entity. Any other
 state causes a failure. The response indicates the current
 state of the DSA.

2.4  –  Examples

  >  CREATE DSA SUPERIOR REFERENCE  -
  _>  ACCESS POINT {[AE Title="/C=US/O=Abacus/CN=DSA5", -
  _>   Pres Addr='"DSA"/"DSA"/"DSA"/NS+49002aaa000400888888']}

  > SHOW DSA SUPERIOR REFERENCE ALL ATTRIBUTES

 The first command creates a Superior Reference entity and
 defines the access point of the DSA which holds a naming
 context superior to all naming contexts contained within
 this DSA. Note that the command specifies no identifier
 for the Superior Reference entity.

 The second command displays the Superior Reference entity.

  > DELETE DSA SUPERIOR REFERENCE

 This command deletes the Superior Reference entity.

2.5  –  REMOVE

 Use the REMOVE directive to remove a value from
 the Access Point attribute.

 Syntax:

 REMOVE DSA SUPERIOR REFERENCE <attr> {<value>}

 where <attr> is the name of the Characteristic
 attribute and <value> is the value of the attribute.
 Note that the Access Point attribute is single-valued,
 so there is only ever one value for you to remove.

2.6  –  SET

 Use the SET directive to change the value of the Superior
 Reference characteristic attribute.

 Syntax:

 SET DSA SUPERIOR REFERENCE ACCESS POINT  {<value>}

 where <value> is the value you want to set for the attribute.

2.7  –  SHOW

 Use the SHOW directive to display the characteristic attribute
 of a Superior Reference entity.

 Syntax:

 SHOW DSA SUPERIOR REFERENCE ACCESS POINT
Close Help