|
Openfire 3.5.0.rc1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.openfire.container.BasicModule org.jivesoftware.openfire.handler.IQHandler org.jivesoftware.openfire.pep.IQPEPHandler
public class IQPEPHandler
An IQHandler
used to implement XEP-0163: "Personal Eventing via Pubsub"
Version 1.0
For each user on the server there is an associated PEPService
interacting
with a single PubSubEngine
for managing the user's PEP nodes.
An IQHandler can only handle one namespace in its IQHandlerInfo. However, PEP
related packets are seen having a variety of different namespaces. Thus,
classes like IQPEPOwnerHandler
are used to forward packets having these other
namespaces to handleIQ(IQ)
.
This handler is used for the following namespaces:
Field Summary |
---|
Fields inherited from class org.jivesoftware.openfire.handler.IQHandler |
---|
deliverer, sessionManager |
Constructor Summary | |
---|---|
IQPEPHandler()
|
Method Summary | |
---|---|
boolean |
addingContact(Roster roster,
RosterItem item,
boolean persistent)
Notification message indicating that a contact is about to be added to a roster. |
void |
availableSession(ClientSession session,
Presence presence)
Notification message indicating that a session that was not available is now available. |
void |
contactAdded(Roster roster,
RosterItem item)
Notification message indicating that a contact has been added to a roster. |
void |
contactDeleted(Roster roster,
RosterItem item)
Notification message indicating that a contact has been deleted from a roster. |
void |
contactUpdated(Roster roster,
RosterItem item)
Notification message indicating that a contact has been updated. |
void |
destroy()
Destroys the module. |
Iterator<String> |
getFeatures()
Implements ServerFeaturesProvider to include all supported XEP-0060 features in the server's disco#info result (as per section 4 of XEP-0163). |
Iterator<org.dom4j.Element> |
getIdentities()
Implements ServerIdentitiesProvider and UserIdentitiesProvider, adding the PEP identity to the respective disco#info results. |
IQHandlerInfo |
getInfo()
Returns the handler information to help generically handle IQ packets. |
Map<String,Set<JID>> |
getKnownRemotePresenes()
Returns the knownRemotePresences map. |
Iterator<org.dom4j.Element> |
getUserItems(String name,
JID senderJID)
Implements UserItemsProvider, adding PEP related items to a disco#items result. |
IQ |
handleIQ(IQ packet)
Handles the received IQ packet. |
void |
initialize(XMPPServer server)
Initializes the basic module. |
void |
presenceChanged(ClientSession session,
Presence presence)
Notification message indicating that an available session has changed its presence. |
void |
presencePriorityChanged(ClientSession session,
Presence presence)
Notification message indicating that the presence priority of a session has been modified. |
void |
remoteUserAvailable(Presence presence)
Notification message indicating that a remote user is now available or has changed his available presence. |
void |
remoteUserUnavailable(Presence presence)
Notification message indicating that a remote user is no longer available. |
void |
rosterLoaded(Roster roster)
Notification message indicating that a roster has just been loaded. |
void |
stop()
Stops the basic module. |
void |
subscribedToPresence(JID subscriberJID,
JID authorizerJID)
Notification message indicating that a user has successfully subscribed to the presence of another user. |
void |
unavailableSession(ClientSession session,
Presence presence)
The following functions are unimplemented required interface methods. |
void |
unsubscribedToPresence(JID unsubscriberJID,
JID recipientJID)
Notification message indicating that a user has unsubscribed to the presence of another user. |
void |
userCreated(User user,
Map<String,Object> params)
A user was created. |
void |
userDeleting(User user,
Map<String,Object> params)
A user is being deleted. |
void |
userModified(User user,
Map<String,Object> 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 |
---|
getName, start |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IQPEPHandler()
Method Detail |
---|
public void initialize(XMPPServer server)
BasicModule
Initializes the basic module.
Inheriting classes that choose to override this method MUST call this initialize() method before accessing BasicModule resources.
initialize
in interface Module
initialize
in class IQHandler
server
- the server hosting this module.public void stop()
BasicModule
Stops the basic module.
Inheriting classes that choose to override this method MUST call this stop() method before accessing BasicModule resources.
stop
in interface Module
stop
in class BasicModule
public void destroy()
BasicModule
Destroys the module.
Does nothing in the basic module.
destroy
in interface Module
destroy
in class BasicModule
public IQHandlerInfo getInfo()
IQHandler
getInfo
in class IQHandler
public Map<String,Set<JID>> getKnownRemotePresenes()
public IQ handleIQ(IQ packet) throws UnauthorizedException
IQHandler
handleIQ
in class IQHandler
packet
- the IQ packet to handle.
UnauthorizedException
- if the user that sent the packet is not
authorized to request the given operation.public Iterator<org.dom4j.Element> getIdentities()
getIdentities
in interface ServerIdentitiesProvider
getIdentities
in interface UserIdentitiesProvider
public Iterator<String> getFeatures()
getFeatures
in interface ServerFeaturesProvider
public Iterator<org.dom4j.Element> getUserItems(String name, JID senderJID)
getUserItems
in interface UserItemsProvider
name
- the recipient JID's name.senderJID
- the XMPPAddress of user that sent the disco items request.
public void subscribedToPresence(JID subscriberJID, JID authorizerJID)
PresenceEventListener
subscribedToPresence
in interface PresenceEventListener
subscriberJID
- the user that initiated the subscription.authorizerJID
- the user that authorized the subscription.public void unsubscribedToPresence(JID unsubscriberJID, JID recipientJID)
PresenceEventListener
unsubscribedToPresence
in interface PresenceEventListener
unsubscriberJID
- the user that initiated the unsubscribe request.recipientJID
- the recipient user of the unsubscribe request.public void availableSession(ClientSession session, Presence presence)
PresenceEventListener
availableSession
in interface PresenceEventListener
session
- the session that is now available.presence
- the received available presence.public void remoteUserAvailable(Presence presence)
RemotePresenceEventListener
remoteUserAvailable
in interface RemotePresenceEventListener
presence
- the received available presence.public void remoteUserUnavailable(Presence presence)
RemotePresenceEventListener
remoteUserUnavailable
in interface RemotePresenceEventListener
presence
- the received unavailable presence.public void contactDeleted(Roster roster, RosterItem item)
RosterEventListener
contactDeleted
in interface RosterEventListener
roster
- the roster that was updated.item
- the roster item that was deleted.public void userDeleting(User user, Map<String,Object> params)
UserEventListener
userDeleting
in interface UserEventListener
user
- the user.params
- event parameters.public void unavailableSession(ClientSession session, Presence presence)
unavailableSession
in interface PresenceEventListener
session
- the session that is no longer available.presence
- the received unavailable presence.public void presenceChanged(ClientSession session, Presence presence)
PresenceEventListener
presenceChanged
in interface PresenceEventListener
session
- the affected session.presence
- the received available presence with the new information.public void presencePriorityChanged(ClientSession session, Presence presence)
PresenceEventListener
presencePriorityChanged
in interface PresenceEventListener
session
- the affected session.presence
- the presence that changed the priority.public boolean addingContact(Roster roster, RosterItem item, boolean persistent)
RosterEventListener
addingContact
in interface RosterEventListener
roster
- the roster that was updated.item
- the new roster item.persistent
- true if the new contact is going to be saved to the database.
public void contactAdded(Roster roster, RosterItem item)
RosterEventListener
contactAdded
in interface RosterEventListener
roster
- the roster that was updated.item
- the new roster item.public void contactUpdated(Roster roster, RosterItem item)
RosterEventListener
contactUpdated
in interface RosterEventListener
roster
- the roster that was updated.item
- the updated roster item.public void rosterLoaded(Roster roster)
RosterEventListener
rosterLoaded
in interface RosterEventListener
roster
- the loaded roster.public void userCreated(User user, Map<String,Object> params)
UserEventListener
userCreated
in interface UserEventListener
user
- the user.params
- event parameters.public void userModified(User user, Map<String,Object> params)
UserEventListener
userModified
in interface UserEventListener
user
- the user.params
- event parameters.
|
Openfire 3.5.0.rc1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |