Package tigase.xmpp.impl

Class JabberIqRegister

    • Field Detail

      • REGISTRATION_PER_SECOND_PROP_KEY

        public static final java.lang.String REGISTRATION_PER_SECOND_PROP_KEY
        See Also:
        Constant Field Values

      • REGISTRATION_BLACKLIST_PROP_KEY

        public static final java.lang.String REGISTRATION_BLACKLIST_PROP_KEY
        See Also:
        Constant Field Values

      • REGISTRATION_WHITELIST_PROP_KEY

        public static final java.lang.String REGISTRATION_WHITELIST_PROP_KEY
        See Also:
        Constant Field Values

      • WHITELIST_REGISTRATION_ONLY_PROP_KEY

        public static final java.lang.String WHITELIST_REGISTRATION_ONLY_PROP_KEY
        See Also:
        Constant Field Values

      • OAUTH_CONSUMERKEY_PROP_KEY

        public static final java.lang.String OAUTH_CONSUMERKEY_PROP_KEY
        OAuth details for form verifier.
        See Also:
        Constant Field Values

      • OAUTH_CONSUMERSECRET_PROP_KEY

        public static final java.lang.String OAUTH_CONSUMERSECRET_PROP_KEY
        See Also:
        Constant Field Values

      • SIGNED_FORM_REQUIRED_PROP_KEY

        public static final java.lang.String SIGNED_FORM_REQUIRED_PROP_KEY
        See Also:
        Constant Field Values

    • Constructor Detail

      • JabberIqRegister

        public JabberIqRegister()

    • Method Detail

      • getRegistrationsPerSecond

        public long getRegistrationsPerSecond()

      • setRegistrationsPerSecond

        public void setRegistrationsPerSecond​(long registrationsPerSecond)

      • getRegistrationBlacklist

        public java.util.LinkedList<java.lang.String> getRegistrationBlacklist()

      • setRegistrationBlacklist

        public void setRegistrationBlacklist​(java.util.LinkedList<java.lang.String> vals)

      • getRegistrationWhitelist

        public java.util.LinkedList<java.lang.String> getRegistrationWhitelist()

      • setRegistrationWhitelist

        public void setRegistrationWhitelist​(java.util.LinkedList<java.lang.String> vals)

      • 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

      • 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
        Overrides:
        getStatistics in class XMPPProcessor
        Parameters:
        list - is a statistics collection to which plugins own metrics can be added.

      • 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
        Returns:
        a String value

      • initialize

        public void initialize()
        Description copied from interface: Initializable
        Method will be called, when bean will be created, configured and ready to use.
        Specified by:
        initialize in interface Initializable

      • isSignedFormRequired

        public boolean isSignedFormRequired()

      • setSignedFormRequired

        public void setSignedFormRequired​(boolean required)

      • process

        public void process​(Packet packet,
                    XMPPResourceConnection session,
                    NonAuthUserRepository repo,
                    java.util.Queue<Packet> results,
                    java.util.Map<java.lang.String,​java.lang.Object> settings)
             throws XMPPException

        TODO: Implement registration form configurable and loading all the fields from the registration form TODO: rewrite the plugin using the XMPPProcessorAbstract API
        Specified by:
        process in interface XMPPProcessorIfc
        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.
        repo - 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.
        settings - 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

      • setOAuthCredentials

        public void setOAuthCredentials​(java.lang.String oauthConsumerKey,
                                java.lang.String oauthConsumerSecret)

      • 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 XMPPProcessor
        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 XMPPProcessor
        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 XMPPProcessor
        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
        Overrides:
        supStreamFeatures in class XMPPProcessor
        Parameters:
        session - a XMPPResourceConnection value
        Returns:
        an Element[] value

      • isRegistrationAllowedForConnection

        protected boolean isRegistrationAllowedForConnection​(JID from)

      • isTokenInBucket

        protected boolean isTokenInBucket​(JID from)