mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-09-26 17:49:33 +02:00
340bcb2d12
The geoloc, mood and usertune PEP users showed a pattern. Instead of repeating this pattern every time, let PepManager do the hard work
141 lines
6.1 KiB
Java
141 lines
6.1 KiB
Java
/**
|
|
*
|
|
* Copyright 2018 Paul Schaub, 2020 Florian Schmaus.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
package org.jivesoftware.smackx.mood;
|
|
|
|
import java.util.Map;
|
|
import java.util.WeakHashMap;
|
|
|
|
import org.jivesoftware.smack.Manager;
|
|
import org.jivesoftware.smack.SmackException;
|
|
import org.jivesoftware.smack.XMPPConnection;
|
|
import org.jivesoftware.smack.XMPPException;
|
|
import org.jivesoftware.smack.packet.Message;
|
|
import org.jivesoftware.smack.provider.ProviderManager;
|
|
|
|
import org.jivesoftware.smackx.mood.element.MoodConcretisation;
|
|
import org.jivesoftware.smackx.mood.element.MoodElement;
|
|
import org.jivesoftware.smackx.mood.provider.MoodConcretisationProvider;
|
|
import org.jivesoftware.smackx.pep.PepEventListener;
|
|
import org.jivesoftware.smackx.pep.PepManager;
|
|
import org.jivesoftware.smackx.pubsub.PayloadItem;
|
|
import org.jivesoftware.smackx.pubsub.PubSubException;
|
|
|
|
/**
|
|
* Entry point for Smacks API for XEP-0107: User Mood.
|
|
*
|
|
* To set a mood, please use one of the {@link #setMood(Mood)} methods. This will publish the users mood to a pubsub
|
|
* node.<br>
|
|
* <br>
|
|
* In order to get updated about other users moods, register a {@link PepEventListener} at
|
|
* {@link #addMoodListener(PepEventListener)}. That listener will get updated about any incoming mood updates of contacts.<br>
|
|
* <br>
|
|
* To stop publishing the users mood, refer to {@link #clearMood()}.<br>
|
|
* <br>
|
|
* It is also possible to add {@link MoodElement}s to {@link Message}s by using {@link #addMoodToMessage(Message, Mood)}.<br>
|
|
* <br>
|
|
* The API can be extended with custom mood concretisations by extending {@link MoodConcretisation} and registering
|
|
* {@link MoodConcretisationProvider}s using {@link ProviderManager#addExtensionProvider(String, String, Object)}.<br>
|
|
* An example of how this can be done can be found in the MoodConcretisationTest in the test package.
|
|
*
|
|
* @see <a href="https://xmpp.org/extensions/xep-0107.html">
|
|
* XEP-0107: User Mood</a>
|
|
*/
|
|
public final class MoodManager extends Manager {
|
|
|
|
public static final String MOOD_NODE = "http://jabber.org/protocol/mood";
|
|
|
|
private static final Map<XMPPConnection, MoodManager> INSTANCES = new WeakHashMap<>();
|
|
|
|
private final PepManager pepManager;
|
|
|
|
private MoodManager(XMPPConnection connection) {
|
|
super(connection);
|
|
|
|
pepManager = PepManager.getInstanceFor(connection);
|
|
}
|
|
|
|
public static synchronized MoodManager getInstanceFor(XMPPConnection connection) {
|
|
MoodManager manager = INSTANCES.get(connection);
|
|
if (manager == null) {
|
|
manager = new MoodManager(connection);
|
|
INSTANCES.put(connection, manager);
|
|
}
|
|
return manager;
|
|
}
|
|
|
|
public void setMood(Mood mood)
|
|
throws InterruptedException, SmackException.NotLoggedInException, SmackException.NoResponseException,
|
|
SmackException.NotConnectedException, XMPPException.XMPPErrorException, PubSubException.NotALeafNodeException {
|
|
setMood(mood, null, null);
|
|
}
|
|
|
|
public void setMood(Mood mood, String text)
|
|
throws InterruptedException, SmackException.NotLoggedInException, SmackException.NoResponseException,
|
|
SmackException.NotConnectedException, XMPPException.XMPPErrorException, PubSubException.NotALeafNodeException {
|
|
setMood(mood, null, text);
|
|
}
|
|
|
|
public void setMood(Mood mood, MoodConcretisation concretisation)
|
|
throws InterruptedException, SmackException.NotLoggedInException, SmackException.NoResponseException,
|
|
SmackException.NotConnectedException, XMPPException.XMPPErrorException, PubSubException.NotALeafNodeException {
|
|
setMood(mood, concretisation, null);
|
|
}
|
|
|
|
public void setMood(Mood mood, MoodConcretisation concretisation, String text)
|
|
throws InterruptedException, SmackException.NotLoggedInException, SmackException.NoResponseException,
|
|
SmackException.NotConnectedException, XMPPException.XMPPErrorException, PubSubException.NotALeafNodeException {
|
|
MoodElement element = buildMood(mood, concretisation, text);
|
|
publishMood(element);
|
|
}
|
|
|
|
public void clearMood()
|
|
throws InterruptedException, SmackException.NotLoggedInException, SmackException.NoResponseException,
|
|
SmackException.NotConnectedException, XMPPException.XMPPErrorException, PubSubException.NotALeafNodeException {
|
|
MoodElement element = buildMood(null, null, null);
|
|
publishMood(element);
|
|
}
|
|
|
|
private void publishMood(MoodElement moodElement)
|
|
throws SmackException.NotLoggedInException, InterruptedException, PubSubException.NotALeafNodeException,
|
|
XMPPException.XMPPErrorException, SmackException.NotConnectedException, SmackException.NoResponseException {
|
|
pepManager.publish(MOOD_NODE, new PayloadItem<>(moodElement));
|
|
}
|
|
|
|
private static MoodElement buildMood(Mood mood, MoodConcretisation concretisation, String text) {
|
|
return new MoodElement(
|
|
new MoodElement.MoodSubjectElement(mood, concretisation),
|
|
text);
|
|
}
|
|
|
|
public static void addMoodToMessage(Message message, Mood mood) {
|
|
addMoodToMessage(message, mood, null);
|
|
}
|
|
|
|
public static void addMoodToMessage(Message message, Mood mood, MoodConcretisation concretisation) {
|
|
MoodElement element = buildMood(mood, concretisation, null);
|
|
message.addExtension(element);
|
|
}
|
|
|
|
public boolean addMoodListener(PepEventListener<MoodElement> listener) {
|
|
return pepManager.addPepEventListener(MOOD_NODE, MoodElement.class, listener);
|
|
}
|
|
|
|
public boolean removeMoodListener(PepEventListener<MoodElement> listener) {
|
|
return pepManager.removePepEventListener(listener);
|
|
}
|
|
}
|