Class DeleteMsg

  • All Implemented Interfaces:
    Comparable<UpdateMsg>

    public final class DeleteMsg
    extends LDAPUpdateMsg
    Object used when sending delete information to replication servers.
    • Constructor Detail

      • DeleteMsg

        public DeleteMsg​(Dn dn,
                         CSN csn,
                         UUID entryUUID)
        Creates a new delete message.
        Parameters:
        dn - The dn with which the message must be created.
        csn - The CSN with which the message must be created.
        entryUUID - The unique id with which the message must be created.
      • DeleteMsg

        public DeleteMsg​(CSN csn,
                         Dn dn,
                         UUID entryUUID,
                         String initiatorsName,
                         byte[] encodedEclIncludes,
                         boolean subtreeDelete)
        Creates a new delete message.
        Parameters:
        csn - The CSN with which the message must be created.
        dn - The dn with which the message must be created.
        entryUUID - The unique id with which the message must be created.
        initiatorsName - The initiator's name of this change.
        encodedEclIncludes - Encoded form of entry attributes.
        subtreeDelete - Whether the delete operation is a subtree delete.
    • Method Detail

      • createRequest

        public DeleteRequest createRequest​(Dn newDN)
        Description copied from class: LDAPUpdateMsg
        Create a request from this message using the provided DN.
        Specified by:
        createRequest in class LDAPUpdateMsg
        Parameters:
        newDN - the DN to use when creating the request.
        Returns:
        the created request
      • getBytesLatest

        public byte[] getBytesLatest​(short protocolVersion)
        Description copied from class: LDAPUpdateMsg
        Get the byte array representation of this message.

        This uses the provided version number which must be at least version 4.

        Specified by:
        getBytesLatest in class LDAPUpdateMsg
        Parameters:
        protocolVersion - the actual protocol version to encode into
        Returns:
        The byte array representation of this Message.
      • size

        public int size()
        Description copied from class: UpdateMsg
        Return the number of bytes used by this message.
        Specified by:
        size in class LDAPUpdateMsg
        Returns:
        The number of bytes used by this message.
      • setInitiatorsName

        public void setInitiatorsName​(String initiatorsName)
        Set the initiator's name of this change.
        Parameters:
        initiatorsName - the initiator's name.
      • getInitiatorsName

        public String getInitiatorsName()
        Get the initiator's name of this change.
        Returns:
        the initiator's name.
      • setSubtreeDelete

        public void setSubtreeDelete​(boolean subtreeDelete)
        Set the subtree flag.
        Parameters:
        subtreeDelete - the subtree flag.
      • isSubtreeDelete

        public boolean isSubtreeDelete()
        Get the subtree flag.
        Returns:
        the subtree flag.