Package tigase.xmpp
Class XMPPProcessor
java.lang.Object
tigase.xmpp.XMPPProcessor
- All Implemented Interfaces:
Comparable<XMPPImplIfc>,XMPPImplIfc,XMPPProcessorConcurrencyAwareIfc
- Direct Known Subclasses:
AbstractAuthPreprocessor,AddressingSanitizer,AnnotatedXMPPProcessor,BindResource,CAPS,DomainFilter,InvisibleCommand,JabberIqCommand,JabberIqIq,JabberIqPrivacy,JabberIqPrivate,JabberIqRegister,JabberIqRoster,JabberIqStats,Jingle,MessageAll,MessageAmp,MessageCarbons,MessageForwarding,MobileV1,MobileV2,OfflineMessages,SessionManager.DefaultHandlerProc,SessionManager.SessionCloseProc,SessionManager.SessionOpenProc,SimpleForwarder,StartTLS,StartZLib
public abstract class XMPPProcessor
extends Object
implements XMPPImplIfc, XMPPProcessorConcurrencyAwareIfc
XMPPProcessor abstract class contains basic definition for XMPP processor. To create new
processor implementing particular XMPP functionality it is enough to extend this class and implement one
abstract method.Additionally to allow system properly recognise this processor you need also to implement own constructor which sets proper values to parent constructor. You must implement exactly one constructor with zero parameters which calls parent constructor with proper values. Refer to constructor documentation for information about required parameters.
To fully interact with entity connected to the session or with other entities in XMPP network you should be also familiar with
addReply(...), addMessage(...) and
addBroadcast(...) methods.There is also partially implemented functionality to send messages to entities in other networks like SMTP or other implemented by the server. Once this implementation is finished there will be more information available. If you, however, are interested in this particular feature send a question to author.
Created: Tue Oct 5 20:31:23 2004
- Author:
- Artur Hefczyc
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final Stringprotected static final String[][]protected static ComponentInfoFields inherited from interface tigase.xmpp.XMPPImplIfc
CLIENT_XMLNS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncanHandle(Packet packet, XMPPResourceConnection conn) By default the method usesXMPPImplIfc.supElementNamePaths()andXMPPImplIfc.supTypes()method results to determine whether the plugin would process given packet.final intcompareTo(XMPPImplIfc proc) intMethods returns a preferable number of threads/packets queues for the plugin.Allows to obtain various informations about componentsvoidgetStatistics(StatisticsList list) The method allows to retrieve plugin own statistics if it generates any.intvoidDeprecated.Element[]supDiscoFeatures(XMPPResourceConnection session) MethodsupDiscoFeaturesreturns an array of XMLElements with service discovery features which have to be returned to the client uppon request.String[][]MethodsupElementNamePathsreturns 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[]MethodsupNamespacesreturns an array of name-spaces for stanzas which can be processed by this plugin.Element[]supStreamFeatures(XMPPResourceConnection session) MethodsupStreamFeaturesreturns an array of XMLElements with stream features which have to be returned to the client uppon request.supTypes()Method returns an array of all stanza types which the plugin is able to handle.toString()Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface tigase.xmpp.XMPPImplIfc
id
-
Field Details
-
ALL_NAMES
- See Also:
-
ALL_PATHS
-
cmpInfo
-
-
Constructor Details
-
XMPPProcessor
protected XMPPProcessor()
-
-
Method Details
-
canHandle
Description copied from interface:XMPPImplIfcBy default the method usesXMPPImplIfc.supElementNamePaths()andXMPPImplIfc.supTypes()method results to determine whether the plugin would process given packet. However, a plugin can implement own logic to determine packet processing capabilities or conditions. Please note, this method must be very fast and efficient. No I/O processing is recommended as it may impact performance of the whole system.- Specified by:
canHandlein interfaceXMPPImplIfc- Parameters:
packet- is aPacketfor processing.conn- is a user session object or null.- Returns:
- returns
Authorizationenum value or null. Null means the plugin is simply not processing the packet.Authorization.AUTHORIZEDmeans the plugin can process the packet, any otherAuthorizationenum value means an error which has to be returned to the sender.
-
compareTo
- Specified by:
compareToin interfaceComparable<XMPPImplIfc>
-
concurrentQueuesNo
public int concurrentQueuesNo()Description copied from interface:XMPPImplIfcMethods 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:
concurrentQueuesNoin interfaceXMPPImplIfc- Returns:
- an integer preferred number of processing threads for the plugin.
-
init
Deprecated.Description copied from interface:XMPPImplIfcMethodinitis 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:
initin interfaceXMPPImplIfc- Parameters:
settings- is a Map with initial processor settings from the configuration file.- Throws:
TigaseDBException
-
supDiscoFeatures
Description copied from interface:XMPPImplIfcMethodsupDiscoFeaturesreturns an array of XMLElements 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:
supDiscoFeaturesin interfaceXMPPImplIfc- Parameters:
session- aXMPPResourceConnectionvalue- Returns:
- an
Element[]value
-
supElementNamePaths
Description copied from interface:XMPPImplIfcMethodsupElementNamePathsreturns 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:
supElementNamePathsin interfaceXMPPImplIfc- 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
Description copied from interface:XMPPImplIfcMethodsupNamespacesreturns 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:
supNamespacesin interfaceXMPPImplIfc- Returns:
- a
String[]value
-
supStreamFeatures
Description copied from interface:XMPPImplIfcMethodsupStreamFeaturesreturns an array of XMLElements 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:
supStreamFeaturesin interfaceXMPPImplIfc- Parameters:
session- aXMPPResourceConnectionvalue- Returns:
- an
Element[]value
-
supTypes
Description copied from interface:XMPPImplIfcMethod returns an array of all stanza types which the plugin is able to handle. If the method returns NULL, then all stanzas of all types will be passed to the plugin for processing. Otherwise only stanzas with selected types, assuming that element names and name-spaces match as well.- Specified by:
supTypesin interfaceXMPPImplIfc- Returns:
- a
StanzaType[]array of supported stanza types.
-
getInstance
-
getStatistics
Description copied from interface:XMPPImplIfcThe method allows to retrieve plugin own statistics if it generates any.- Specified by:
getStatisticsin interfaceXMPPImplIfc- Parameters:
list- is a statistics collection to which plugins own metrics can be added.
-
getComponentInfo
Description copied from interface:XMPPImplIfcAllows to obtain various informations about components- Specified by:
getComponentInfoin interfaceXMPPImplIfc- Returns:
- information about particular component
-
toString
-
getThreadsNo
public int getThreadsNo()- Specified by:
getThreadsNoin interfaceXMPPProcessorConcurrencyAwareIfc
-
getQueueSize
- Specified by:
getQueueSizein interfaceXMPPProcessorConcurrencyAwareIfc
-