org.jamppa.component.utils

Class RSMUtils

java.lang.Object

org.jamppa.component.utils.RSMUtils

public class RSMUtils
extends Object

It is responsible for providing utility methods related to RSM format (http://xmpp.org/extensions/xep-0059.html), which are used on the query processing and response.

See Also:

RSM

Constructor Summary

Constructors

Constructor and Description
RSMUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	appendRSMElement(org.dom4j.Element queryElement, RSM rsm) Appends RSM info to query response.
static List<Identifiable>	filterRSMResponse(List<Identifiable> objects, RSM rsm) Filters response objects based on the RSM parameters.
static RSM	parseRSM(org.dom4j.Element queryElement) Parses an RSM from a query XML element

Methods inherited from class java.lang.Object

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

Constructor Detail

RSMUtils

public RSMUtils()

Method Detail

appendRSMElement

public static void appendRSMElement(org.dom4j.Element queryElement,
                    RSM rsm)

Appends RSM info to query response.

Parameters:

queryElement -

rsm -

parseRSM

public static RSM parseRSM(org.dom4j.Element queryElement)

Parses an RSM from a query XML element

Parameters:

queryElement -

Returns:

The parsed RSM object

filterRSMResponse

public static List<Identifiable> filterRSMResponse(List<Identifiable> objects,
                                   RSM rsm)
                                            throws IllegalArgumentException

Filters response objects based on the RSM parameters. Updates the RSM object with item count, first and last jid

Parameters:

objects -

rsm -

Returns:

Throws:

IllegalArgumentException - If the item specified by the requesting entity via the UID in the or element does not exist