Package tigase.xmpp

Class XMPPProcessor

    • Field Detail

      • ALL_PATHS

        protected static final java.lang.String[][] ALL_PATHS

    • Constructor Detail

      • XMPPProcessor

        protected XMPPProcessor()

    • Method Detail

      • canHandle

        public Authorization canHandle​(Packet packet,
                               XMPPResourceConnection conn)
        Description copied from interface: XMPPImplIfc
        By default the method uses XMPPImplIfc.supElementNamePaths() and XMPPImplIfc.supTypes() method results to determine whether the plugin would process given packet. However, a plugin can implement own logic to determine packet processing capabilities or conditions. Please note, this method must be very fast and efficient. No I/O processing is recommended as it may impact performance of the whole system.
        Specified by:
        canHandle in interface XMPPImplIfc
        Parameters:
        packet - is a Packet for processing.
        conn - is a user session object or null.
        Returns:
        returns Authorization enum value or null. Null means the plugin is simply not processing the packet. Authorization.AUTHORIZED means the plugin can process the packet, any other Authorization enum value means an error which has to be returned to the sender.

      • compareTo

        public final int compareTo​(XMPPImplIfc proc)
        Specified by:
        compareTo in interface java.lang.Comparable<XMPPImplIfc>

      • concurrentQueuesNo

        public int concurrentQueuesNo()
        Description copied from interface: XMPPImplIfc
        Methods returns a preferable number of threads/packets queues for the plugin. This number can be overwritten through configuration settings, however, a default value should be reasonably good for most standard installations. It is recommended to assign at least as much as twice a number of CPUs cores for I/O bound processing and number a number equal to CPUs cores for fast processing not slowed down by any I/O.
        Specified by:
        concurrentQueuesNo in interface XMPPImplIfc
        Returns:
        an integer preferred number of processing threads for the plugin.

      • init

        @Deprecated
public void init​(java.util.Map<java.lang.String,​java.lang.Object> settings)
          throws TigaseDBException
        Deprecated.
        Description copied from interface: XMPPImplIfc
        Method init is called just after the plugin has been loaded into memory. The idea behind this is to allow it to initialize or check the database. This might be especially useful for plugins which want to have a database access via non-standard stored procedures or need schema upgrade.
        Specified by:
        init in interface XMPPImplIfc
        Parameters:
        settings - is a Map with initial processor settings from the configuration file.
        Throws:
        TigaseDBException

      • supDiscoFeatures

        public 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
        Parameters:
        session - a XMPPResourceConnection value
        Returns:
        an Element[] value

      • supElementNamePaths

        public java.lang.String[][] supElementNamePaths()
        Description copied from interface: XMPPImplIfc
        Method supElementNamePaths returns an array of element names in form of a full path to the XML element for stanzas which can be processed by this plugin. Each element name path corresponds to XMLNS returned in array by supNamespaces() method. The element path itself is represented by a String array with each path element as a separate String.
        Specified by:
        supElementNamePaths in interface XMPPImplIfc
        Returns:
        a String[][] value is an array for element paths for which the plugin offers processing capabilities. Each path is in form of a String array in order to reduce parsing overhead.

      • supNamespaces

        public java.lang.String[] supNamespaces()
        Description copied from interface: XMPPImplIfc
        Method supNamespaces returns an array of name-spaces for stanzas which can be processed by this plugin. Each namespace corresponds to element name returned in array by supElemenets() method.
        Specified by:
        supNamespaces in interface XMPPImplIfc
        Returns:
        a String[] value

      • supStreamFeatures

        public Element[] supStreamFeatures​(XMPPResourceConnection session)
        Description copied from interface: XMPPImplIfc
        Method supStreamFeatures returns an array of XML Elements with stream features which have to be returned to the client uppon request. Stream features returned by this method correspond to features supported by this plugin.
        Specified by:
        supStreamFeatures in interface XMPPImplIfc
        Parameters:
        session - a XMPPResourceConnection value
        Returns:
        an Element[] value

      • supTypes

        public java.util.Set<StanzaType> supTypes()
        Description copied from interface: XMPPImplIfc
        Method returns an array of all stanza types which the plugin is able to handle. If the method returns NULL, then all stanzas of all types will be passed to the plugin for processing. Otherwise only stanzas with selected types, assuming that element names and name-spaces match as well.
        Specified by:
        supTypes in interface XMPPImplIfc
        Returns:
        a StanzaType[] array of supported stanza types.

      • getStatistics

        public void getStatistics​(StatisticsList list)
        Description copied from interface: XMPPImplIfc
        The method allows to retrieve plugin own statistics if it generates any.
        Specified by:
        getStatistics in interface XMPPImplIfc
        Parameters:
        list - is a statistics collection to which plugins own metrics can be added.

      • getComponentInfo

        public ComponentInfo getComponentInfo()
        Description copied from interface: XMPPImplIfc
        Allows to obtain various informations about components
        Specified by:
        getComponentInfo in interface XMPPImplIfc
        Returns:
        information about particular component

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object