Package tigase.xmpp.impl
Class MessageCarbons
java.lang.Object
tigase.xmpp.XMPPProcessor
tigase.xmpp.impl.MessageCarbons
- All Implemented Interfaces:
Comparable<XMPPImplIfc>,SaslAuth2.Inline,XMPPImplIfc,XMPPPacketFilterIfc,XMPPProcessorConcurrencyAwareIfc,XMPPProcessorIfc
@Bean(name="message-carbons",
parent=SessionManager.class,
active=true)
public class MessageCarbons
extends XMPPProcessor
implements XMPPProcessorIfc, XMPPPacketFilterIfc, SaslAuth2.Inline
MessageCarbons class implements XEP-0280 Message Carbons protocol extension.
- Author:
- andrzej
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classEvent class responsible for notification other sessions of same user that message carbons state was changed.Nested classes/interfaces inherited from interface tigase.xmpp.impl.SaslAuth2.Inline
SaslAuth2.Inline.Action, SaslAuth2.Inline.Result -
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 TypeMethodDescriptionbooleancanHandle(XMPPResourceConnection connection, Element el) voidfilter(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results) String[]id()Methodidreturns a unique ID of the plugin.prepareSkipForkingToList(Packet packet, XMPPResourceConnection session, Map<JID, Boolean> resources) protected voidpresenceUpdate(UserPresenceChangedEvent presenceEvent) Method handlesUserPresenceChangedEventand synchronizes state of JIDs for MessageCarbons for particular user.voidprocess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) process(XMPPResourceConnection session, JID boundJID, Element action) voidsetMsgCarbonPaths(String[] matcherStrs) protected booleanshouldSendCarbons(Packet packet, XMPPResourceConnection session) protected voidMethod responsible for handingMessageCarbonsStateChangedEventand marking JIDs of user as MessageCarbons enabled/disabled.Element[]supDiscoFeatures(XMPPResourceConnection session) MethodsupDiscoFeaturesreturns an array of XMLElements with service discovery features which have to be returned to the client uppon request.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.Element[]Methods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, supStreamFeatures, supTypes, 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, supStreamFeatures, supTypes
-
Field Details
-
XMLNS
- See Also:
-
ID
- See Also:
-
-
Constructor Details
-
MessageCarbons
public MessageCarbons()
-
-
Method Details
-
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- Returns:
- a
Stringvalue
-
canHandle
- Specified by:
canHandlein interfaceSaslAuth2.Inline
-
getMsgCarbonPaths
-
setMsgCarbonPaths
-
process
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws XMPPException- Specified by:
processin interfaceXMPPProcessorIfc- Parameters:
packet- packet is which being processed. This parameter may never be null. Even though this is not immutable object it mustn't be altered. None of it's fields or attributes can be changed during processing.session- user session which keeps all the user session data and also gives an access to the user's repository data. It allows for storing information in a permanent storage or in memory only during the live of the online session. This parameter can be null if there is no online user session at the time of the packet processing.repo- this is a user data storage which is normally used when the user session (parameter above) is null. This is repository allows for a very restricted access only. It allows for storing some user private data (doesn't allow overwriting existing data) like messages for offline users and it also allows for reading user public data like VCard.results- this a collection with packets which have been generated as input packet processing results. Regardless a response to a user request is sent or the packet is forwarded to it's destination it is always required that a copy of the input packet is created and stored in the results queue.settings- this map keeps plugin specific settings loaded from the Tigase server configuration. In most cases it is unused, however if the plugin needs to access an external database that this is a way to pass database connection string to the plugin.- Throws:
XMPPException
-
process
public CompletableFuture<SaslAuth2.Inline.Result> process(XMPPResourceConnection session, JID boundJID, Element action) - Specified by:
processin interfaceSaslAuth2.Inline
-
supStreamFeatures
- Specified by:
supStreamFeaturesin interfaceSaslAuth2.Inline
-
prepareSkipForkingToList
protected Set<JID> prepareSkipForkingToList(Packet packet, XMPPResourceConnection session, Map<JID, Boolean> resources) throws NotAuthorizedException- Throws:
NotAuthorizedException
-
supDiscoFeatures
Description copied from interface:XMPPImplIfcMethodsupDiscoFeaturesreturns an array of XMLElements 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.- Specified by:
supDiscoFeaturesin interfaceXMPPImplIfc- Overrides:
supDiscoFeaturesin classXMPPProcessor- Parameters:
session- aXMPPResourceConnectionvalue- Returns:
- an
Element[]value
-
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 classXMPPProcessor- 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 classXMPPProcessor- Returns:
- a
String[]value
-
filter
public void filter(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results) - Specified by:
filterin interfaceXMPPPacketFilterIfc
-
stateChanged
Method responsible for handingMessageCarbonsStateChangedEventand marking JIDs of user as MessageCarbons enabled/disabled. -
presenceUpdate
@HandleEvent protected void presenceUpdate(UserPresenceChangedEvent presenceEvent) throws NotAuthorizedException Method handlesUserPresenceChangedEventand synchronizes state of JIDs for MessageCarbons for particular user.- Throws:
NotAuthorizedException
-
shouldSendCarbons
-