Package tigase.xmpp.impl
Class RemoteRosterManagement
java.lang.Object
tigase.xmpp.XMPPProcessor
tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
tigase.xmpp.XMPPProcessorAbstract
tigase.xmpp.impl.RemoteRosterManagement
- All Implemented Interfaces:
Comparable<XMPPImplIfc>,XMPPImplIfc,XMPPProcessorConcurrencyAwareIfc,XMPPProcessorIfc
@Bean(name="remote-roster-management",
parent=SessionManager.class,
active=false)
public class RemoteRosterManagement
extends XMPPProcessorAbstract
- Author:
- andrzej
-
Field Summary
FieldsFields inherited from class tigase.xmpp.XMPPProcessor
ALL_NAMES, ALL_PATHS, cmpInfoFields inherited from interface tigase.xmpp.XMPPImplIfc
CLIENT_XMLNS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionid()Methodidreturns a unique ID of the plugin.static booleanisRemoteAllowed(JID jid, XMPPResourceConnection session) voidprocessFromUserToServerPacket(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...).voidprocessServerSessionPacket(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.voidprocessToUserPacket(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[][]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.static voidupdateBuddyChange(XMPPResourceConnection session, Element item, Element update, Queue<Packet> results) Methods inherited from class tigase.xmpp.XMPPProcessorAbstract
isFromUserSession, isNullSession, isServerSession, isToUserSession, process, processFromUserOutPacket, processFromUserPacket, processNullSessionPacketMethods inherited from class tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
supDiscoFeatures, supStreamFeatures, supTypesMethods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface tigase.xmpp.XMPPImplIfc
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, init, supDiscoFeatures, supStreamFeatures, supTypes
-
Field Details
-
ID
- See Also:
-
-
Constructor Details
-
RemoteRosterManagement
public RemoteRosterManagement()
-
-
Method Details
-
isRemoteAllowed
-
updateBuddyChange
public static void updateBuddyChange(XMPPResourceConnection session, Element item, Element update, Queue<Packet> results) throws NotAuthorizedException, TigaseDBException -
id
Description copied from interface:XMPPImplIfcMethodidreturns 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.- Specified by:
idin interfaceXMPPImplIfc- Overrides:
idin classAnnotatedXMPPProcessor- Returns:
- a
Stringvalue
-
processFromUserToServerPacket
public void processFromUserToServerPacket(JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws PacketErrorTypeExceptionDescription copied from class:XMPPProcessorAbstractThe 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...). There is no default implementation for the method.- Specified by:
processFromUserToServerPacketin classXMPPProcessorAbstract- Parameters:
connectionId- is aJIDinstance with the session connection ID.packet- is aPacketsent by the user.session- is aXMPPResourceConnectioninstance with all the sending user session data.repo- is aNonAuthUserRepositoryinstance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.results- is a packetsQueuewith all the processing results from the plugin.settings- is aMapwith all the configuration settings passed to the plugin.- Throws:
PacketErrorTypeException- on attempt to send an error response to the error packet.
-
processServerSessionPacket
public void processServerSessionPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws PacketErrorTypeExceptionDescription copied from class:XMPPProcessorAbstractThe method is called when a packet addressed to the server domain is received. Please note, if a local user sends a packet to the server, the packet is handled by theprocessFromUserPacket(...)method. This method is not called for such packets.- Specified by:
processServerSessionPacketin classXMPPProcessorAbstract- Parameters:
packet- is aPacketreceived by the server and addressed to the server - the server virtual domain name.session- is aXMPPResourceConnectioninstance with all the server session data.repo- is aNonAuthUserRepositoryinstance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.results- is a packetsQueuewith all the processing results from the plugin.settings- is aMapwith all the configuration settings passed to the plugin.- Throws:
PacketErrorTypeException- on attempt to send an error response to the error packet.
-
processToUserPacket
public void processToUserPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws PacketErrorTypeExceptionDescription copied from class:XMPPProcessorAbstractMethod is called for all the packets sent TO the user - owner of the session. The default implementation just forwards the packet to the user connection. To change the default behavior the method has to be overwritten.- Overrides:
processToUserPacketin classXMPPProcessorAbstract- Parameters:
packet- is aPacketreceived by the server and addressed to the server - the server virtual domain name.session- is aXMPPResourceConnectioninstance with all the receiving user session data.repo- is aNonAuthUserRepositoryinstance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.results- is a packetsQueuewith all the processing results from the plugin.settings- is aMapwith all the configuration settings passed to the plugin.- Throws:
PacketErrorTypeException- on attempt to send an error response to the error packet.
-
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- Overrides:
supElementNamePathsin classAnnotatedXMPPProcessor- 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- Overrides:
supNamespacesin classAnnotatedXMPPProcessor- Returns:
- a
String[]value
-