class EnsLib.LDAP.Message.EntityIdentification
extends %RegisteredObject
Super class for Message types that are identified with DN or CN and Parent or Base
Base class for operation messages
Base class to LDAP request messages used by operation EnsLib.LDAP.Operation.Standard
property Base
as %String(MAXLEN="");
Optional Base
property DN
as %String(MAXLEN="");
Optional Distinguished name of object
If not specified the Distinguished name used in the request
is calculated from the other properties.
property Parent
as %String(MAXLEN="");
Optional Parent of CN
property RDN
as %String(MAXLEN="");
Relative Distinguished Name of object.
Includes naming attribute but if not specified cn is used
method CalculatedDN(pDefaultBaseDN As %String = "", pEscapeDN As %Boolean = 1)
as %String
Method used to calculate Distinguished Name from the properties
The first parameter can be used to provide a default base that will
be used if RDN is specified but Parent and Base are empty
The second parameter is used to control whether the CalculatedDN ought to be
escaped as per RFC4514 https://www.ietf.org/rfc/rfc4514.txt.
The default is to escape
The CalculatedDN is returned As follows:
If the property DN is not empty it is returned.
If the property DN is empty then the value of the
property RDN becomes the first part of the returned value
and is then prepended to
the value of the Parent and returned.
If Parent is empty then RDN is preprended to
Base and returned.
If Base is empty then RDN is preprended to
parameter pDefaultBaseDN and returned.