Package tigase.xmpp.impl
Class SaslAuth
- java.lang.Object
-
- tigase.xmpp.XMPPProcessor
-
- tigase.xmpp.impl.AbstractAuthPreprocessor
-
- tigase.xmpp.impl.SaslAuth
-
- All Implemented Interfaces:
java.lang.Comparable<XMPPImplIfc>
,XMPPImplIfc
,XMPPPreprocessorIfc
,XMPPProcessorConcurrencyAwareIfc
,XMPPProcessorIfc
@Bean(name="urn:ietf:params:xml:ns:xmpp-sasl", parent=SessionManager.class, active=true) public class SaslAuth extends AbstractAuthPreprocessor implements XMPPProcessorIfc
Describe class SaslAuth here.
Created: Mon Feb 20 16:28:13 2006- Author:
- Artur Hefczyc
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SaslAuth.ElementType
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
ALLOWED_SASL_MECHANISMS_KEY
static java.lang.String
ID
-
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 Description SaslAuth()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
concurrentQueuesNo()
Methods returns a preferable number of threads/packets queues for the plugin.java.lang.String
id()
Methodid
returns a unique ID of the plugin.protected void
onAuthFail(XMPPResourceConnection session)
void
process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> settings)
Element[]
supDiscoFeatures(XMPPResourceConnection session)
MethodsupDiscoFeatures
returns an array of XMLElement
s with service discovery features which have to be returned to the client uppon request.java.lang.String[][]
supElementNamePaths()
MethodsupElementNamePaths
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.java.lang.String[]
supNamespaces()
MethodsupNamespaces
returns an array of name-spaces for stanzas which can be processed by this plugin.Element[]
supStreamFeatures(XMPPResourceConnection session)
MethodsupStreamFeatures
returns an array of XMLElement
s with stream features which have to be returned to the client uppon request.-
Methods inherited from class tigase.xmpp.impl.AbstractAuthPreprocessor
getAllowMatchers, isPacketAllowed, preProcess, setAllowMatchers
-
Methods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, 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, getComponentInfo, getStatistics, init, supTypes
-
-
-
-
Field Detail
-
ID
public static final java.lang.String ID
- See Also:
- Constant Field Values
-
ALLOWED_SASL_MECHANISMS_KEY
protected static final java.lang.String ALLOWED_SASL_MECHANISMS_KEY
- See Also:
- Constant Field Values
-
-
Method Detail
-
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 interfaceXMPPImplIfc
- Overrides:
concurrentQueuesNo
in classXMPPProcessor
- Returns:
- an integer preferred number of processing threads for the plugin.
-
id
public java.lang.String id()
Description copied from interface:XMPPImplIfc
Methodid
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 interfaceXMPPImplIfc
- Returns:
- a
String
value
-
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)
- Specified by:
process
in interfaceXMPPProcessorIfc
- 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.
-
supDiscoFeatures
public Element[] supDiscoFeatures(XMPPResourceConnection session)
Description copied from interface:XMPPImplIfc
MethodsupDiscoFeatures
returns an array of XMLElement
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.- Specified by:
supDiscoFeatures
in interfaceXMPPImplIfc
- Overrides:
supDiscoFeatures
in classXMPPProcessor
- Parameters:
session
- aXMPPResourceConnection
value- Returns:
- an
Element[]
value
-
supElementNamePaths
public java.lang.String[][] supElementNamePaths()
Description copied from interface:XMPPImplIfc
MethodsupElementNamePaths
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 bysupNamespaces()
method. The element path itself is represented by a String array with each path element as a separate String.- Specified by:
supElementNamePaths
in interfaceXMPPImplIfc
- Overrides:
supElementNamePaths
in classXMPPProcessor
- 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
MethodsupNamespaces
returns an array of name-spaces for stanzas which can be processed by this plugin. Each namespace corresponds to element name returned in array bysupElemenets()
method.- Specified by:
supNamespaces
in interfaceXMPPImplIfc
- Overrides:
supNamespaces
in classXMPPProcessor
- Returns:
- a
String[]
value
-
supStreamFeatures
public Element[] supStreamFeatures(XMPPResourceConnection session)
Description copied from interface:XMPPImplIfc
MethodsupStreamFeatures
returns an array of XMLElement
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.- Specified by:
supStreamFeatures
in interfaceXMPPImplIfc
- Overrides:
supStreamFeatures
in classXMPPProcessor
- Parameters:
session
- aXMPPResourceConnection
value- Returns:
- an
Element[]
value
-
onAuthFail
protected void onAuthFail(XMPPResourceConnection session)
-
-