Class SubEntry


  • public class SubEntry
    extends Object
    This class represents RFC 3672 subentries and RFC 3671 collective attribute subentries objects.
    • Constructor Detail

      • SubEntry

        public SubEntry​(Entry entry)
                 throws LdapException
        Constructs a subentry object from a given entry object.
        Parameters:
        entry - LDAP subentry to construct from.
        Throws:
        LdapException - if there is a problem with constructing a subentry from a given entry.
    • Method Detail

      • getDN

        public final Dn getDN()
        Retrieves the distinguished name for this subentry.
        Returns:
        The distinguished name for this subentry.
      • getEntry

        public final Entry getEntry()
        Getter to retrieve the actual entry object for this subentry.
        Returns:
        entry object for this subentry.
      • isCollectiveOrInheritedCollective

        public boolean isCollectiveOrInheritedCollective()
        Indicates whether this subentry is a collective attribute subentry or an inherited collective attribute subentry.
        Returns:
        true if collective or inherited collective, false otherwise.
      • isInheritedCollective

        public boolean isInheritedCollective()
        Indicates whether this subentry is an inherited collective attribute subentry.
        Returns:
        true if inherited collective, false otherwise.
      • isInheritedFromDNCollective

        public boolean isInheritedFromDNCollective()
        Indicates whether this subentry is inherited from DN collective attribute subentry.
        Returns:
        true if inherited from DN collective, false otherwise.
      • isInheritedFromRDNCollective

        public boolean isInheritedFromRDNCollective()
        Indicates whether this subentry is inherited from RDN collective attribute subentry.
        Returns:
        true if inherited from RDN collective, false otherwise.
      • getInheritFromDNType

        public AttributeType getInheritFromDNType()
        Returns the attribute type where to find the DN of the entry from which to inherit collective attributes

        Only valid when:

        1. isInheritedCollective() returns true.
        2. isInheritedFromDNCollective() returns true.
        Returns:
        the attribute type where to find the DN of an entry, or null if there is none.
      • getInheritFromRDNAttrType

        public AttributeType getInheritFromRDNAttrType()
        Getter to retrieve inheritFromRDNAttribute type for inherited collective attribute subentry.
        Returns:
        Type of inheritFromRDNAttribute, or null if there is none.
      • getInheritFromRDNType

        public AttributeType getInheritFromRDNType()
        Getter to retrieve RDN type of inheritFromRDNType for inherited collective attribute subentry.
        Returns:
        RDN Type of inheritFromRDNAttribute, or null if there is none.
      • getInheritFromBaseDN

        public Dn getInheritFromBaseDN()
        Getter to retrieve inheritFromBaseRDN DN for inherited collective attribute subentry.
        Returns:
        DN of inheritFromBaseRDN, or null if there is none.
      • getSubTreeSpecification

        public SubtreeSpecification getSubTreeSpecification()
        Getter for subentry subtree specification.
        Returns:
        subtree specification for this subentry.
      • getCollectiveAttributes

        public List<Attribute> getCollectiveAttributes()
        Getter for collective attributes contained within this subentry.
        Returns:
        collective attributes contained within this subentry.
      • getConflictBehavior

        public VirtualAttributeCfgDefn.ConflictBehavior getConflictBehavior()
        Getter for collective conflict behavior defined for this collective attributes subentry.
        Returns:
        conflict behavior for this collective attributes subentry.