tigase.xmpp.impl

Class JabberIqRegister

java.lang.Object

tigase.xmpp.XMPPProcessor

tigase.xmpp.impl.JabberIqRegister

All Implemented Interfaces:

Comparable<XMPPImplIfc>, XMPPImplIfc, XMPPProcessorIfc

public class JabberIqRegister
extends XMPPProcessor
implements XMPPProcessorIfc

JEP-0077: In-Band Registration Created: Thu Feb 16 13:14:06 2006

Version:

$Rev$

Author:

Artur Hefczyc

Field Summary

Fields

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

Fields inherited from class tigase.xmpp.XMPPProcessor

ALL_NAMES, ALL_PATHS, cmpInfo

Fields inherited from interface tigase.xmpp.XMPPImplIfc

CLIENT_XMLNS

Constructor Summary

Constructors

Constructor and Description
JabberIqRegister()

Method Summary

Methods

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 description
void	init(Map<String,Object> settings) Method init is called just after the plugin has been loaded into memory.
protected boolean	isRegistrationAllowedForConnection(tigase.xmpp.JID from)
boolean	isSignedFormRequired()
void	process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) Method description
void	setOAuthCredentials(String oauthConsumerKey, String oauthConsumerSecret)
void	setSignedFormRequired(boolean required)
tigase.xml.Element[]	supDiscoFeatures(XMPPResourceConnection session) Method description
String[][]	supElementNamePaths() Method description
String[]	supNamespaces() Method description
tigase.xml.Element[]	supStreamFeatures(XMPPResourceConnection session) Method description

Methods inherited from class tigase.xmpp.XMPPProcessor

canHandle, compareTo, concurrentQueuesNo, concurrentThreadsPerQueue, getComponentInfo, getInstance, isSupporting, supElements, supTypes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface tigase.xmpp.XMPPImplIfc

canHandle, concurrentQueuesNo, concurrentThreadsPerQueue, getComponentInfo, isSupporting, supElements, supTypes

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

REGISTRATION_BLACKLIST_PROP_KEY

public static final String REGISTRATION_BLACKLIST_PROP_KEY

Whitelist properties

See Also:

Constant Field Values

REGISTRATION_WHITELIST_PROP_KEY

public static final String REGISTRATION_WHITELIST_PROP_KEY

See Also:

Constant Field Values

WHITELIST_REGISTRATION_ONLY_PROP_KEY

public static final String WHITELIST_REGISTRATION_ONLY_PROP_KEY

See Also:

Constant Field Values

OAUTH_CONSUMERKEY_PROP_KEY

public static final String OAUTH_CONSUMERKEY_PROP_KEY

OAuth details for form verifier.

See Also:

Constant Field Values

OAUTH_CONSUMERSECRET_PROP_KEY

public static final String OAUTH_CONSUMERSECRET_PROP_KEY

See Also:

Constant Field Values

SIGNED_FORM_REQUIRED_PROP_KEY

public static final String SIGNED_FORM_REQUIRED_PROP_KEY

See Also:

Constant Field Values

Constructor Detail

JabberIqRegister

public JabberIqRegister()

Method Detail

setOAuthCredentials

public void setOAuthCredentials(String oauthConsumerKey,
                       String oauthConsumerSecret)

setSignedFormRequired

public void setSignedFormRequired(boolean required)

id

public String id()

Method description

Specified by:

id in interface XMPPImplIfc

Returns:

a String value

process

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

Method description

Specified by:

process in interface XMPPProcessorIfc

Parameters:

packet -

session -

repo -

results -

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

isRegistrationAllowedForConnection

protected boolean isRegistrationAllowedForConnection(tigase.xmpp.JID from)

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.

init

public void init(Map<String,Object> settings)
          throws TigaseDBException

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

Overrides:

init in class XMPPProcessor

Parameters:

settings - is a Map with initial processor settings from the configuration file.

Throws:

TigaseDBException

supDiscoFeatures

public tigase.xml.Element[] supDiscoFeatures(XMPPResourceConnection session)

Method description

Specified by:

supDiscoFeatures in interface XMPPImplIfc

Overrides:

supDiscoFeatures in class XMPPProcessor

Parameters:

session -

Returns:

an Element[] value

supElementNamePaths

public String[][] supElementNamePaths()

Method description

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 String[] supNamespaces()

Method description

Specified by:

supNamespaces in interface XMPPImplIfc

Overrides:

supNamespaces in class XMPPProcessor

Returns:

a String[] value

supStreamFeatures

public tigase.xml.Element[] supStreamFeatures(XMPPResourceConnection session)

Method description

Specified by:

supStreamFeatures in interface XMPPImplIfc

Overrides:

supStreamFeatures in class XMPPProcessor

Parameters:

session -

Returns:

an Element[] value

isSignedFormRequired

public boolean isSignedFormRequired()