tigase.xmpp
Interface XMPPImplIfc

All Known Subinterfaces:

XMPPPostprocessorIfc, XMPPPreprocessorIfc, XMPPProcessorIfc, XMPPStopListenerIfc

All Known Implementing Classes:

BindResource, DomainFilter, IBB, JabberIqAuth, JabberIqCommand, JabberIqIq, JabberIqOOB, JabberIqPrivacy, JabberIqPrivate, JabberIqRegister, JabberIqSi, JabberIqSocks5Bytestreams, JabberIqStats, JabberIqVersion, Jingle, Message, MessageArchive, OfflineMessages, RosterPresence, SaslAuth, ServiceDiscovery, SessionBind, SimpleForwarder, StartTLS, UrnXmppPing, VCardTemp, XMPPProcessor

public interface XMPPImplIfc

Describe interface XMPPImplIfc here. Created: Sat Oct 14 16:11:22 2006

Version:

$Rev: 1125 $

Author:

Artur Hefczyc

Method Summary

java.lang.String	id() Method id returns a unique ID of the plugin.
void	init(UserRepository rep) Method init is called just after the plugin has been loaded into memory.
boolean	isSupporting(java.lang.String elem, java.lang.String ns) Method isSupporting takes element name and namespace for this element and determines whether this element can be processed by this plugin.
tigase.xml.Element[]	supDiscoFeatures(XMPPResourceConnection session) Method supDiscoFeatures returns an array of XML Elements with service discovery features which have to be returned to the client uppon request.
java.lang.String[]	supElements() Method supElements returns an array of element names for stanzas which can be processed by this plugin.
java.lang.String[]	supNamespaces() Method supNamespaces returns an array of namespaces for stanzas which can be processed by this pluing.
tigase.xml.Element[]	supStreamFeatures(XMPPResourceConnection session) Method supStreamFeatures returns an array of XML Elements with stream features which have to be returned to the client uppon request.

Method Detail

id

java.lang.String id()

Method 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.

Returns:

a String value

supElements

java.lang.String[] supElements()

Method supElements returns an array of element names for stanzas which can be processed by this plugin. Each element name corresponds to XMLNS returned in array by supNamespaces() method.

Returns:

a String[] value

supNamespaces

java.lang.String[] supNamespaces()

Method supNamespaces returns an array of namespaces for stanzas which can be processed by this pluing. Each namespace corresponds to element name returned in array by supElemenets() method.

Returns:

a String[] value

supStreamFeatures

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

Method supStreamFeatures returns an array of XML Elements 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.

Parameters:

session - a XMPPResourceConnection value

Returns:

an Element[] value

supDiscoFeatures

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

Method supDiscoFeatures returns an array of XML Elements 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.

Parameters:

session - a XMPPResourceConnection value

Returns:

an Element[] value

isSupporting

boolean isSupporting(java.lang.String elem,
                     java.lang.String ns)

Method isSupporting takes element name and namespace for this element and determines whether this element can be processed by this plugin.

Parameters:

elem - a String value

ns - a String value

Returns:

a boolean value

init

void init(UserRepository rep)
          throws TigaseDBException

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.

Parameters:

rep - an UserRepository value

Throws:

TigaseDBException