com.echomine.jabber.msg

Class AgentsIQMessage

java.lang.Object

com.echomine.jabber.JabberMessage

com.echomine.jabber.JabberJDOMMessage

com.echomine.jabber.AbstractJabberMessage

com.echomine.jabber.JabberIQMessage

com.echomine.jabber.msg.AgentsIQMessage

All Implemented Interfaces:

JabberMessageParsable

Deprecated.

Replaced by new JEP-0030 Service Discovery

public class AgentsIQMessage
extends JabberIQMessage

This message encapsulates the retrieval of agents supported by the server. As the implementation provides readonly information to the agents hosted by the server, this class provides readonly methods for retrieving the list of agents.

The jabber:iq:agents is the old style of retrieving information and will soon be superseded by the new browsing framework. In fact, some jabber servers already support the new browsing framework for agent listing (ie. jabber.org). However, some others do not (specifically jabber.com). Thus, for compatibility, the jabber:iq:agents namespace is supported.

Current Implementation: JEP-0094 Version 0.1

See Also:

ServiceInfoIQMessage, ServiceItemsIQMessage

Field Summary

Fields inherited from class com.echomine.jabber.JabberIQMessage

TYPE_GET, TYPE_RESULT, TYPE_SET

Fields inherited from class com.echomine.jabber.AbstractJabberMessage

TYPE_ERROR

Fields inherited from class com.echomine.jabber.JabberMessage

messageID

Constructor Summary

Constructors

Constructor and Description
AgentsIQMessage() Deprecated. defaults to iq type get for retrieval or for parsing incoming messages

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	getAgentList() Deprecated. retrieve the list of agents.
int	getMessageType() Deprecated. the default message type is unknown.
JabberMessage	parse(JabberMessageParser parser, Element msgTree) Deprecated. parses the incoming message for the data

Methods inherited from class com.echomine.jabber.AbstractJabberMessage

getErrorMessage, getFrom, getTo, getType, isError, setErrorMessage, setFrom, setTo, setType

Methods inherited from class com.echomine.jabber.JabberJDOMMessage

encode, getDOM, getXMLOutputter, setMessageID, toString

Methods inherited from class com.echomine.jabber.JabberMessage

getMessageID, getReplyMessage, getTimeout, getXMessage, getXMessages, interrupt, isReplyRequired, isSendXMessages, isSynchronized, replyReceived, setReplyRequired, setSendXMessages, setSynchronized, setTimeout, setXMessage, setXMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentsIQMessage

public AgentsIQMessage()

Deprecated.

defaults to iq type get for retrieval or for parsing incoming messages

Method Detail

getAgentList

public java.util.List getAgentList()

Deprecated.

retrieve the list of agents.

Returns:

a List of Agent objects

parse

public JabberMessage parse(JabberMessageParser parser,
                  Element msgTree)
                    throws ParseException

Deprecated.

parses the incoming message for the data

Specified by:

parse in interface JabberMessageParsable

Overrides:

parse in class AbstractJabberMessage

Throws:

ParseException

getMessageType

public int getMessageType()

Deprecated.

Description copied from class: JabberJDOMMessage

the default message type is unknown. It doesn't mean that there is no type. It just means that there is no known message parser for this particular object.

Overrides:

getMessageType in class JabberIQMessage

Returns:

a message code that is unique to the message

See Also:

JabberCode