rocks.xmpp.extensions.rtt.RealTimeTextManager Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xmpp-extensions-client Show documentation
Show all versions of xmpp-extensions-client Show documentation
Client side business logic for XMPP extensions
/*
* The MIT License (MIT)
*
* Copyright (c) 2014-2016 Christian Schudt
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package rocks.xmpp.extensions.rtt;
import rocks.xmpp.addr.Jid;
import rocks.xmpp.core.session.Manager;
import rocks.xmpp.core.session.XmppSession;
import rocks.xmpp.core.stanza.MessageEvent;
import rocks.xmpp.core.stanza.model.Message;
import rocks.xmpp.extensions.messagecorrect.model.Replace;
import rocks.xmpp.extensions.rtt.model.RealTimeText;
import rocks.xmpp.im.chat.Chat;
import rocks.xmpp.util.XmppUtils;
import java.util.Collections;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.function.Consumer;
/**
* Manages In-Band Real Time Text.
*
* @author Christian Schudt
* @see XEP-0301: In-Band Real Time Text
*/
public final class RealTimeTextManager extends Manager {
private final Map realTimeMessageMap = new ConcurrentHashMap<>();
private final Set> realTimeTextActivationListeners = new CopyOnWriteArraySet<>();
private final Set> inboundRealTimeMessageListeners = new CopyOnWriteArraySet<>();
private final Consumer messageListener;
private RealTimeTextManager(final XmppSession xmppSession) {
super(xmppSession);
messageListener = e -> {
Message message = e.getMessage();
if (message.getType() == Message.Type.CHAT || message.getType() == Message.Type.GROUPCHAT) {
// Recipient clients MUST keep track of separate real-time messages on a per-contact basis
// Participants that enable real-time text during group chat need to keep track of multiple concurrent real-time messages on a per-participant basis.
Jid sender = message.getFrom();
Jid trackingJid = message.getType() == Message.Type.CHAT ? sender.asBareJid() : sender;
RealTimeText rtt = message.getExtension(RealTimeText.class);
if (rtt != null && rtt.getSequence() != null) {
TrackingKey trackingKey = new TrackingKey(trackingJid, rtt.getId());
if (rtt.getEvent() == null || rtt.getEvent() == RealTimeText.Event.EDIT) {
// If the 'event' attribute is omitted, event="edit" is assumed as the default.
InboundRealTimeMessage realTimeMessage = realTimeMessageMap.get(trackingKey);
// Recipient clients must verify that the 'seq' attribute increments by 1 in consecutively received realTimeMessageListener) {
inboundRealTimeMessageListeners.add(realTimeMessageListener);
}
/**
* Adds a real-time text listener, which allows to listen for real-time text.
*
* @param realTimeTextListener The listener.
* @see #removeRealTimeTextActivationListener(Consumer)
*/
public final void addRealTimeTextActivationListener(Consumer realTimeTextListener) {
realTimeTextActivationListeners.add(realTimeTextListener);
}
/**
* Removes a previously added real-time text listener.
*
* @param realTimeTextListener The listener.
* @see #addRealTimeTextActivationListener(Consumer)
*/
public final void removeRealTimeTextActivationListener(Consumer realTimeTextListener) {
realTimeTextActivationListeners.remove(realTimeTextListener);
}
/**
* Activates real-time text for a chat session.
*
* @param chat The chat.
* @see 6.1 Activating Real-Time Text
*/
public final void activate(Chat chat) {
Message message = new Message();
RealTimeText realTimeText = new RealTimeText(RealTimeText.Event.INIT, Collections.emptyList(), 0, null);
message.addExtension(realTimeText);
chat.sendMessage(message);
}
/**
* Deactivates real-time text for a chat session.
*
* @param chat The chat.
* @see 6.2 Deactivating Real-Time Text
*/
public final void deactivate(Chat chat) {
Message message = new Message();
RealTimeText realTimeText = new RealTimeText(RealTimeText.Event.CANCEL, Collections.emptyList(), 0, null);
message.addExtension(realTimeText);
chat.sendMessage(message);
}
private static final class TrackingKey {
private final Jid sender;
private final String id;
private TrackingKey(Jid sender, String id) {
this.sender = sender;
this.id = id;
}
@Override
public int hashCode() {
return Objects.hash(sender, id);
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if (!(o instanceof TrackingKey)) {
return false;
}
TrackingKey other = (TrackingKey) o;
return Objects.equals(sender, other.sender)
&& Objects.equals(id, other.id);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy