public class EntityTime extends XMPPProcessorAbstract
Modifier and Type | Field and Description |
---|---|
protected static String |
TIME |
protected static String |
XMLNS |
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
EntityTime() |
Modifier and Type | Method and Description |
---|---|
String |
id()
Method
id returns a unique ID of the plugin. |
void |
processFromUserOutPacket(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....).
|
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 |
processNullSessionPacket(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.
|
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.
|
process, processFromUserPacket
supDiscoFeatures, supElementNamePaths, supNamespaces, 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, supElementNamePaths, supElements, supNamespaces, supStreamFeatures, supTypes
compareTo
protected static final String XMLNS
protected static final String TIME
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 processFromUserOutPacket(JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
XMPPProcessorAbstract
processFromUserOutPacket
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 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 processNullSessionPacket(Packet packet, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
XMPPProcessorAbstract
processNullSessionPacket
in class XMPPProcessorAbstract
packet
- is a Packet
received by the server.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.Copyright © 2019 "Tigase, Inc.". All rights reserved.