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:
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static classstatic classstatic class -
Field Summary
Fields inherited from class tigase.xmpp.impl.push.AbstractPushNotifications
ID, maxTimeout, withBody, withSender, XMLNSFields inherited from class tigase.xmpp.XMPPProcessor
ALL_NAMES, ALL_PATHS, cmpInfoFields inherited from interface tigase.xmpp.XMPPImplIfc
CLIENT_XMLNS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected ElementcreateSettingsElement(JID jid, String node, Element enableElem, Element optionsForm) protected booleanisSendingNotificationAllowed(BareJID userJid, XMPPResourceConnection session, Element pushServiceSettings, Packet packet) voidnotifyNewOfflineMessage(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String, Object> map) protected voidnotifyOfflineMessagesRetrieved(BareJID userJid, Collection<Element> pushServices, Consumer<Packet> packetConsumer) voidnotifyOfflineMessagesRetrieved(XMPPResourceConnection session, Queue<Packet> results) voidprotected ElementprepareNotificationPayload(Element pushServiceSettings, PushNotificationCause cause, Packet packet, long msgCount) voidprocess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository nonAuthUserRepository, Queue<Packet> results, Map<String, Object> map) protected voidprocessMessage(Packet packet, XMPPResourceConnection session, Consumer<Packet> consumer) protected voidvoidMethod called when bean is being registered allowing developer to programatically register other beans.voidsetAwares(ArrayList<PushNotificationsAware> awares) voidsetFilter(ArrayList<PushNotificationsFilter> filters) voidsetTriggers(ArrayList<PushNotificationsExtension> triggers) protected booleanshouldSendNotification(Packet packet, BareJID userJid, XMPPResourceConnection session) Element[]supDiscoFeatures(XMPPResourceConnection session) MethodsupDiscoFeaturesreturns an array of XMLElements with service discovery features which have to be returned to the client uppon request.voidunregister(Kernel kernel) Method called while bean is being unregistered.Methods inherited from class tigase.xmpp.impl.push.AbstractPushNotifications
disableNotifications, enableNotifications, enableNotifications, getPushDevicesPresence, getPushServices, getPushServices, sendPushNotification, sendPushNotification, setPushDevicesPresence, shouldDisablePushMethods inherited from class tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
id, supElementNamePaths, supNamespaces, supStreamFeatures, supTypesMethods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface tigase.xmpp.XMPPImplIfc
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, id, init, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
-
Constructor Details
-
PushNotifications
public PushNotifications()
-
-
Method Details
-
supDiscoFeatures
Description copied from interface:XMPPImplIfcMethodsupDiscoFeaturesreturns an array of XMLElements 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:
supDiscoFeaturesin interfaceXMPPImplIfc- Overrides:
supDiscoFeaturesin classAnnotatedXMPPProcessor- Parameters:
session- aXMPPResourceConnectionvalue- Returns:
- an
Element[]value
-
setAwares
-
setFilter
-
setTriggers
-
refreshDiscoFeatures
protected void refreshDiscoFeatures() -
process
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository nonAuthUserRepository, Queue<Packet> results, Map<String, Object> map) throws XMPPException- Specified by:
processin interfaceXMPPProcessorIfc- Overrides:
processin 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, Consumer<Packet> consumer) throws NotAuthorizedException, TigaseDBException - Overrides:
processMessagein classAbstractPushNotifications- Throws:
NotAuthorizedExceptionTigaseDBException
-
notifyNewOfflineMessage
public void notifyNewOfflineMessage(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String, Object> map) - Specified by:
notifyNewOfflineMessagein interfaceOfflineMessages.Notifier
-
notifyOfflineMessagesRetrieved
- Specified by:
notifyOfflineMessagesRetrievedin interfaceOfflineMessages.Notifier
-
register
Description copied from interface:RegistrarBeanMethod called when bean is being registered allowing developer to programatically register other beans.- Specified by:
registerin interfaceRegistrarBean- Parameters:
kernel- - instance from local scope
-
unregister
Description copied from interface:RegistrarBeanMethod called while bean is being unregistered.- Specified by:
unregisterin interfaceRegistrarBean- Parameters:
kernel- - instance from local scope
-
onUserRemoved
@HandleEvent(filter=local, sync=true) public void onUserRemoved(UserRepository.UserBeforeRemovedEvent event) -
createSettingsElement
protected Element createSettingsElement(JID jid, String node, Element enableElem, Element optionsForm) - Overrides:
createSettingsElementin classAbstractPushNotifications
-
notifyOfflineMessagesRetrieved
protected void notifyOfflineMessagesRetrieved(BareJID userJid, Collection<Element> pushServices, Consumer<Packet> packetConsumer) -
prepareNotificationPayload
protected Element prepareNotificationPayload(Element pushServiceSettings, PushNotificationCause cause, Packet packet, long msgCount) - Overrides:
prepareNotificationPayloadin classAbstractPushNotifications
-
isSendingNotificationAllowed
protected boolean isSendingNotificationAllowed(BareJID userJid, XMPPResourceConnection session, Element pushServiceSettings, Packet packet) - Overrides:
isSendingNotificationAllowedin classAbstractPushNotifications
-
shouldSendNotification
protected boolean shouldSendNotification(Packet packet, BareJID userJid, XMPPResourceConnection session)
-