Class 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.
  • Constructor Details

    • PushNotifications

      public PushNotifications()
  • Method Details

    • supDiscoFeatures

      public tigase.xml.Element[] supDiscoFeatures(XMPPResourceConnection session)
      Description copied from interface: XMPPImplIfc
      Method supDiscoFeatures returns an array of XML Elements 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 interface XMPPImplIfc
      Overrides:
      supDiscoFeatures in class AnnotatedXMPPProcessor
      Parameters:
      session - a XMPPResourceConnection value
      Returns:
      an Element[] value
    • setAwares

      public void setAwares(ArrayList<PushNotificationsAware> awares)
    • setFilter

      public void setFilter(ArrayList<PushNotificationsFilter> filters)
    • setTriggers

      public void setTriggers(ArrayList<PushNotificationsExtension> triggers)
    • 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:
      process in interface XMPPProcessorIfc
      Overrides:
      process in class AbstractPushNotifications
      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:
      processMessage in class AbstractPushNotifications
      Throws:
      NotAuthorizedException
      TigaseDBException
    • notifyNewOfflineMessage

      public void notifyNewOfflineMessage(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> map)
      Specified by:
      notifyNewOfflineMessage in interface OfflineMessages.Notifier
    • notifyOfflineMessagesRetrieved

      public void notifyOfflineMessagesRetrieved(XMPPResourceConnection session, Queue<Packet> results)
      Specified by:
      notifyOfflineMessagesRetrieved in interface OfflineMessages.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 interface RegistrarBean
      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 interface RegistrarBean
      Parameters:
      kernel - - instance from local scope
    • createSettingsElement

      protected tigase.xml.Element createSettingsElement(tigase.xmpp.jid.JID jid, String node, tigase.xml.Element enableElem, tigase.xml.Element optionsForm)
      Overrides:
      createSettingsElement in class AbstractPushNotifications
    • notifyOfflineMessagesRetrieved

      protected void notifyOfflineMessagesRetrieved(tigase.xmpp.jid.BareJID userJid, Collection<tigase.xml.Element> pushServices)
    • prepareNotificationPayload

      protected tigase.xml.Element prepareNotificationPayload(tigase.xml.Element pushServiceSettings, Packet packet, long msgCount)
      Overrides:
      prepareNotificationPayload in class AbstractPushNotifications
    • isSendingNotificationAllowed

      protected boolean isSendingNotificationAllowed(tigase.xmpp.jid.BareJID userJid, XMPPResourceConnection session, tigase.xml.Element pushServiceSettings, Packet packet)
      Overrides:
      isSendingNotificationAllowed in class AbstractPushNotifications
    • shouldSendNotification

      protected boolean shouldSendNotification(Packet packet, tigase.xmpp.jid.BareJID userJid, XMPPResourceConnection session)