org.jivesoftware.openfire.stanzaid

Class StanzaIDUtil

java.lang.Object

org.jivesoftware.openfire.stanzaid.StanzaIDUtil

public class StanzaIDUtil
extends Object

Utility methods that implement XEP-0359: Unique and Stable Stanza IDs.

Author:

Guus der Kinderen, guus.der.kinderen@gmail.com

See Also:

XEP-0359

Constructor Summary

Constructors

Constructor and Description
StanzaIDUtil()

Method Summary

Modifier and Type	Method and Description
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.
static String	findFirstUniqueAndStableStanzaID(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.
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.
static UUID	parseUniqueAndStableStanzaID(org.xmpp.packet.Packet packet, String by) Deprecated. This implementation only works with IDs that are UUIDs, which they need not be. Use findFirstUniqueAndStableStanzaID(Packet, String) instead. OF-2026

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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.

Parameters:

packet - The inbound packet (cannot be null).

self - The ID of the 'local' entity that will generate the stanza ID (cannot be null).

Returns:

the updated packet

See Also:

XEP-0359

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.

Parameters:

packet - The stanza for what to return the ID (cannot be null).

Returns:

The ID (never null or empty string).

parseUniqueAndStableStanzaID

@Deprecated
public static UUID parseUniqueAndStableStanzaID(org.xmpp.packet.Packet packet,
                                                            String by)

Deprecated. This implementation only works with IDs that are UUIDs, which they need not be. Use findFirstUniqueAndStableStanzaID(Packet, String) instead. OF-2026

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.

Parameters:

packet - The stanza (cannot be null).

by - The 'by' value for which to return the ID (cannot be null or an empty string).

Returns:

The unique and stable ID, or null if no such ID is found.

findFirstUniqueAndStableStanzaID

public static String findFirstUniqueAndStableStanzaID(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.

Parameters:

packet - The stanza (cannot be null).

by - The 'by' value for which to return the ID (cannot be null or an empty string).

Returns:

The unique and stable ID, or null if no such ID is found.