public class AbstractPushNotifications extends AnnotatedXMPPProcessor implements XMPPProcessorIfc
Modifier and Type | Field and Description |
---|---|
static String |
ID |
protected Duration |
maxTimeout |
protected boolean |
withBody |
protected boolean |
withSender |
static String |
XMLNS |
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
AbstractPushNotifications() |
id, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, id, init, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
compareTo
public static final String XMLNS
public static final String ID
@ConfigField(desc="Send notifications with body", alias="with-body") protected boolean withBody
@ConfigField(desc="Send notifications with sender", alias="with-sender") protected boolean withSender
@ConfigField(desc="Max notification timeout", alias="max-timeout") protected Duration maxTimeout
protected boolean shouldDisablePush(Authorization error)
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository nonAuthUserRepository, Queue<Packet> results, Map<String,Object> map) throws XMPPException
process
in interface XMPPProcessorIfc
packet
- packet is which being processed. This parameter may never be null. Even though this is not
immutable object it mustn't be altered. None of it's fields or attributes can be changed during processing.session
- user session which keeps all the user session data and also gives an access to the user's
repository data. It allows for storing information in a permanent storage or in memory only during the live of
the online session. This parameter can be null if there is no online user session at the time of the packet
processing.nonAuthUserRepository
- this is a user data storage which is normally used when the user session (parameter above) is null.
This is repository allows for a very restricted access only. It allows for storing some user private data
(doesn't allow overwriting existing data) like messages for offline users and it also allows for reading user
public data like VCard.results
- this a collection with packets which have been generated as input packet processing results.
Regardless a response to a user request is sent or the packet is forwarded to it's destination it is always
required that a copy of the input packet is created and stored in the results queue.map
- this map keeps plugin specific settings loaded from the Tigase server configuration. In most
cases it is unused, however if the plugin needs to access an external database that this is a way to pass
database connection string to the plugin.XMPPException
protected void processMessage(Packet packet, XMPPResourceConnection session, Consumer<Packet> results) throws NotAuthorizedException, TigaseDBException
protected void enableNotifications(XMPPResourceConnection session, JID jid, String node, Element enableElem, Element optionsForm) throws NotAuthorizedException, TigaseDBException
protected Element createSettingsElement(JID jid, String node, Element enableElem, Element optionsForm)
protected void enableNotifications(XMPPResourceConnection session, JID jid, String node, Element settings) throws NotAuthorizedException, TigaseDBException
protected void disableNotifications(XMPPResourceConnection session, JID jid, String node) throws NotAuthorizedException, TigaseDBException
protected Map<String,Element> getPushServices(XMPPResourceConnection session)
protected Element prepareNotificationPayload(Element pushServiceSettings, Packet packet, long msgCount)
protected void sendPushNotification(BareJID userJid, Collection<Element> pushServices, XMPPResourceConnection session, Packet packet, Map<Enum,Long> notificationData)
protected Map<String,Element> getPushServices(BareJID userJid) throws TigaseDBException
TigaseDBException
protected void sendPushNotification(XMPPResourceConnection session, Packet packet) throws TigaseDBException
TigaseDBException
protected boolean isSendingNotificationAllowed(BareJID userJid, XMPPResourceConnection session, Element pushServiceSettings, Packet packet)
Copyright © 2004–2021 "Tigase, Inc.". All rights reserved.