Package org.jivesoftware.openfire.handler

Class IQPrivacyHandler

java.lang.Object

org.jivesoftware.openfire.container.BasicModule

org.jivesoftware.openfire.handler.IQHandler

org.jivesoftware.openfire.handler.IQPrivacyHandler

All Implemented Interfaces:

ChannelHandler, Module, ServerFeaturesProvider, UserEventListener

public class IQPrivacyHandler
extends IQHandler
implements ServerFeaturesProvider, UserEventListener

IQPrivacyHandler is responsible for handling privacy lists.

Author:

Gaston Dombiak

Field Summary

Fields inherited from class org.jivesoftware.openfire.handler.IQHandler

deliverer, sessionManager

Constructor Summary

Constructors

Constructor	Description
IQPrivacyHandler()

Method Summary

Modifier and Type	Method	Description
Iterator<String>	getFeatures()	Returns an Iterator (of String) with the supported features by the server.
IQHandlerInfo	getInfo()	Returns the handler information to help generically handle IQ packets.
org.xmpp.packet.IQ	handleIQ(org.xmpp.packet.IQ packet)	Handles the received IQ packet.
void	initialize(XMPPServer server)	Initializes the basic module.
void	userCreated(User user, Map params)	A user was created.
void	userDeleting(User user, Map params)	A user is being deleted.
void	userModified(User user, Map params)	A user's name, email, or an extended property was changed.

Methods inherited from class org.jivesoftware.openfire.handler.IQHandler

process

Methods inherited from class org.jivesoftware.openfire.container.BasicModule

destroy, getName, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IQPrivacyHandler

public IQPrivacyHandler()

Method Detail

handleIQ

public org.xmpp.packet.IQ handleIQ(org.xmpp.packet.IQ packet)
                            throws UnauthorizedException

Description copied from class: IQHandler

Handles the received IQ packet.

Specified by:

handleIQ in class IQHandler

Parameters:

packet - the IQ packet to handle.

Returns:

the response to send back.

Throws:

UnauthorizedException - if the user that sent the packet is not authorized to request the given operation.

getInfo

public IQHandlerInfo getInfo()

Description copied from class: IQHandler

Returns the handler information to help generically handle IQ packets. IQHandlers that aren't local server iq handlers (e.g. chatbots, transports, etc) return null.

Specified by:

getInfo in class IQHandler

Returns:

The IQHandlerInfo for this handler

getFeatures

public Iterator<String> getFeatures()

Description copied from interface: ServerFeaturesProvider

Returns an Iterator (of String) with the supported features by the server. The features to include are the features offered and supported protocols by the SERVER. The idea is that different modules may provide their features that will ultimately be part of the features offered by the server.

Specified by:

getFeatures in interface ServerFeaturesProvider

Returns:

an Iterator (of String) with the supported features by the server.

userCreated

public void userCreated(User user,
                        Map params)

Description copied from interface: UserEventListener

A user was created.

Specified by:

userCreated in interface UserEventListener

Parameters:

user - the user.

params - event parameters.

userDeleting

public void userDeleting(User user,
                         Map params)

Description copied from interface: UserEventListener

A user is being deleted.

Specified by:

userDeleting in interface UserEventListener

Parameters:

user - the user.

params - event parameters.

userModified

public void userModified(User user,
                         Map params)

Description copied from interface: UserEventListener

A user's name, email, or an extended property was changed.

Specified by:

userModified in interface UserEventListener

Parameters:

user - the user.

params - event parameters.

initialize

public void initialize(XMPPServer server)

Description copied from class: BasicModule

Initializes the basic module.

Inheriting classes that choose to override this method MUST call this initialize() method before accessing BasicModule resources.

Specified by:

initialize in interface Module

Overrides:

initialize in class IQHandler

Parameters:

server - the server hosting this module.