Class StanzaIDUtil

  • public class StanzaIDUtil
    extends Object
    Utility methods that implement XEP-0359: Unique and Stable Stanza IDs.
    Guus der Kinderen,
    See Also:
    • Constructor Detail

      • StanzaIDUtil

        public StanzaIDUtil()
    • Method Detail

      • ensureUniqueAndStableStanzaID

        public static org.xmpp.packet.Packet ensureUniqueAndStableStanzaID​(org.xmpp.packet.Packet packet,
                                                                           org.xmpp.packet.JID self)
        Modifies the stanza that's passed as a packet by adding a Stanza ID.
        packet - The inbound packet (cannot be null).
        self - The ID of the 'local' entity that will generate the stanza ID (cannot be null).
        the updated packet
        See Also:
      • generateUniqueAndStableStanzaID

        public static String generateUniqueAndStableStanzaID​(org.xmpp.packet.Packet packet)
        Returns a value that is an appropriate unique and stable stanza ID in context of XEP-0359: it's either the origin-id value, or a UUID.
        packet - The stanza for what to return the ID (cannot be null).
        The ID (never null or empty string).
      • parseUniqueAndStableStanzaID

        public static UUID parseUniqueAndStableStanzaID​(org.xmpp.packet.Packet packet,
                                                        String by)
        Returns the first stable and unique stanza-id value from the packet, that is defined for a particular 'by' value. This method does not evaluate 'origin-id' elements in the packet.
        packet - The stanza (cannot be null).
        by - The 'by' value for which to return the ID (cannot be null or an empty string).
        The unique and stable ID, or null if no such ID is found.