Package org.jivesoftware.openfire.muc.spi

Class FMUCHandler.OutboundJoinProgress

java.lang.Object

org.jivesoftware.openfire.muc.spi.FMUCHandler.OutboundJoinProgress

All Implemented Interfaces:

Serializable

Enclosing class:

FMUCHandler

public static class FMUCHandler.OutboundJoinProgress
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
OutboundJoinProgress(org.xmpp.packet.JID peer, CompletableFuture<List<org.xmpp.packet.Packet>> callback)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<?>	addToQueue(org.xmpp.packet.Packet stanza, MUCRole sender)	Adds a stanza to be sent to the remote, joined MUC as soon as federation has been established.
CompletableFuture<List<org.xmpp.packet.Packet>>	getCallback()
org.xmpp.packet.JID	getPeer()
String	getRejectionMessage()
ArrayList<org.xmpp.packet.Packet>	getResponses()
boolean	isJoinComplete()
boolean	isRejected()
boolean	isSuccessful()
List<org.jivesoftware.openfire.muc.spi.FMUCHandler.OutboundJoinProgress.QueuedStanza>	purgeQueue()	Retrieve and clean the list of stanzas that have been queued after federation was initiated, but before it was finished.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutboundJoinProgress

public OutboundJoinProgress(@Nonnull
                            org.xmpp.packet.JID peer,
                            @Nonnull
                            CompletableFuture<List<org.xmpp.packet.Packet>> callback)

Method Detail

getPeer

public org.xmpp.packet.JID getPeer()

getCallback

public CompletableFuture<List<org.xmpp.packet.Packet>> getCallback()

getResponses

public ArrayList<org.xmpp.packet.Packet> getResponses()

addToQueue

public CompletableFuture<?> addToQueue(@Nonnull
                                       org.xmpp.packet.Packet stanza,
                                       @Nonnull
                                       MUCRole sender)

Adds a stanza to be sent to the remote, joined MUC as soon as federation has been established. This method is intended to be used only when federation is in progress of being established.

Parameters:

stanza - The stanza to share

sender - The author of the stanza

Returns:

A future, indicating if local distribution of the stanza needs to wait.

purgeQueue

public List<org.jivesoftware.openfire.muc.spi.FMUCHandler.OutboundJoinProgress.QueuedStanza> purgeQueue()

Retrieve and clean the list of stanzas that have been queued after federation was initiated, but before it was finished.

Returns:

A list of queued stanzas (possibly empty).

isJoinComplete

public boolean isJoinComplete()

isRejected

public boolean isRejected()

getRejectionMessage

public String getRejectionMessage()

isSuccessful

public boolean isSuccessful()