public class JabberIqRegister extends XMPPProcessor implements XMPPProcessorIfc
Modifier and Type | Field and Description |
---|---|
static String |
ID |
static String |
OAUTH_CONSUMERKEY_PROP_KEY
OAuth details for form verifier.
|
static String |
OAUTH_CONSUMERSECRET_PROP_KEY |
static String |
REGISTRATION_BLACKLIST_PROP_KEY
Whitelist properties
|
static String |
REGISTRATION_WHITELIST_PROP_KEY |
static String |
SIGNED_FORM_REQUIRED_PROP_KEY |
static String |
WHITELIST_REGISTRATION_ONLY_PROP_KEY |
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
JabberIqRegister() |
Modifier and Type | Method and Description |
---|---|
void |
getStatistics(StatisticsList list)
The method allows to retrieve plugin own statistics if it generates any.
|
String |
id()
Method
id returns a unique ID of the plugin. |
void |
init(Map<String,Object> settings)
Method
init is called just after the plugin has been loaded
into memory. |
protected boolean |
isRegistrationAllowedForConnection(JID from) |
boolean |
isSignedFormRequired() |
void |
process(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
TODO: Implement registration form configurable and loading all the fields from the registration form TODO: rewrite the plugin using the XMPPProcessorAbstract API |
void |
setOAuthCredentials(String oauthConsumerKey,
String oauthConsumerSecret) |
void |
setSignedFormRequired(boolean required) |
Element[] |
supDiscoFeatures(XMPPResourceConnection session)
Method
supDiscoFeatures returns an array of XML
Element s with service discovery features which have to be
returned to the client uppon request. |
String[][] |
supElementNamePaths()
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. |
String[] |
supNamespaces()
Method
supNamespaces returns an array of name-spaces for
stanzas which can be processed by this plugin. |
Element[] |
supStreamFeatures(XMPPResourceConnection session)
Method
supStreamFeatures returns an array of XML
Element s with stream features which have to be returned to the
client uppon request. |
canHandle, compareTo, concurrentThreadsPerQueue, getComponentInfo, getInstance, isSupporting, supElements, supTypes, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, concurrentThreadsPerQueue, getComponentInfo, isSupporting, supElements, supTypes
compareTo
public static final String ID
public static final String REGISTRATION_BLACKLIST_PROP_KEY
public static final String REGISTRATION_WHITELIST_PROP_KEY
public static final String WHITELIST_REGISTRATION_ONLY_PROP_KEY
public static final String OAUTH_CONSUMERKEY_PROP_KEY
public static final String OAUTH_CONSUMERSECRET_PROP_KEY
public static final String SIGNED_FORM_REQUIRED_PROP_KEY
public void setOAuthCredentials(String oauthConsumerKey, String oauthConsumerSecret)
public void setSignedFormRequired(boolean required)
public String id()
XMPPImplIfc
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.id
in interface XMPPImplIfc
String
valuepublic void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws XMPPException
process
in interface XMPPProcessorIfc
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.XMPPException
protected boolean isRegistrationAllowedForConnection(JID from)
public void getStatistics(StatisticsList list)
XMPPImplIfc
getStatistics
in interface XMPPImplIfc
getStatistics
in class XMPPProcessor
list
- is a statistics collection to which plugins own metrics can be added.public void init(Map<String,Object> settings) throws TigaseDBException
XMPPImplIfc
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.init
in interface XMPPImplIfc
init
in class XMPPProcessor
settings
- is a Map with initial processor settings from the configuration
file.TigaseDBException
public Element[] supDiscoFeatures(XMPPResourceConnection session)
XMPPImplIfc
supDiscoFeatures
returns an array of XML
Element
s 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.supDiscoFeatures
in interface XMPPImplIfc
supDiscoFeatures
in class XMPPProcessor
session
- a XMPPResourceConnection
valueElement[]
valuepublic String[][] supElementNamePaths()
XMPPImplIfc
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.supElementNamePaths
in interface XMPPImplIfc
supElementNamePaths
in class XMPPProcessor
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.public String[] supNamespaces()
XMPPImplIfc
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.supNamespaces
in interface XMPPImplIfc
supNamespaces
in class XMPPProcessor
String[]
valuepublic Element[] supStreamFeatures(XMPPResourceConnection session)
XMPPImplIfc
supStreamFeatures
returns an array of XML
Element
s 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.supStreamFeatures
in interface XMPPImplIfc
supStreamFeatures
in class XMPPProcessor
session
- a XMPPResourceConnection
valueElement[]
valuepublic boolean isSignedFormRequired()
Copyright © 2019 "Tigase, Inc.". All rights reserved.