Package tigase.xmpp.impl
Class JabberIqPrivacy
java.lang.Object
tigase.xmpp.XMPPProcessor
tigase.xmpp.impl.JabberIqPrivacy
- All Implemented Interfaces:
Comparable<XMPPImplIfc>,Initializable,RegistrarBean,UnregisterAware,XMPPImplIfc,XMPPPacketFilterIfc,XMPPPreprocessorIfc,XMPPProcessorConcurrencyAwareIfc,XMPPProcessorIfc
@Bean(name="jabber:iq:privacy",
parent=SessionManager.class,
active=true)
public class JabberIqPrivacy
extends XMPPProcessor
implements XMPPProcessorIfc, XMPPPreprocessorIfc, XMPPPacketFilterIfc, RegistrarBean, Initializable, UnregisterAware
Describe class JabberIqPrivacy here.
Created: Mon Oct 9 18:18:11 2006
Created: Mon Oct 9 18:18:11 2006
- Author:
- Artur Hefczyc
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static enumprotected static enumprotected static enumstatic classstatic classstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final Stringprotected static final Elementprotected JabberIqPrivacy.PrivacyListOfflineCacheprotected static final Comparator<Element> protected static final Stringprotected static final Element[]protected static final String[][]protected static final Stringprotected static final Stringprotected static final Stringprotected static Loggerprotected static final Stringprotected static final Stringprotected static final Stringprotected static RosterAbstractprotected static final Stringprotected static final String[]Fields 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 TypeMethodDescriptionprotected booleanallowed(Packet packet, JID connId, BareJID userJid, PrivacyList privacyList) protected booleanallowed(Packet packet, XMPPResourceConnection session) protected booleanallowedByDefault(Packet packet, JID connId, BareJID userJid) voidMethod called before bean unregister.voidfilter(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results) id()Methodidreturns a unique ID of the plugin.voidMethod will be called, when bean will be created, configured and ready to use.protected PacketprepareError(Packet packet, XMPPResourceConnection session) booleanpreProcess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) Performs pre-processing ofpacket.voidvoidprocess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) protected voidprocessGetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results) protected voidprocessSetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results) voidMethod called when bean is being registered allowing developer to programatically register other beans.Element[]supDiscoFeatures(XMPPResourceConnection session) MethodsupDiscoFeaturesreturns an array of XMLElements with service discovery features which have to be returned to the client uppon request.String[][]MethodsupElementNamePathsreturns 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[]MethodsupNamespacesreturns an array of name-spaces for stanzas which can be processed by this plugin.voidunregister(Kernel kernel) Method called while bean is being unregistered.static AuthorizationvalidateList(XMPPResourceConnection session, List<Element> items) Methods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, supStreamFeatures, supTypes, 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, supStreamFeatures, supTypes
-
Field Details
-
ACTIVE_EL_NAME
- See Also:
-
BLOCKED_ELEM
-
DEFAULT_EL_NAME
- See Also:
-
ELEMENTS
-
LIST_EL_NAME
- See Also:
-
ERROR_EL_NAME
- See Also:
-
PRESENCE_EL_NAME
- See Also:
-
PRESENCE_IN_EL_NAME
- See Also:
-
PRESENCE_OUT_EL_NAME
- See Also:
-
XMLNS
- See Also:
-
ID
- See Also:
-
XMLNSS
-
DISCO_FEATURES
-
compar
-
log
-
roster_util
-
cache
-
-
Constructor Details
-
JabberIqPrivacy
public JabberIqPrivacy()
-
-
Method Details
-
validateList
-
register
Description copied from interface:RegistrarBeanMethod called when bean is being registered allowing developer to programatically register other beans.- Specified by:
registerin interfaceRegistrarBean- Parameters:
kernel- - instance from local scope
-
unregister
Description copied from interface:RegistrarBeanMethod called while bean is being unregistered.- Specified by:
unregisterin interfaceRegistrarBean- Parameters:
kernel- - instance from local scope
-
filter
public void filter(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results) - Specified by:
filterin interfaceXMPPPacketFilterIfc
-
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- Returns:
- a
Stringvalue
-
preProcess
public boolean preProcess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) Performs pre-processing ofpacket. Intention for the pre-processors is to allow them for packet blocking.
preProcessmethod checks only incoming stanzas so it doesn't check for presence-out at all.- Specified by:
preProcessin interfaceXMPPPreprocessorIfc- Parameters:
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.- Returns:
- the pre-processing result; if the value is ‘true’ then the packet is blocked and no further processing is performed.
-
process
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws XMPPException- Specified by:
processin interfaceXMPPProcessorIfc- Parameters:
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.- Throws:
XMPPException
-
supDiscoFeatures
Description copied from interface:XMPPImplIfcMethodsupDiscoFeaturesreturns an array of XMLElements 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.- Specified by:
supDiscoFeaturesin interfaceXMPPImplIfc- Overrides:
supDiscoFeaturesin classXMPPProcessor- Parameters:
session- aXMPPResourceConnectionvalue- Returns:
- an
Element[]value
-
supElementNamePaths
Description copied from interface:XMPPImplIfcMethodsupElementNamePathsreturns 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 bysupNamespaces()method. The element path itself is represented by a String array with each path element as a separate String.- Specified by:
supElementNamePathsin interfaceXMPPImplIfc- Overrides:
supElementNamePathsin classXMPPProcessor- Returns:
- a
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.
-
supNamespaces
Description copied from interface:XMPPImplIfcMethodsupNamespacesreturns an array of name-spaces for stanzas which can be processed by this plugin. Each namespace corresponds to element name returned in array bysupElemenets()method.- Specified by:
supNamespacesin interfaceXMPPImplIfc- Overrides:
supNamespacesin classXMPPProcessor- Returns:
- a
String[]value
-
initialize
public void initialize()Description copied from interface:InitializableMethod will be called, when bean will be created, configured and ready to use.- Specified by:
initializein interfaceInitializable
-
beforeUnregister
public void beforeUnregister()Description copied from interface:UnregisterAwareMethod called before bean unregister.- Specified by:
beforeUnregisterin interfaceUnregisterAware
-
privacyListUpdated
-
allowed
-
allowed
-
allowedByDefault
-
prepareError
-
processGetRequest
protected void processGetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results) throws NotAuthorizedException, XMPPException, TigaseDBException -
processSetRequest
protected void processSetRequest(Packet packet, XMPPResourceConnection session, Queue<Packet> results) throws NotAuthorizedException, XMPPException, TigaseDBException
-