org.jivesoftware.openfire.disco
Interface UserItemsProvider

All Known Implementing Classes:

IQDiscoItemsHandler, IQPEPHandler

public interface UserItemsProvider

A UserItemsProvider is responsible for providing the items associated with a user that are to be discovered during a disco#items query sent to the user.

Examples of when a UserItemsProvider is used include:

• For discovering PEP items of a user.
• For discovering available resources of a user.

Author:

Armando Jagucki

Method Summary

Iterator<org.dom4j.Element>

getUserItems(String name, org.xmpp.packet.JID senderJID) Returns an Iterator (of Element) with the target entity's items or null if none.

Method Detail

getUserItems

Iterator<org.dom4j.Element> getUserItems(String name,
                                         org.xmpp.packet.JID senderJID)

Returns an Iterator (of Element) with the target entity's items or null if none. Each Element must include a JID attribute and may include the name and node attributes of the entity. In case that the sender of the disco request is not authorized to discover items an UnauthorizedException will be thrown.

Parameters:

name - the recipient JID's name.

senderJID - the XMPPAddress of user that sent the disco items request.

Returns:

an Iterator (of Element) with the target entity's items or null if none.