Class JoinedEntry

  • All Implemented Interfaces:
    LDIFRecord, java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class JoinedEntry
    extends ReadOnlyEntry
    This class provides a joined entry, which is a read-only representation of an entry that has been joined with a search result entry using the LDAP join control. See the class-level documentation for the JoinRequestControl class for additional information and an example demonstrating its use.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

    Joined entries are encoded as follows:
       JoinedEntry ::= SEQUENCE {
            objectName            LDAPDN,
            attributes            PartialAttributeList,
            nestedJoinResults     SEQUENCE OF JoinedEntry OPTIONAL }
     
    See Also:
    Serialized Form
    • Constructor Detail

      • JoinedEntry

        public JoinedEntry​(@NotNull
                           Entry entry,
                           @Nullable
                           java.util.List<JoinedEntry> nestedJoinResults)
        Creates a new joined entry with the specified DN, attributes, and nested join results.
        Parameters:
        entry - The entry containing the DN and attributes to use for this joined entry. It must not be null.
        nestedJoinResults - A list of nested join results for this joined entry. It may be null or empty if there are no nested join results.
      • JoinedEntry

        public JoinedEntry​(@NotNull
                           java.lang.String dn,
                           @NotNull
                           java.util.Collection<Attribute> attributes,
                           @Nullable
                           java.util.List<JoinedEntry> nestedJoinResults)
        Creates a new joined entry with the specified DN, attributes, and nested join results.
        Parameters:
        dn - The DN for this joined entry. It must not be null.
        attributes - The set of attributes for this joined entry. It must not be null.
        nestedJoinResults - A list of nested join results for this joined entry. It may be null or empty if there are no nested join results.
    • Method Detail

      • getNestedJoinResults

        @NotNull
        public java.util.List<JoinedEntrygetNestedJoinResults()
        Retrieves the list of nested join results for this joined entry.
        Returns:
        The list of nested join results for this joined entry, or an empty list if there are none.
      • toString

        public void toString​(@NotNull
                             java.lang.StringBuilder buffer)
        Appends a string representation of this joined entry to the provided buffer.
        Specified by:
        toString in interface LDIFRecord
        Overrides:
        toString in class Entry
        Parameters:
        buffer - The buffer to which the information should be appended.