@Bean(name="jabber:iq:privacy", parent=SessionManager.class, active=true) public class JabberIqPrivacy extends XMPPProcessor implements XMPPProcessorIfc, XMPPPreprocessorIfc, XMPPPacketFilterIfc, RegistrarBean
Modifier and Type | Class and Description |
---|---|
protected static class |
JabberIqPrivacy.ITEM_ACTION |
protected static class |
JabberIqPrivacy.ITEM_SUBSCRIPTIONS |
protected static class |
JabberIqPrivacy.ITEM_TYPE |
static class |
JabberIqPrivacy.OfflineResourceConnection |
static class |
JabberIqPrivacy.PrivacyListOfflineCache |
Modifier and Type | Field and Description |
---|---|
protected static String |
ACTIVE_EL_NAME |
protected static Element |
BLOCKED_ELEM |
protected JabberIqPrivacy.PrivacyListOfflineCache |
cache |
protected static Comparator<Element> |
compar |
protected static String |
DEFAULT_EL_NAME |
protected static Element[] |
DISCO_FEATURES |
protected static String[][] |
ELEMENTS |
protected static String |
ERROR_EL_NAME |
protected static String |
ID |
protected static String |
LIST_EL_NAME |
protected static Logger |
log |
protected static String |
PRESENCE_EL_NAME |
protected static String |
PRESENCE_IN_EL_NAME |
protected static String |
PRESENCE_OUT_EL_NAME |
protected static RosterAbstract |
roster_util |
protected static String |
XMLNS |
protected static String[] |
XMLNSS |
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
JabberIqPrivacy() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
allowed(Packet packet,
JID connId,
BareJID userJid,
PrivacyList privacyList) |
protected boolean |
allowed(Packet packet,
XMPPResourceConnection session) |
protected boolean |
allowedByDefault(Packet packet,
JID connId,
BareJID userJid) |
void |
filter(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results) |
String |
id()
Method
id returns a unique ID of the plugin. |
protected Packet |
prepareError(Packet packet,
XMPPResourceConnection session) |
boolean |
preProcess(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
Performs pre-processing of
packet . |
void |
process(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings) |
protected void |
processGetRequest(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results) |
protected void |
processSetRequest(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results) |
void |
register(Kernel kernel)
Method called when bean is being registered allowing developer to programatically register other beans.
|
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. |
void |
unregister(Kernel kernel)
Method called while bean is being unregistered.
|
static Authorization |
validateList(XMPPResourceConnection session,
List<Element> items) |
canHandle, compareTo, concurrentThreadsPerQueue, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, isSupporting, supElements, supStreamFeatures, supTypes, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, concurrentThreadsPerQueue, getComponentInfo, getStatistics, init, isSupporting, supElements, supStreamFeatures, supTypes
compareTo
protected static final String ACTIVE_EL_NAME
protected static final Element BLOCKED_ELEM
protected static final String DEFAULT_EL_NAME
protected static final String[][] ELEMENTS
protected static final String LIST_EL_NAME
protected static final String ERROR_EL_NAME
protected static final String PRESENCE_EL_NAME
protected static final String PRESENCE_IN_EL_NAME
protected static final String PRESENCE_OUT_EL_NAME
protected static final String XMLNS
protected static final String ID
protected static final String[] XMLNSS
protected static final Element[] DISCO_FEATURES
protected static final Comparator<Element> compar
protected static Logger log
protected static RosterAbstract roster_util
@Inject(nullAllowed=true) protected JabberIqPrivacy.PrivacyListOfflineCache cache
public static Authorization validateList(XMPPResourceConnection session, List<Element> items)
public void register(Kernel kernel)
RegistrarBean
register
in interface RegistrarBean
kernel
- - instance from local scopepublic void unregister(Kernel kernel)
RegistrarBean
unregister
in interface RegistrarBean
kernel
- - instance from local scopepublic void filter(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results)
filter
in interface XMPPPacketFilterIfc
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 preProcess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
packet
. Intention for the pre-processors is to allow them for packet
blocking.
preProcess
method checks only incoming stanzas so it doesn't check for presence-out at all.preProcess
in interface XMPPPreprocessorIfc
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.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[]
valueprotected boolean allowed(Packet packet, JID connId, BareJID userJid, PrivacyList privacyList)
protected boolean allowed(Packet packet, XMPPResourceConnection session)
protected Packet prepareError(Packet packet, XMPPResourceConnection session)
protected void processGetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results) throws NotAuthorizedException, XMPPException, TigaseDBException
protected void processSetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results) throws NotAuthorizedException, XMPPException, TigaseDBException
Copyright © 2004–2019 "Tigase, Inc.". All rights reserved.