org.jivesoftware.smackx.jingle.nat

Class RTPBridge

java.lang.Object

org.jivesoftware.smack.packet.Packet

org.jivesoftware.smack.packet.IQ

org.jivesoftware.smackx.jingle.nat.RTPBridge

public class RTPBridge
extends IQ

RTPBridge IQ Packet used to request and retrieve a RTPBridge Candidates that can be used for a Jingle Media Transmission between two parties that are behind NAT. This Jingle Bridge has all the needed information to establish a full UDP Channel (Send and Receive) between two parties. This transport method should be used only if other transport methods are not allowed. Or if you want a more reliable transport.

High Level Usage Example:

RTPBridge rtpBridge = RTPBridge.getRTPBridge(connection, sessionID);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RTPBridge.Provider IQProvider for RTP Bridge packets.

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

IQ.Type

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT_NAME Element name of the packet extension.
static java.lang.String	NAME Element name of the packet extension.
static java.lang.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
RTPBridge() Creates a RTPBridge Packet without Session ID
RTPBridge(org.jivesoftware.smackx.jingle.nat.RTPBridge.BridgeAction action) Creates a RTPBridge Instance with defined Session ID
RTPBridge(java.lang.String sid) Creates a RTPBridge Instance with defined Session ID
RTPBridge(java.lang.String sid, org.jivesoftware.smackx.jingle.nat.RTPBridge.BridgeAction bridgeAction) Creates a RTPBridge Instance with defined Session ID

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAttributes() Get the attributes string
java.lang.String	getChildElementXML() Get the Child Element XML of the Packet
java.lang.String	getHostA() Get the Host A IP Address
java.lang.String	getHostB() Get the Host B IP Address
java.lang.String	getIp() Get the RTP Bridge IP
java.lang.String	getName() Get the name of the Candidate
java.lang.String	getPass() Get the RTP Agent Pass
int	getPortA() Get Side A receive port
int	getPortB() Get Side B receive port
static java.lang.String	getPublicIP(XMPPConnection xmppConnection) Get Public Address from the Server.
static RTPBridge	getRTPBridge(XMPPConnection connection, java.lang.String sessionID) Get a new RTPBridge Candidate from the server.
java.lang.String	getSid() Get the Session ID of the Packet (usually same as Jingle Session ID)
static RTPBridge	relaySession(XMPPConnection connection, java.lang.String sessionID, java.lang.String pass, TransportCandidate proxyCandidate, TransportCandidate localCandidate) Check if the server support RTPBridge Service.
static boolean	serviceAvailable(XMPPConnection connection) Check if the server support RTPBridge Service.
void	setHostA(java.lang.String hostA) Set the Host A IP Address
void	setHostB(java.lang.String hostB) Set the Host B IP Address
void	setIp(java.lang.String ip) Set the RTP Bridge IP
void	setName(java.lang.String name) Set the name of the Candidate
void	setPass(java.lang.String pass) Set the RTP Agent Pass
void	setPortA(int portA) Set Side A receive port
void	setPortB(int portB) Set Side B receive port
void	setSid(java.lang.String sid) Set the Session ID of the Packet (usually same as Jingle Session ID)

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

NAME

public static final java.lang.String NAME

Element name of the packet extension.

See Also:

Constant Field Values

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME

Element name of the packet extension.

See Also:

Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE

Namespace of the packet extension.

See Also:

Constant Field Values

Constructor Detail

RTPBridge

public RTPBridge(java.lang.String sid)

Creates a RTPBridge Instance with defined Session ID

Parameters:

sid -

RTPBridge

public RTPBridge(org.jivesoftware.smackx.jingle.nat.RTPBridge.BridgeAction action)

Creates a RTPBridge Instance with defined Session ID

Parameters:

action -

RTPBridge

public RTPBridge(java.lang.String sid,
         org.jivesoftware.smackx.jingle.nat.RTPBridge.BridgeAction bridgeAction)

Creates a RTPBridge Instance with defined Session ID

Parameters:

sid -

bridgeAction -

RTPBridge

public RTPBridge()

Creates a RTPBridge Packet without Session ID

Method Detail

getAttributes

public java.lang.String getAttributes()

Get the attributes string

getSid

public java.lang.String getSid()

Get the Session ID of the Packet (usually same as Jingle Session ID)

Returns:

the session ID

setSid

public void setSid(java.lang.String sid)

Set the Session ID of the Packet (usually same as Jingle Session ID)

Parameters:

sid -

getHostA

public java.lang.String getHostA()

Get the Host A IP Address

Returns:

the Host A IP Address

setHostA

public void setHostA(java.lang.String hostA)

Set the Host A IP Address

Parameters:

hostA -

getHostB

public java.lang.String getHostB()

Get the Host B IP Address

Returns:

the Host B IP Address

setHostB

public void setHostB(java.lang.String hostB)

Set the Host B IP Address

Parameters:

hostB -

getPortA

public int getPortA()

Get Side A receive port

Returns:

the side A receive prot

setPortA

public void setPortA(int portA)

Set Side A receive port

Parameters:

portA -

getPortB

public int getPortB()

Get Side B receive port

Returns:

the side B receive port

setPortB

public void setPortB(int portB)

Set Side B receive port

Parameters:

portB -

getIp

public java.lang.String getIp()

Get the RTP Bridge IP

Returns:

the RTP Bridge IP

setIp

public void setIp(java.lang.String ip)

Set the RTP Bridge IP

Parameters:

ip -

getPass

public java.lang.String getPass()

Get the RTP Agent Pass

Returns:

the RTP Agent Pass

setPass

public void setPass(java.lang.String pass)

Set the RTP Agent Pass

Parameters:

pass -

getName

public java.lang.String getName()

Get the name of the Candidate

Returns:

the name of the Candidate

setName

public void setName(java.lang.String name)

Set the name of the Candidate

Parameters:

name -

getChildElementXML

public java.lang.String getChildElementXML()

Get the Child Element XML of the Packet

Specified by:

getChildElementXML in class IQ

Returns:

the Child Element XML of the Packet

getRTPBridge

public static RTPBridge getRTPBridge(XMPPConnection connection,
                     java.lang.String sessionID)
                              throws SmackException.NotConnectedException

Get a new RTPBridge Candidate from the server. If a error occurs or the server don't support RTPBridge Service, null is returned.

Parameters:

connection -

sessionID -

Returns:

the new RTPBridge

Throws:

SmackException.NotConnectedException

serviceAvailable

public static boolean serviceAvailable(XMPPConnection connection)
                                throws SmackException.NoResponseException,
                                       XMPPException.XMPPErrorException,
                                       SmackException.NotConnectedException

Check if the server support RTPBridge Service.

Parameters:

connection -

Returns:

true if the server supports the RTPBridge service

Throws:

XMPPException.XMPPErrorException

SmackException.NoResponseException

SmackException.NotConnectedException

relaySession

public static RTPBridge relaySession(XMPPConnection connection,
                     java.lang.String sessionID,
                     java.lang.String pass,
                     TransportCandidate proxyCandidate,
                     TransportCandidate localCandidate)
                              throws SmackException.NotConnectedException

Check if the server support RTPBridge Service.

Parameters:

connection -

Returns:

the RTPBridge

Throws:

SmackException.NotConnectedException

getPublicIP

public static java.lang.String getPublicIP(XMPPConnection xmppConnection)
                                    throws SmackException.NotConnectedException

Get Public Address from the Server.

Parameters:

xmppConnection -

Returns:

public IP String or null if not found

Throws:

SmackException.NotConnectedException