@Bean(name="jabber:iq:roster", parent=SessionManager.class, active=true) public class JabberIqRoster extends XMPPProcessor implements XMPPProcessorIfc
JabberIqRoster
implements part of RFC-3921 - XMPP Instant Messaging
specification describing roster management. 7. Roster Management
Modifier and Type | Field and Description |
---|---|
static String |
ANON |
protected static String |
ID |
protected RosterAbstract |
roster_util
instance of class implementing
RosterAbstract |
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
JabberIqRoster() |
Modifier and Type | Method and Description |
---|---|
int |
concurrentQueuesNo()
Methods returns a preferable number of threads/packets queues for the plugin.
|
protected static void |
dynamicGetRequest(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings)
Method processes roster
get request related to dynamic roster. |
protected static void |
dynamicSetRequest(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings)
Method processes roster
set request related to dynamic roster. |
static String[] |
getItemGroups(Element item)
Returns an array of group names retrieved from Element item
|
int |
getMaxRosterSize() |
protected RosterAbstract |
getRosterUtil()
Returns shared instance of class implementing
RosterAbstract - either default one (RosterFlat ) or
the one configured with "roster-implementation" property. |
String |
id()
Method
id returns a unique ID of the plugin. |
boolean |
isEmptyNameAllowed() |
void |
process(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
Performs processing of IQ packets with jabber:iq:roster xmlns with the regard whether it's roster set or get request or possibly dynamic-roster is involved. request. |
protected void |
processGetRequest(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings)
Method processes roster
get request. |
protected void |
processSetRequest(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings)
Method processes roster
set request. |
void |
setEmptyNameAllowed(boolean emptyNameAllowed) |
void |
setMaxRosterSize(int maxRosterSize) |
Element[] |
supDiscoFeatures(XMPPResourceConnection session)
Method
supDiscoFeatures returns an array of XML Element s with service discovery
features which have to be returned to the client uppon request. |
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. |
Element[] |
supStreamFeatures(XMPPResourceConnection session)
Method
supStreamFeatures returns an array of XML Element s with stream features which
have to be returned to the client uppon request. |
protected void |
updateHash(XMPPResourceConnection session,
Map<String,Object> settings)
Calculates hash value based on the user roster items and saves it to user's session data.
|
canHandle, compareTo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, supTypes, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, getComponentInfo, getStatistics, init, supTypes
compareTo
public static final String ANON
protected static final String ID
protected RosterAbstract roster_util
RosterAbstract
protected static void dynamicGetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings) throws NotAuthorizedException
get
request related to dynamic roster. Generates output packet with data
from the DynamicRoster implementation for every itemelement from processed packet or error otherwise.packet
- packet is which being processed.session
- user session which keeps all the user session data and also gives an access to the user's
repository data.results
- this a collection with packets which have been generated as input packet processing results.settings
- this map keeps plugin specific settings loaded from the Tigase server configuration.NotAuthorizedException
protected static void dynamicSetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings)
set
request related to dynamic roster. Sets extra data for every
itemelement from processed packet with the DynamicRoster implementation and generates success packet or,
in case of failure generates error.packet
- packet is which being processed.session
- user session which keeps all the user session data and also gives an access to the user's
repository data.results
- this a collection with packets which have been generated as input packet processing results.settings
- this map keeps plugin specific settings loaded from the Tigase server configuration.public static String[] getItemGroups(Element item)
item
- from which groups should be obtainedpublic int concurrentQueuesNo()
XMPPImplIfc
concurrentQueuesNo
in interface XMPPImplIfc
concurrentQueuesNo
in class XMPPProcessor
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
String
valuepublic boolean isEmptyNameAllowed()
public void setEmptyNameAllowed(boolean emptyNameAllowed)
public int getMaxRosterSize()
public void setMaxRosterSize(int maxRosterSize)
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws XMPPException
process
in interface XMPPProcessorIfc
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.XMPPException
public Element[] supDiscoFeatures(XMPPResourceConnection session)
XMPPImplIfc
supDiscoFeatures
returns an array of XML Element
s 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.supDiscoFeatures
in interface XMPPImplIfc
supDiscoFeatures
in class XMPPProcessor
session
- a XMPPResourceConnection
valueElement[]
valuepublic 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 XMPPProcessor
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 XMPPProcessor
String[]
valuepublic Element[] supStreamFeatures(XMPPResourceConnection session)
XMPPImplIfc
supStreamFeatures
returns an array of XML Element
s with stream features which
have to be returned to the client uppon request. Stream features returned by this method correspond to features
supported by this plugin.supStreamFeatures
in interface XMPPImplIfc
supStreamFeatures
in class XMPPProcessor
session
- a XMPPResourceConnection
valueElement[]
valueprotected void processGetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings) throws NotAuthorizedException, TigaseDBException, RosterRetrievingException, RepositoryAccessException
get
request. Generates output result packet containing user roster items
also considering roster version attribute to minimise traffic.packet
- packet is which being processed.session
- user session which keeps all the user session data and also gives an access to the user's
repository data.results
- this a collection with packets which have been generated as input packet processing results.settings
- this map keeps plugin specific settings loaded from the Tigase server configuration.NotAuthorizedException
TigaseDBException
RosterRetrievingException
RepositoryAccessException
protected void processSetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings) throws XMPPException, NotAuthorizedException, TigaseDBException, PolicyViolationException
set
request. Performs modifications of user roster.packet
- packet is which being processed.session
- user session which keeps all the user session data and also gives an access to the user's
repository data.results
- this a collection with packets which have been generated as input packet processing results.settings
- this map keeps plugin specific settings loaded from the Tigase server configuration.XMPPException
NotAuthorizedException
TigaseDBException
PolicyViolationException
protected void updateHash(XMPPResourceConnection session, Map<String,Object> settings) throws NotAuthorizedException, TigaseDBException, RosterRetrievingException, RepositoryAccessException
session
- user session which keeps all the user session data and also gives an access to the user's
repository data.settings
- this map keeps plugin specific settings loaded from the Tigase server configuration.NotAuthorizedException
TigaseDBException
RosterRetrievingException
RepositoryAccessException
protected RosterAbstract getRosterUtil()
RosterAbstract
- either default one (RosterFlat
) or
the one configured with "roster-implementation" property.RosterAbstract
Copyright © 2004–2021 "Tigase, Inc.". All rights reserved.