net.bioclipse.xws.client
Interface IXmppItem

All Known Subinterfaces:

IFunction, IService

public interface IXmppItem

Method Summary

void	discoverAsync(IDiscoListener listener) Starts asynchronous discovery of the XMPP item.
IXmppItem	discoverSync(long millis) Starts synchronous discovery of the XMPP item.
java.lang.String	getDescription() Returns the description of the XMPP item if available, otherwise "".
XmppException	getDiscoError() Returns the last XmppException that occurred after discovering the of the XMPP item was started if available, otherwise null.
DiscoStatus	getDiscoStatus() Returns the DiscoStatus of the XMPP item.
Info	getInfo() Returns the Info of the XMPP item if available, otherwise null.
Items	getItems() Returns the Items of the XMPP item if available, otherwise null.
java.lang.String	getJid() Returns the JID of the XMPP item.
java.lang.String	getNode() Returns the node name of the XMPP item if available, otherwise "".
java.lang.String	toString() Returns a String with the JID, node name, and description.

Method Detail

toString

java.lang.String toString()

Returns a String with the JID, node name, and description.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of the XMPP item.

getJid

java.lang.String getJid()

Returns the JID of the XMPP item.

Returns:

The JID of the XMPP item.

getNode

java.lang.String getNode()

Returns the node name of the XMPP item if available, otherwise "".

Returns:

The node name of the XMPP item if available, otherwise "".

getDescription

java.lang.String getDescription()

Returns the description of the XMPP item if available, otherwise "".

Returns:

The description of the XMPP item if available, otherwise "".

getInfo

Info getInfo()
             throws XwsException

Returns the Info of the XMPP item if available, otherwise null.

Returns:

The Info of the XMPP item if available, otherwise null.

Throws:

XwsException

getItems

Items getItems()
               throws XwsException

Returns the Items of the XMPP item if available, otherwise null.

Returns:

The items of the XMPP item if available, otherwise null.

Throws:

XwsException

getDiscoError

XmppException getDiscoError()

Returns the last XmppException that occurred after discovering the of the XMPP item was started if available, otherwise null.

Returns:

The items of the XMPP item if available, otherwise null.

getDiscoStatus

DiscoStatus getDiscoStatus()

Returns the DiscoStatus of the XMPP item.

Returns:

The DiscoStatus of the XMPP item.

discoverAsync

void discoverAsync(IDiscoListener listener)
                   throws XmppException,
                          XwsException

Starts asynchronous discovery of the XMPP item. The listener will be informed when the discovery completes or fails.

Parameters:

listener - The listener to be informed.

Throws:

XmppException

XwsException

discoverSync

IXmppItem discoverSync(long millis)
                       throws XmppException,
                              XwsException,
                              java.lang.InterruptedException

Starts synchronous discovery of the XMPP item. The function blocks until discovery completes, fails, or the timeout occurs.

Parameters:

millis - The timeout in milliseconds.

Returns:

The discovered XmppItem.

Throws:

XmppException

XwsException

java.lang.InterruptedException