Package tigase.xmpp.impl
Class EntityTime
java.lang.Object
tigase.xmpp.XMPPProcessor
tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
tigase.xmpp.XMPPProcessorAbstract
tigase.xmpp.impl.EntityTime
- All Implemented Interfaces:
Comparable<XMPPImplIfc>,XMPPImplIfc,XMPPProcessorConcurrencyAwareIfc,XMPPProcessorIfc
@Bean(name="urn:xmpp:time",
parent=SessionManager.class,
active=true)
public class EntityTime
extends XMPPProcessorAbstract
This supports the implementation of XEP-0202: Entity Time.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final Stringprotected static final Stringprotected static final StringFields 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.voidprocessFromUserOutPacket(JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) The method is called when a packet is sent from the user, owner of the session somewhere else to other XMPP entity (other user on the server, other user on a different server, different server, component, transport, etc....).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...).voidprocessNullSessionPacket(Packet packet, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) The method is called for packets received by the server for which no user session is found - neither sender session or receiver session.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.Methods inherited from class tigase.xmpp.XMPPProcessorAbstract
isFromUserSession, isNullSession, isServerSession, isToUserSession, process, processFromUserPacketMethods inherited from class tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
supDiscoFeatures, supElementNamePaths, supNamespaces, 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, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
-
Field Details
-
XMLNS
- See Also:
-
TIME
- See Also:
-
ID
- See Also:
-
-
Constructor Details
-
EntityTime
public EntityTime()
-
-
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- Overrides:
idin classAnnotatedXMPPProcessor- Returns:
- a
Stringvalue
-
processFromUserOutPacket
public void processFromUserOutPacket(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 sent from the user, owner of the session somewhere else to other XMPP entity (other user on the server, other user on a different server, different server, component, transport, etc....). The default implementation just forwards the packet doing nothing else, which is good enough in most cases. You can overwrite the method to change the default behaviour.- Overrides:
processFromUserOutPacketin 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.
-
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.
-
processNullSessionPacket
public void processNullSessionPacket(Packet packet, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws PacketErrorTypeExceptionDescription copied from class:XMPPProcessorAbstractThe method is called for packets received by the server for which no user session is found - neither sender session or receiver session. The default implementation does nothing, just ignores such a packet. To change the default behaviour the method has to be overwritten.- Overrides:
processNullSessionPacketin classXMPPProcessorAbstract- Parameters:
packet- is aPacketreceived by the server.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.
-