public interface XMPPImplIfc extends Comparable<XMPPImplIfc>
Modifier and Type | Field and Description |
---|---|
static String |
CLIENT_XMLNS |
Modifier and Type | Method and Description |
---|---|
Authorization |
canHandle(Packet packet,
XMPPResourceConnection conn)
By default the method uses
supElementNamePaths() and supTypes() method results to determine
whether the plugin would process given packet. |
default int |
concurrentQueuesNo()
Methods returns a preferable number of threads/packets queues for the plugin.
|
ComponentInfo |
getComponentInfo()
Allows to obtain various informations about components
|
void |
getStatistics(StatisticsList list)
The method allows to retrieve plugin own statistics if it generates any.
|
String |
id()
Method
id returns a unique ID of the plugin. |
void |
init(Map<String,Object> settings)
Deprecated.
|
Element[] |
supDiscoFeatures(XMPPResourceConnection session)
Method
supDiscoFeatures returns an array of XML Element s with service discovery
features which have to be returned to the client uppon request. |
String[][] |
supElementNamePaths()
Method
supElementNamePaths 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. |
String[] |
supNamespaces()
Method
supNamespaces returns an array of name-spaces for stanzas which can be processed by this
plugin. |
Element[] |
supStreamFeatures(XMPPResourceConnection session)
Method
supStreamFeatures returns an array of XML Element s with stream features which
have to be returned to the client uppon request. |
Set<StanzaType> |
supTypes()
Method returns an array of all stanza types which the plugin is able to handle.
|
compareTo
static final String CLIENT_XMLNS
Authorization canHandle(Packet packet, XMPPResourceConnection conn)
supElementNamePaths()
and 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.packet
- is a Packet
for processing.conn
- is a user session object or null.Authorization
enum value or null. Null means the plugin is simply not processing the
packet. Authorization.AUTHORIZED
means the plugin can process the packet, any other Authorization
enum value means an error which has to be returned to the sender.default int concurrentQueuesNo()
String id()
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.String
value@Deprecated void init(Map<String,Object> settings) throws TigaseDBException
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.settings
- is a Map with initial processor settings from the configuration file.TigaseDBException
Element[] supDiscoFeatures(XMPPResourceConnection session)
supDiscoFeatures
returns an array of XML Element
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.session
- a XMPPResourceConnection
valueElement[]
valueString[][] supElementNamePaths()
supElementNamePaths
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 by supNamespaces()
method. The element path itself is represented by a String array with
each path element as a separate String.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.String[] supNamespaces()
supNamespaces
returns an array of name-spaces for stanzas which can be processed by this
plugin. Each namespace corresponds to element name returned in array by supElemenets()
method.String[]
valueElement[] supStreamFeatures(XMPPResourceConnection session)
supStreamFeatures
returns an array of XML Element
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.session
- a XMPPResourceConnection
valueElement[]
valueSet<StanzaType> supTypes()
StanzaType[]
array of supported stanza types.ComponentInfo getComponentInfo()
void getStatistics(StatisticsList list)
list
- is a statistics collection to which plugins own metrics can be added.Copyright © 2004–2021 "Tigase, Inc.". All rights reserved.