tigase.xmpp
Class XMPPProcessor

java.lang.Object
  tigase.xmpp.XMPPProcessor

All Implemented Interfaces:

Comparable<XMPPImplIfc>, XMPPImplIfc

Direct Known Subclasses:

BindResource, DomainFilter, JabberIqAuth, JabberIqCommand, JabberIqIq, JabberIqPrivacy, JabberIqPrivate, JabberIqRegister, JabberIqRoster, JabberIqStats, Jingle, Message, MessageAll, MessageAmp, MessageArchive, MessageForwarding, MobileV1, MobileV2, OfflineMessages, Presence, RosterPresence, SaslAuth, SessionBind, SimpleForwarder, StartTLS, StartZLib, XMPPProcessorAbstract

public abstract class XMPPProcessor
extends Object
implements XMPPImplIfc

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 recognize 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 partialy 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

Version:

$Rev: 2996 $

Author:

Artur Hefczyc

Field Summary

protected static String

ALL

Fields inherited from interface tigase.xmpp.XMPPImplIfc

CLIENT_XMLNS

Constructor Summary

protected

XMPPProcessor()

Method Summary

int	compareTo(XMPPImplIfc proc) Method compareTo is used to perform
int	concurrentQueuesNo() Method description
int	concurrentThreadsPerQueue() Deprecated.
XMPPProcessor	getInstance() Method description
void	getStatistics(StatisticsList list) The method allows to retrieve plugin own statistics if it generates any.
void	init(Map<String,Object> settings) Method description
boolean	isSupporting(String element, String ns) Method description
tigase.xml.Element[]	supDiscoFeatures(XMPPResourceConnection session) Method description
String[]	supElements() Method description
String[]	supNamespaces() Method description
tigase.xml.Element[]	supStreamFeatures(XMPPResourceConnection session) Method description

Methods inherited from class java.lang.Object

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

Methods inherited from interface tigase.xmpp.XMPPImplIfc

id

Field Detail

ALL

protected static final String ALL

See Also:

Constant Field Values

Constructor Detail

XMPPProcessor

protected XMPPProcessor()

Method Detail

compareTo

public final int compareTo(XMPPImplIfc proc)

Method compareTo is used to perform

Specified by:

compareTo in interface Comparable<XMPPImplIfc>

Parameters:

proc - an XMPPProcessor value

Returns:

an int value

concurrentQueuesNo

public int concurrentQueuesNo()

Method description

Specified by:

concurrentQueuesNo in interface XMPPImplIfc

Returns:

concurrentThreadsPerQueue

@Deprecated
public int concurrentThreadsPerQueue()

Deprecated.

Method description

Specified by:

concurrentThreadsPerQueue in interface XMPPImplIfc

Returns:

getInstance

public XMPPProcessor getInstance()

Method description

Returns:

init

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

Method description

Specified by:

init in interface XMPPImplIfc

Parameters:

settings -

Throws:

TigaseDBException

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

Parameters:

list - is a statistics collection to which plugins own metrics can be added.

isSupporting

public boolean isSupporting(String element,
                            String ns)

Method description

Specified by:

isSupporting in interface XMPPImplIfc

Parameters:

element -

ns -

Returns:

supDiscoFeatures

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

Method description

Specified by:

supDiscoFeatures in interface XMPPImplIfc

Parameters:

session -

Returns:

supElements

public String[] supElements()

Method description

Specified by:

supElements in interface XMPPImplIfc

Returns:

supNamespaces

public String[] supNamespaces()

Method description

Specified by:

supNamespaces in interface XMPPImplIfc

Returns:

supStreamFeatures

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

Method description

Specified by:

supStreamFeatures in interface XMPPImplIfc

Parameters:

session -

Returns: