Class OrganizationalUnit


  • public class OrganizationalUnit
    extends Object
    This class contains the container node for the OpenLDAP Directory Information Tree. A container node is used to group other related nodes, i.e. 'ou=People' or 'ou'Roles'.
    The organizational unit object class is 'organizationalUnit'

    organizational unit structural object class is used to organize groups of nodes within the DIT.

    • ------------------------------------------
    • #Standard object class from RFC2256
    • objectclass ( 2.5.6.5 NAME 'organizationalUnit'
    • DESC 'RFC2256: an organizational unit'
    • SUP top STRUCTURAL
    • MUST ou
    • MAY ( userPassword $ searchGuide $ seeAlso $ businessCategory $
    • x121Address $ registeredAddress $ destinationIndicator $
    • preferredDeliveryMethod $ telexNumber $ teletexTerminalIdentifier $
    • telephoneNumber $ internationaliSDNNumber $
    • facsimileTelephoneNumber $ street $ postOfficeBox $ postalCode $
    • postalAddress $ physicalDeliveryOfficeName $ st $ l $ description ) )
    • ------------------------------------------
    Author:
    Apache Directory Project
    • Constructor Detail

      • OrganizationalUnit

        public OrganizationalUnit​(String name,
                                  String description)
        Generate instance of organizational unit object to be loaded as container node.
        Parameters:
        name - required attribute must be unique for rDn level and maps to 'ou' attribute in 'organizationalUnit' object class.
        description - maps optional attribute maps to name in 'organizationalUnit' object class.
      • OrganizationalUnit

        public OrganizationalUnit()
        Default constructor generates instance of organizational unit object to be loaded as container node. The object cannot be used until 'name' value is set.
    • Method Detail

      • getContextId

        public String getContextId()
      • setContextId

        public void setContextId​(String contextId)
      • getName

        public String getName()
        Get the required name attribute from the entity. This attribute must be unique for the level of tree it is set.
        Returns:
        required attribute must be unique for rDn level and maps to 'ou' attribute in 'organizationalUnit' object class.
      • setName

        public void setName​(String name)
        Set the required name attribute in the entity. This attribute must be unique for the level of tree it is set.
        Parameters:
        name - is required attribute and must be unique for rDn level and maps to 'ou' attribute in 'organizationalUnit' object class.
      • getDescription

        public String getDescription()
        Get the description for the organizational unit object. This value is not required or constrained but is validated on reasonability.
        Returns:
        field maps to same name attribute on 'organizationalUnit'.
      • setDescription

        public void setDescription​(String description)
        Set the description for the organizational unit object. This value is not required or constrained but is validated on reasonability.
        Parameters:
        description - field maps to same name attribute on 'organizationalUnit'.
      • getParent

        public String getParent()
        Get the optional parent attribute allows nesting of container nodes two levels below suffix. For example, if parent node is created it may be used to subdivide collections of related nodes, dn=ou=Roles, ou=RBAC, dc=companyName, dc=com.
        Returns:
        attribute that contains name of parent node that is used to construct the dn.
      • setParent

        public void setParent​(String parent)
        Set the optional parent attribute allows nesting of container nodes two levels below suffix. For example, if parent node is created it may be used to subdivide collections of related nodes, dn=ou=Roles, ou=RBAC, dc=companyName, dc=com.
        Parameters:
        parent - attribute that contains name of parent node that is used to construct the dn. This maps to 'ou' attribute in parent node's 'organizationalUnit' object class.