public class RemoteRosterManagement extends XMPPProcessorAbstract
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
RemoteRosterManagement() |
Modifier and Type | Method and Description |
---|---|
String |
id()
Method
id returns a unique ID of the plugin. |
static boolean |
isRemoteAllowed(JID jid,
XMPPResourceConnection session)
Method description
|
void |
processFromUserToServerPacket(JID connectionId,
Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
The method is called when a packet is send from the user who is owner of the session
to the local server (ping, roster management, privacy lists, etc...).
|
void |
processServerSessionPacket(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
The method is called when a packet addressed to the server domain is received.
|
void |
processToUserPacket(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
Method is called for all the packets sent TO the user - owner of the session.
|
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. |
static void |
updateBuddyChange(XMPPResourceConnection session,
Element item,
Element update,
Queue<Packet> results)
Method description
|
process, processFromUserOutPacket, processFromUserPacket, processNullSessionPacket
supDiscoFeatures, supStreamFeatures, supTypes
canHandle, compareTo, concurrentThreadsPerQueue, getComponentInfo, getInstance, getStatistics, init, isSupporting, supElements, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, concurrentThreadsPerQueue, getComponentInfo, getStatistics, init, isSupporting, supDiscoFeatures, supElements, supStreamFeatures, supTypes
compareTo
public String id()
XMPPImplIfc
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.id
in interface XMPPImplIfc
id
in class AnnotatedXMPPProcessor
String
valuepublic void processFromUserToServerPacket(JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
XMPPProcessorAbstract
processFromUserToServerPacket
in class XMPPProcessorAbstract
connectionId
- is a JID
instance with the session connection ID.packet
- is a Packet
sent by the user.session
- is a XMPPResourceConnection
instance with all the sending
user session data.repo
- is a NonAuthUserRepository
instance giving access to a part
of the user repository which is accessible regardless the session is authenticated or not.results
- is a packets Queue
with all the processing results from
the plugin.settings
- is a Map
with all the configuration settings passed to the
plugin.PacketErrorTypeException
- on attempt to send an error response to the error
packet.public void processServerSessionPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
XMPPProcessorAbstract
processFromUserPacket(...)
method. This method is not called for such
packets.processServerSessionPacket
in class XMPPProcessorAbstract
packet
- is a Packet
received by the server and addressed to the
server - the server virtual domain name.session
- is a XMPPResourceConnection
instance with all the server
session data.repo
- is a NonAuthUserRepository
instance giving access to a part
of the user repository which is accessible regardless the session is authenticated or not.results
- is a packets Queue
with all the processing results from
the plugin.settings
- is a Map
with all the configuration settings passed to the
plugin.PacketErrorTypeException
- on attempt to send an error response to the error
packet.public void processToUserPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
XMPPProcessorAbstract
processToUserPacket
in class XMPPProcessorAbstract
packet
- is a Packet
received by the server and addressed to the
server - the server virtual domain name.session
- is a XMPPResourceConnection
instance with all the receiving
user session data.repo
- is a NonAuthUserRepository
instance giving access to a part
of the user repository which is accessible regardless the session is authenticated or not.results
- is a packets Queue
with all the processing results from
the plugin.settings
- is a Map
with all the configuration settings passed to the
plugin.PacketErrorTypeException
- on attempt to send an error response to the error
packet.public String[][] supElementNamePaths()
XMPPImplIfc
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.supElementNamePaths
in interface XMPPImplIfc
supElementNamePaths
in class AnnotatedXMPPProcessor
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.public String[] supNamespaces()
XMPPImplIfc
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.supNamespaces
in interface XMPPImplIfc
supNamespaces
in class AnnotatedXMPPProcessor
String[]
valuepublic static boolean isRemoteAllowed(JID jid, XMPPResourceConnection session)
jid
- session
- public static void updateBuddyChange(XMPPResourceConnection session, Element item, Element update, Queue<Packet> results) throws NotAuthorizedException, TigaseDBException
session
- item
- update
- results
- NotAuthorizedException
TigaseDBException
Copyright © 2019 "Tigase, Inc.". All rights reserved.