Package tigase.xmpp.impl.push
Class PushNotifications
- java.lang.Object
-
- tigase.xmpp.XMPPProcessor
-
- tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
-
- tigase.xmpp.impl.push.AbstractPushNotifications
-
- tigase.xmpp.impl.push.PushNotifications
-
- All Implemented Interfaces:
java.lang.Comparable<XMPPImplIfc>
,RegistrarBean
,OfflineMessages.Notifier
,XMPPImplIfc
,XMPPProcessorConcurrencyAwareIfc
,XMPPProcessorIfc
@Bean(name="urn:xmpp:push:0", parent=SessionManager.class, active=true, exportable=true) public class PushNotifications extends AbstractPushNotifications implements XMPPProcessorIfc, OfflineMessages.Notifier, RegistrarBean
Created by andrzej on 30.12.2016.
-
-
Field Summary
-
Fields inherited from class tigase.xmpp.impl.push.AbstractPushNotifications
ID, maxTimeout, withBody, withSender, XMLNS
-
Fields inherited from class tigase.xmpp.XMPPProcessor
ALL_NAMES, ALL_PATHS, cmpInfo
-
Fields inherited from interface tigase.xmpp.XMPPImplIfc
CLIENT_XMLNS
-
-
Constructor Summary
Constructors Constructor Description PushNotifications()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Element
createSettingsElement(JID jid, java.lang.String node, Element enableElem, Element optionsForm)
protected boolean
isSendingNotificationAllowed(BareJID userJid, XMPPResourceConnection session, Element pushServiceSettings, Packet packet)
void
notifyNewOfflineMessage(Packet packet, XMPPResourceConnection session, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> map)
protected void
notifyOfflineMessagesRetrieved(BareJID userJid, java.util.Collection<Element> pushServices)
void
notifyOfflineMessagesRetrieved(XMPPResourceConnection session, java.util.Queue<Packet> results)
protected Element
prepareNotificationPayload(Element pushServiceSettings, Packet packet, long msgCount)
void
process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository nonAuthUserRepository, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> map)
protected void
processMessage(Packet packet, XMPPResourceConnection session, java.util.function.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(java.util.ArrayList<PushNotificationsAware> awares)
void
setFilter(java.util.ArrayList<PushNotificationsFilter> filters)
void
setTriggers(java.util.ArrayList<PushNotificationsExtension> triggers)
protected boolean
shouldSendNotification(Packet packet, BareJID userJid, XMPPResourceConnection session)
Element[]
supDiscoFeatures(XMPPResourceConnection session)
MethodsupDiscoFeatures
returns an array of XMLElement
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.-
Methods inherited from class tigase.xmpp.impl.push.AbstractPushNotifications
disableNotifications, enableNotifications, enableNotifications, getPushServices, getPushServices, sendPushNotification, sendPushNotification, shouldDisablePush
-
Methods inherited from class tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
id, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
-
Methods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface tigase.xmpp.XMPPImplIfc
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, id, init, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
-
-
-
-
Method Detail
-
supDiscoFeatures
public Element[] supDiscoFeatures(XMPPResourceConnection session)
Description copied from interface:XMPPImplIfc
MethodsupDiscoFeatures
returns an array of XMLElement
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.- Specified by:
supDiscoFeatures
in interfaceXMPPImplIfc
- Overrides:
supDiscoFeatures
in classAnnotatedXMPPProcessor
- Parameters:
session
- aXMPPResourceConnection
value- Returns:
- an
Element[]
value
-
setAwares
public void setAwares(java.util.ArrayList<PushNotificationsAware> awares)
-
setFilter
public void setFilter(java.util.ArrayList<PushNotificationsFilter> filters)
-
setTriggers
public void setTriggers(java.util.ArrayList<PushNotificationsExtension> triggers)
-
refreshDiscoFeatures
protected void refreshDiscoFeatures()
-
process
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository nonAuthUserRepository, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> map) throws XMPPException
- Specified by:
process
in interfaceXMPPProcessorIfc
- Overrides:
process
in classAbstractPushNotifications
- Parameters:
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.- Throws:
XMPPException
-
processMessage
protected void processMessage(Packet packet, XMPPResourceConnection session, java.util.function.Consumer<Packet> consumer) throws NotAuthorizedException, TigaseDBException
- Overrides:
processMessage
in classAbstractPushNotifications
- Throws:
NotAuthorizedException
TigaseDBException
-
notifyNewOfflineMessage
public void notifyNewOfflineMessage(Packet packet, XMPPResourceConnection session, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> map)
- Specified by:
notifyNewOfflineMessage
in interfaceOfflineMessages.Notifier
-
notifyOfflineMessagesRetrieved
public void notifyOfflineMessagesRetrieved(XMPPResourceConnection session, java.util.Queue<Packet> results)
- Specified by:
notifyOfflineMessagesRetrieved
in interfaceOfflineMessages.Notifier
-
register
public void register(Kernel kernel)
Description copied from interface:RegistrarBean
Method called when bean is being registered allowing developer to programatically register other beans.- Specified by:
register
in interfaceRegistrarBean
- Parameters:
kernel
- - instance from local scope
-
unregister
public void unregister(Kernel kernel)
Description copied from interface:RegistrarBean
Method called while bean is being unregistered.- Specified by:
unregister
in interfaceRegistrarBean
- Parameters:
kernel
- - instance from local scope
-
createSettingsElement
protected Element createSettingsElement(JID jid, java.lang.String node, Element enableElem, Element optionsForm)
- Overrides:
createSettingsElement
in classAbstractPushNotifications
-
notifyOfflineMessagesRetrieved
protected void notifyOfflineMessagesRetrieved(BareJID userJid, java.util.Collection<Element> pushServices)
-
prepareNotificationPayload
protected Element prepareNotificationPayload(Element pushServiceSettings, Packet packet, long msgCount)
- Overrides:
prepareNotificationPayload
in classAbstractPushNotifications
-
isSendingNotificationAllowed
protected boolean isSendingNotificationAllowed(BareJID userJid, XMPPResourceConnection session, Element pushServiceSettings, Packet packet)
- Overrides:
isSendingNotificationAllowed
in classAbstractPushNotifications
-
shouldSendNotification
protected boolean shouldSendNotification(Packet packet, BareJID userJid, XMPPResourceConnection session)
-
-