Package tigase.xmpp.impl
Class JabberIqPrivacy
- java.lang.Object
-
- tigase.xmpp.XMPPProcessor
-
- tigase.xmpp.impl.JabberIqPrivacy
-
- All Implemented Interfaces:
java.lang.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- Author:
- Artur Hefczyc
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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
static class
JabberIqPrivacy.PrivacyListUpdatedEvent
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
ACTIVE_EL_NAME
protected static Element
BLOCKED_ELEM
protected JabberIqPrivacy.PrivacyListOfflineCache
cache
protected static java.util.Comparator<Element>
compar
protected static java.lang.String
DEFAULT_EL_NAME
protected static Element[]
DISCO_FEATURES
protected static java.lang.String[][]
ELEMENTS
protected static java.lang.String
ERROR_EL_NAME
protected static java.lang.String
ID
protected static java.lang.String
LIST_EL_NAME
protected static java.util.logging.Logger
log
protected static java.lang.String
PRESENCE_EL_NAME
protected static java.lang.String
PRESENCE_IN_EL_NAME
protected static java.lang.String
PRESENCE_OUT_EL_NAME
protected static RosterAbstract
roster_util
protected static java.lang.String
XMLNS
protected static java.lang.String[]
XMLNSS
-
Fields inherited from class tigase.xmpp.XMPPProcessor
ALL_NAMES, ALL_PATHS, cmpInfo
-
Fields inherited from interface tigase.xmpp.XMPPImplIfc
CLIENT_XMLNS
-
-
Constructor Summary
Constructors Constructor Description JabberIqPrivacy()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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
beforeUnregister()
Method called before bean unregister.void
filter(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, java.util.Queue<Packet> results)
java.lang.String
id()
Methodid
returns a unique ID of the plugin.void
initialize()
Method will be called, when bean will be created, configured and ready to use.protected Packet
prepareError(Packet packet, XMPPResourceConnection session)
boolean
preProcess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> settings)
Performs pre-processing ofpacket
.void
privacyListUpdated(JabberIqPrivacy.PrivacyListUpdatedEvent event)
void
process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> settings)
protected void
processGetRequest(Packet packet, XMPPResourceConnection session, java.util.Queue<Packet> results)
protected void
processSetRequest(Packet packet, XMPPResourceConnection session, java.util.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)
MethodsupDiscoFeatures
returns an array of XMLElement
s with service discovery features which have to be returned to the client uppon request.java.lang.String[][]
supElementNamePaths()
MethodsupElementNamePaths
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.java.lang.String[]
supNamespaces()
MethodsupNamespaces
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, java.util.List<Element> items)
-
Methods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, supStreamFeatures, supTypes, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface tigase.xmpp.XMPPImplIfc
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, init, supStreamFeatures, supTypes
-
-
-
-
Field Detail
-
ACTIVE_EL_NAME
protected static final java.lang.String ACTIVE_EL_NAME
- See Also:
- Constant Field Values
-
BLOCKED_ELEM
protected static final Element BLOCKED_ELEM
-
DEFAULT_EL_NAME
protected static final java.lang.String DEFAULT_EL_NAME
- See Also:
- Constant Field Values
-
ELEMENTS
protected static final java.lang.String[][] ELEMENTS
-
LIST_EL_NAME
protected static final java.lang.String LIST_EL_NAME
- See Also:
- Constant Field Values
-
ERROR_EL_NAME
protected static final java.lang.String ERROR_EL_NAME
- See Also:
- Constant Field Values
-
PRESENCE_EL_NAME
protected static final java.lang.String PRESENCE_EL_NAME
- See Also:
- Constant Field Values
-
PRESENCE_IN_EL_NAME
protected static final java.lang.String PRESENCE_IN_EL_NAME
- See Also:
- Constant Field Values
-
PRESENCE_OUT_EL_NAME
protected static final java.lang.String PRESENCE_OUT_EL_NAME
- See Also:
- Constant Field Values
-
XMLNS
protected static final java.lang.String XMLNS
- See Also:
- Constant Field Values
-
ID
protected static final java.lang.String ID
- See Also:
- Constant Field Values
-
XMLNSS
protected static final java.lang.String[] XMLNSS
-
DISCO_FEATURES
protected static final Element[] DISCO_FEATURES
-
compar
protected static final java.util.Comparator<Element> compar
-
log
protected static java.util.logging.Logger log
-
roster_util
protected static RosterAbstract roster_util
-
cache
@Inject(nullAllowed=true) protected JabberIqPrivacy.PrivacyListOfflineCache cache
-
-
Method Detail
-
validateList
public static Authorization validateList(XMPPResourceConnection session, java.util.List<Element> items)
-
register
public void register(Kernel kernel)
Description copied from interface:RegistrarBean
Method called when bean is being registered allowing developer to programatically register other beans.- Specified by:
register
in interfaceRegistrarBean
- Parameters:
kernel
- - instance from local scope
-
unregister
public void unregister(Kernel kernel)
Description copied from interface:RegistrarBean
Method called while bean is being unregistered.- Specified by:
unregister
in interfaceRegistrarBean
- Parameters:
kernel
- - instance from local scope
-
filter
public void filter(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, java.util.Queue<Packet> results)
- Specified by:
filter
in interfaceXMPPPacketFilterIfc
-
id
public java.lang.String id()
Description copied from interface:XMPPImplIfc
Methodid
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.- Specified by:
id
in interfaceXMPPImplIfc
- Returns:
- a
String
value
-
preProcess
public boolean preProcess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> settings)
Performs pre-processing ofpacket
. 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.- Specified by:
preProcess
in 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, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> settings) throws XMPPException
- Specified by:
process
in 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
public Element[] supDiscoFeatures(XMPPResourceConnection session)
Description copied from interface:XMPPImplIfc
MethodsupDiscoFeatures
returns an array of XMLElement
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.- Specified by:
supDiscoFeatures
in interfaceXMPPImplIfc
- Overrides:
supDiscoFeatures
in classXMPPProcessor
- Parameters:
session
- aXMPPResourceConnection
value- Returns:
- an
Element[]
value
-
supElementNamePaths
public java.lang.String[][] supElementNamePaths()
Description copied from interface:XMPPImplIfc
MethodsupElementNamePaths
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 bysupNamespaces()
method. The element path itself is represented by a String array with each path element as a separate String.- Specified by:
supElementNamePaths
in interfaceXMPPImplIfc
- Overrides:
supElementNamePaths
in 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
public java.lang.String[] supNamespaces()
Description copied from interface:XMPPImplIfc
MethodsupNamespaces
returns 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:
supNamespaces
in interfaceXMPPImplIfc
- Overrides:
supNamespaces
in classXMPPProcessor
- Returns:
- a
String[]
value
-
initialize
public void initialize()
Description copied from interface:Initializable
Method will be called, when bean will be created, configured and ready to use.- Specified by:
initialize
in interfaceInitializable
-
beforeUnregister
public void beforeUnregister()
Description copied from interface:UnregisterAware
Method called before bean unregister.- Specified by:
beforeUnregister
in interfaceUnregisterAware
-
privacyListUpdated
@HandleEvent public void privacyListUpdated(JabberIqPrivacy.PrivacyListUpdatedEvent event)
-
allowed
protected boolean allowed(Packet packet, JID connId, BareJID userJid, PrivacyList privacyList)
-
allowed
protected boolean allowed(Packet packet, XMPPResourceConnection session)
-
prepareError
protected Packet prepareError(Packet packet, XMPPResourceConnection session)
-
processGetRequest
protected void processGetRequest(Packet packet, XMPPResourceConnection session, java.util.Queue<Packet> results) throws NotAuthorizedException, XMPPException, TigaseDBException
-
processSetRequest
protected void processSetRequest(Packet packet, XMPPResourceConnection session, java.util.Queue<Packet> results) throws NotAuthorizedException, XMPPException, TigaseDBException
-
-