org.jivesoftware.smackx.jingle.nat

Class STUN

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.jingle.nat.STUN

public class STUN
extends IQ

STUN IQ Packet used to request and retrieve a STUN server and port to make p2p connections easier. STUN is usually used by Jingle Media Transmission between two parties that are behind NAT.

High Level Usage Example:

STUN stun = STUN.getSTUNServer(connection);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	STUN.Provider IQProvider for RTP Bridge packets.
static class	STUN.StunServerAddress Provides easy abstract to store STUN Server Addresses and Ports

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOMAIN Element name of the packet extension.
static String	ELEMENT_NAME Element name of the packet extension.
static String	NAMESPACE Namespace of the packet extension.

Fields inherited from class org.jivesoftware.smack.packet.Packet

DEFAULT_LANGUAGE, ID_NOT_AVAILABLE

Constructor Summary

Constructors

Constructor and Description
STUN() Creates a STUN IQ

Method Summary

Methods

Modifier and Type	Method and Description
String	getChildElementXML() Get the Child Element XML of the Packet
String	getPublicIp() Get Public Ip returned from the XMPP server
List<STUN.StunServerAddress>	getServers() Get a list of STUN Servers recommended by the Server
static STUN	getSTUNServer(XMPPConnection connection) Get a new STUN Server Address and port from the server.
static boolean	serviceAvailable(XMPPConnection connection) Check if the server support STUN Service.

Methods inherited from class org.jivesoftware.smack.packet.IQ

createErrorResponse, createResultIQ, getType, setType, toXML

Methods inherited from class org.jivesoftware.smack.packet.Packet

addCommonAttributes, addExtension, addExtensions, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DOMAIN

public static final String DOMAIN

Element name of the packet extension.

See Also:

Constant Field Values

ELEMENT_NAME

public static final String ELEMENT_NAME

Element name of the packet extension.

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

Namespace of the packet extension.

See Also:

Constant Field Values

Constructor Detail

STUN

public STUN()

Creates a STUN IQ

Method Detail

getServers

public List<STUN.StunServerAddress> getServers()

Get a list of STUN Servers recommended by the Server

Returns:

the list of STUN servers

getPublicIp

public String getPublicIp()

Get Public Ip returned from the XMPP server

Returns:

the public IP

getChildElementXML

public String getChildElementXML()

Get the Child Element XML of the Packet

Specified by:

getChildElementXML in class IQ

Returns:

the child element XML

getSTUNServer

public static STUN getSTUNServer(XMPPConnection connection)
                          throws SmackException.NotConnectedException

Get a new STUN Server Address and port from the server. If a error occurs or the server don't support STUN Service, null is returned.

Parameters:

connection -

Returns:

the STUN server address

Throws:

SmackException.NotConnectedException

serviceAvailable

public static boolean serviceAvailable(XMPPConnection connection)
                                throws XMPPException,
                                       SmackException

Check if the server support STUN Service.

Parameters:

connection - the connection

Returns:

true if the server support STUN

Throws:

SmackException

XMPPException