@Bean(name="urn:xmpp:push:0", parent=SessionManager.class, active=true, exportable=true) public class PushNotifications extends AbstractPushNotifications implements XMPPProcessorIfc, OfflineMessages.Notifier, RegistrarBean
ID, maxTimeout, withBody, withSender, XMLNS
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
PushNotifications() |
Modifier and Type | Method and Description |
---|---|
protected Element |
createSettingsElement(JID jid,
String node,
Element enableElem,
Element optionsForm) |
protected boolean |
isSendingNotificationAllowed(BareJID userJid,
XMPPResourceConnection session,
Element pushServiceSettings,
Packet packet) |
void |
notifyNewOfflineMessage(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> map) |
protected void |
notifyOfflineMessagesRetrieved(BareJID userJid,
Collection<Element> pushServices) |
void |
notifyOfflineMessagesRetrieved(XMPPResourceConnection session,
Queue<Packet> results) |
protected Element |
prepareNotificationPayload(Element pushServiceSettings,
Packet packet,
long msgCount) |
void |
process(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository nonAuthUserRepository,
Queue<Packet> results,
Map<String,Object> map) |
protected void |
processMessage(Packet packet,
XMPPResourceConnection session,
Consumer<Packet> consumer) |
protected void |
refreshDiscoFeatures() |
void |
register(Kernel kernel)
Method called when bean is being registered allowing developer to programatically register other beans.
|
void |
setAwares(ArrayList<PushNotificationsAware> awares) |
void |
setFilter(ArrayList<PushNotificationsFilter> filters) |
void |
setTriggers(ArrayList<PushNotificationsExtension> triggers) |
protected boolean |
shouldSendNotification(Packet packet,
BareJID userJid,
XMPPResourceConnection session) |
Element[] |
supDiscoFeatures(XMPPResourceConnection session)
Method
supDiscoFeatures returns an array of XML Element s with service discovery
features which have to be returned to the client uppon request. |
void |
unregister(Kernel kernel)
Method called while bean is being unregistered.
|
disableNotifications, enableNotifications, enableNotifications, getPushServices, getPushServices, sendPushNotification, sendPushNotification, shouldDisablePush
id, 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, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
compareTo
public Element[] supDiscoFeatures(XMPPResourceConnection session)
XMPPImplIfc
supDiscoFeatures
returns an array of XML Element
s with service discovery
features which have to be returned to the client uppon request. Service discovery features returned by this
method correspond to services supported by this plugin.supDiscoFeatures
in interface XMPPImplIfc
supDiscoFeatures
in class AnnotatedXMPPProcessor
session
- a XMPPResourceConnection
valueElement[]
valuepublic void setAwares(ArrayList<PushNotificationsAware> awares)
public void setFilter(ArrayList<PushNotificationsFilter> filters)
public void setTriggers(ArrayList<PushNotificationsExtension> triggers)
protected void refreshDiscoFeatures()
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository nonAuthUserRepository, Queue<Packet> results, Map<String,Object> map) throws XMPPException
process
in interface XMPPProcessorIfc
process
in class AbstractPushNotifications
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> consumer) throws NotAuthorizedException, TigaseDBException
processMessage
in class AbstractPushNotifications
NotAuthorizedException
TigaseDBException
public void notifyNewOfflineMessage(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> map)
notifyNewOfflineMessage
in interface OfflineMessages.Notifier
public void notifyOfflineMessagesRetrieved(XMPPResourceConnection session, Queue<Packet> results)
notifyOfflineMessagesRetrieved
in interface OfflineMessages.Notifier
public void register(Kernel kernel)
RegistrarBean
register
in interface RegistrarBean
kernel
- - instance from local scopepublic void unregister(Kernel kernel)
RegistrarBean
unregister
in interface RegistrarBean
kernel
- - instance from local scopeprotected Element createSettingsElement(JID jid, String node, Element enableElem, Element optionsForm)
createSettingsElement
in class AbstractPushNotifications
protected void notifyOfflineMessagesRetrieved(BareJID userJid, Collection<Element> pushServices)
protected Element prepareNotificationPayload(Element pushServiceSettings, Packet packet, long msgCount)
prepareNotificationPayload
in class AbstractPushNotifications
protected boolean isSendingNotificationAllowed(BareJID userJid, XMPPResourceConnection session, Element pushServiceSettings, Packet packet)
isSendingNotificationAllowed
in class AbstractPushNotifications
protected boolean shouldSendNotification(Packet packet, BareJID userJid, XMPPResourceConnection session)
Copyright © 2004–2021 "Tigase, Inc.". All rights reserved.