rocks.xmpp.core.stanza

Interface IQHandler

All Known Implementing Classes:

AbstractIQHandler

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IQHandler

Handles an inbound IQ request, (IQ stanzas of type IQ.Type.GET or IQ.Type.SET) by processing the request and returning an IQ response of type result or error.

In contrast to XmppSession.addInboundIQListener(Consumer) which merely listens to IQ stanzas, IQ handlers facilitate the proper handling of IQ requests by enforcing the semantics of IQs, especially:

8.2.3. IQ Semantics

An entity that receives an IQ request of type "get" or "set" MUST reply with an IQ response of type "result" or "error". The response MUST preserve the 'id' attribute of the request (or be empty if the generated stanza did not include an 'id' attribute).

IQ handlers are registered for a specific payload type via XmppSession.addIQHandler(Class, IQHandler).

See Also:

8.2.3. IQ Semantics, XmppSession.addIQHandler(Class, IQHandler)

Method Summary

Modifier and Type	Method and Description
IQ	handleRequest(IQ iq) Handles an inbound IQ stanza of type get or set.

Method Detail

handleRequest

IQ handleRequest(IQ iq)

Handles an inbound IQ stanza of type get or set.

The returned IQ must be of type result or error. If null is returned, no response is returned to the requester and you must take responsibility of sending a response manually. However, this approach is not recommended.

Use IQ.createResult() or IQ.createError(rocks.xmpp.core.stanza.model.StanzaError) to generate the response IQ (i.e. an IQ with the same id).

Parameters:

iq - The inbound IQ stanza.

Returns:

The result or error IQ, which is the response to sending entity.