Package tigase.xmpp.impl

Class PepPlugin

    • Constructor Detail

      • PepPlugin

        public PepPlugin()

    • Method Detail

      • id

        public java.lang.String id()
        Description copied from interface: XMPPImplIfc
        Method id returns a unique ID of the plugin. Each plugin has own, unique ID which is used in the configuration file to determine whether it needs to be loaded or not. In most cases the ID can be equal to XMLNS of the packages processed by the plugin.
        Specified by:
        id in interface XMPPImplIfc
        Overrides:
        id in class AnnotatedXMPPProcessor
        Returns:
        a String value

      • processFromUserToServerPacket

        public void processFromUserToServerPacket​(JID connectionId,
                                          Packet packet,
                                          XMPPResourceConnection session,
                                          NonAuthUserRepository repo,
                                          java.util.Queue<Packet> results,
                                          java.util.Map<java.lang.String,​java.lang.Object> settings)
                                   throws PacketErrorTypeException
        Description copied from class: XMPPProcessorAbstract
        The method is called when a packet is send from the user who is owner of the session to the local server (ping, roster management, privacy lists, etc...). There is no default implementation for the method.
        Specified by:
        processFromUserToServerPacket in class XMPPProcessorAbstract
        Parameters:
        connectionId - is a JID instance with the session connection ID.
        packet - is a Packet sent by the user.
        session - is a XMPPResourceConnection instance with all the sending user session data.
        repo - is a NonAuthUserRepository instance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.
        results - is a packets Queue with all the processing results from the plugin.
        settings - is a Map with all the configuration settings passed to the plugin.
        Throws:
        PacketErrorTypeException - on attempt to send an error response to the error packet.

      • processNullSessionPacket

        public void processNullSessionPacket​(Packet packet,
                                     NonAuthUserRepository repo,
                                     java.util.Queue<Packet> results,
                                     java.util.Map<java.lang.String,​java.lang.Object> settings)
                              throws PacketErrorTypeException
        Description copied from class: XMPPProcessorAbstract
        The method is called for packets received by the server for which no user session is found - neither sender session or receiver session. The default implementation does nothing, just ignores such a packet. To change the default behaviour the method has to be overwritten.
        Overrides:
        processNullSessionPacket in class XMPPProcessorAbstract
        Parameters:
        packet - is a Packet received by the server.
        repo - is a NonAuthUserRepository instance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.
        results - is a packets Queue with all the processing results from the plugin.
        settings - is a Map with all the configuration settings passed to the plugin.
        Throws:
        PacketErrorTypeException - on attempt to send an error response to the error packet.

      • processServerSessionPacket

        public void processServerSessionPacket​(Packet packet,
                                       XMPPResourceConnection session,
                                       NonAuthUserRepository repo,
                                       java.util.Queue<Packet> results,
                                       java.util.Map<java.lang.String,​java.lang.Object> settings)
                                throws PacketErrorTypeException
        Description copied from class: XMPPProcessorAbstract
        The method is called when a packet addressed to the server domain is received. Please note, if a local user sends a packet to the server, the packet is handled by the processFromUserPacket(...) method. This method is not called for such packets.
        Specified by:
        processServerSessionPacket in class XMPPProcessorAbstract
        Parameters:
        packet - is a Packet received by the server and addressed to the server - the server virtual domain name.
        session - is a XMPPResourceConnection instance with all the server session data.
        repo - is a NonAuthUserRepository instance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.
        results - is a packets Queue with all the processing results from the plugin.
        settings - is a Map with all the configuration settings passed to the plugin.
        Throws:
        PacketErrorTypeException - on attempt to send an error response to the error packet.

      • 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
        Overrides:
        supDiscoFeatures in class AnnotatedXMPPProcessor
        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
        Overrides:
        supElementNamePaths in class AnnotatedXMPPProcessor
        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
        Overrides:
        supNamespaces in class AnnotatedXMPPProcessor
        Returns:
        a String[] value