com.echomine.jabber.msg

Class Agent

java.lang.Object

com.echomine.jabber.msg.Agent

Deprecated.

Replaced by new JEP-0030 Service Discovery

public class Agent
extends java.lang.Object

represents an agent object. This is here to support the AgentIQMessage. It is very similar to JIDType because it will soon be superseded by the new browsing framework (which uses JIDType). The fields for this object are readonly because this function is usually used to retrieve data sent from the server.

This object is not reusable once instantiated. Consider it immutable.

See Also:

ServiceInfoIQMessage

Constructor Summary

Constructors

Constructor and Description
Agent(JID jid) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription() Deprecated.
java.util.HashMap	getFeatureList() Deprecated. retrieves a list of features supported by the agent.
JID	getJID() Deprecated.
java.lang.String	getName() Deprecated.
java.util.List	getNSList() Deprecated. retrieves the list of namespaces that the agent supports.
java.lang.String	getService() Deprecated.
java.lang.String	getTransport() Deprecated.
void	parse(Element agentElem) Deprecated. parses the incoming message for the data.
boolean	supportsMultiUserChat() Deprecated. inclusion of this empty element signals that the service is a multi-user chat service
boolean	supportsRegistration() Deprecated. inclusion of this empty element signals that the service supports registration
boolean	supportsSearching() Deprecated. inclusion of this empty element signals that the service supports searching

Methods inherited from class java.lang.Object

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

Constructor Detail

Agent

public Agent(JID jid)

Deprecated.

Method Detail

getJID

public JID getJID()

Deprecated.

getDescription

public java.lang.String getDescription()

Deprecated.

Returns:

a short phrase describing the service, or null if empty

supportsMultiUserChat

public boolean supportsMultiUserChat()

Deprecated.

inclusion of this empty element signals that the service is a multi-user chat service

Returns:

true if the agent supports multi-user chat

supportsRegistration

public boolean supportsRegistration()

Deprecated.

inclusion of this empty element signals that the service supports registration

Returns:

true if the agent support registration

supportsSearching

public boolean supportsSearching()

Deprecated.

inclusion of this empty element signals that the service supports searching

Returns:

true if the agent supports searching

getName

public java.lang.String getName()

Deprecated.

Returns:

the name of the agent as sent by the server, null if empty

getTransport

public java.lang.String getTransport()

Deprecated.

Returns:

the transport name of the agent as sent by the server, null if empty

getService

public java.lang.String getService()

Deprecated.

Returns:

the service name of the agent as returned by the server, null if empty

getFeatureList

public java.util.HashMap getFeatureList()

Deprecated.

retrieves a list of features supported by the agent. This basically contains all the names (the agent name, the service name, the transport name) plus all the features supported by the agent (ie. registration, search, groupchat). By querying for the existence of a specific feature, you then know what is supported by the agent and act accordingly. For instance, if you know that the User Directory support the Search feature, you can then add an option to allow the user to do a search through this specific agent.

Returns:

a hashmap of features that are String objects

getNSList

public java.util.List getNSList()

Deprecated.

retrieves the list of namespaces that the agent supports. This is basically the newer set of functionality that will supersede the older feature list. It contains the namespaces supported by the agent (ie. jabber:iq:conference, etc). Once you know the namespace supported, you can support that by doing namespace-specific actions for that particular agent.

Returns:

a list of the namespaces (String objects)

parse

public void parse(Element agentElem)
           throws ParseException

Deprecated.

parses the incoming message for the data. The element passed in should be the beginning of the agent element (ie. the element).

Throws:

ParseException