@Bean(name="domain-filter", parent=SessionManager.class, active=true) public class DomainFilter extends XMPPProcessor implements XMPPPacketFilterIfc, XMPPPreprocessorIfc
Modifier and Type | Field and Description |
---|---|
static String |
ALLOWED_DOMAINS_KEY
constant domain key name
|
static String |
ALLOWED_DOMAINS_LIST_KEY
constant domain list key name
|
protected static String |
ID
id of the plugin
|
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
DomainFilter() |
Modifier and Type | Method and Description |
---|---|
void |
filter(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results) |
DomainFilterPolicy |
getDomains(XMPPResourceConnection session)
Method retrieves filtering policy based on user session, from most specific to most general, i.e.: first user
session is checked, if that fails then user repository and if there is no rules configured then domain filtering
policy from VHost is being returned (if present).
|
String[] |
getDomainsList(XMPPResourceConnection session)
Method retrieves list of domains to be applied to
LIST and BLACKLIST filtering policies based on
user session, from most specific to most general, i.e.: first user session is checked, if that fails then user
repository and if there is no rules configured then list of domains from VHost is being returned (if present). |
String |
id()
Method
id returns a unique ID of the plugin. |
boolean |
preProcess(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
Performs pre-processing of
packet . |
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. |
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, supDiscoFeatures, supStreamFeatures, supTypes, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, init, supDiscoFeatures, supStreamFeatures, supTypes
compareTo
public static final String ALLOWED_DOMAINS_KEY
public static final String ALLOWED_DOMAINS_LIST_KEY
protected static final String ID
public 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)
XMPPPreprocessorIfc
packet
. Intention for the pre-processors is to allow them for packet
blocking.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 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 DomainFilterPolicy getDomains(XMPPResourceConnection session) throws NotAuthorizedException, TigaseDBException
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.NotAuthorizedException
TigaseDBException
public String[] getDomainsList(XMPPResourceConnection session) throws NotAuthorizedException, TigaseDBException
LIST
and BLACKLIST
filtering policies based on
user session, from most specific to most general, i.e.: first user session is checked, if that fails then user
repository and if there is no rules configured then list of domains from VHost is being returned (if present).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.NotAuthorizedException
TigaseDBException
Copyright © 2004–2020 "Tigase, Inc.". All rights reserved.