org.jivesoftware.smackx.jingle

Class ContentNegotiator

java.lang.Object

org.jivesoftware.smackx.jingle.JingleNegotiator

org.jivesoftware.smackx.jingle.ContentNegotiator

public class ContentNegotiator
extends JingleNegotiator

Field Summary

Fields

Modifier and Type	Field and Description
static String	INITIATOR
static String	RESPONDER

Fields inherited from class org.jivesoftware.smackx.jingle.JingleNegotiator

session

Constructor Summary

Constructors

Constructor and Description
ContentNegotiator(JingleSession session, String inCreator, String inName)

Method Summary

Methods

Modifier and Type	Method and Description
void	addTransportNegotiator(TransportNegotiator transportNegotiator)
void	close() Prepare to close the media manager.
protected void	destroyMediaNegotiator() Destroy the jmf negotiator.
protected void	destroyTransportNegotiator() Destroy the transport negotiator.
List<IQ>	dispatchIncomingPacket(IQ iq, String id) Dispatch an incoming packet.
protected void	doStart() Called from above when starting a new session.
String	getCreator()
JingleContent	getJingleContent()
JingleMediaSession	getJingleMediaSession() Get the JingleMediaSession of this Jingle Session
MediaNegotiator	getMediaNegotiator() Obtain the description negotiator for this session
String	getName()
JingleNegotiatorState	getNegotiatorState() The negotiator state for the ContentNegotiators is a special case.
JingleTransportManager	getTransportManager()
TransportNegotiator	getTransportNegotiator() Obtain the transport negotiator for this session.
boolean	isFullyEstablished() Return true if the transport and content negotiators have finished
void	setJingleTransportManager(JingleTransportManager jingleTransportManager)
protected void	setMediaNegotiator(MediaNegotiator mediaNeg) Set the jmf negotiator.
protected void	setTransportNegotiator(TransportNegotiator transNeg) Set TransportNegociator
void	stopJingleMediaSession() Stop a Jingle media session.
void	triggerContentEstablished()

Methods inherited from class org.jivesoftware.smackx.jingle.JingleNegotiator

addExpectedId, addListener, getConnection, getListenersList, getSession, isExpectedId, isStarted, removeExpectedId, removeListener, setNegotiatorState, setSession, start

Methods inherited from class java.lang.Object

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

Field Detail

INITIATOR

public static final String INITIATOR

See Also:

Constant Field Values

RESPONDER

public static final String RESPONDER

See Also:

Constant Field Values

Constructor Detail

ContentNegotiator

public ContentNegotiator(JingleSession session,
                 String inCreator,
                 String inName)

Method Detail

dispatchIncomingPacket

public List<IQ> dispatchIncomingPacket(IQ iq,
                              String id)
                                throws XMPPException,
                                       SmackException

Description copied from class: JingleNegotiator

Dispatch an incoming packet. The negotiators form a tree relationship that roughly matches the Jingle packet format: JingleSession Content Negotiator Media Negotiator Transport Negotiator Content Negotiator Media Negotiator Transport Negotiator This way, each segment of a Jingle packet has a corresponding negotiator that know how to deal with that part of the Jingle packet. It also allows us to support Jingle packets of arbitraty complexity. Each parent calls dispatchIncomingPacket for each of its children. The children then pass back a List<> of results that will get sent when we reach the top level negotiator (JingleSession).

Specified by:

dispatchIncomingPacket in class JingleNegotiator

Parameters:

iq - the packet received

id - the ID of the response that will be sent

Returns:

the new packet to send (either a Jingle or an IQ error).

Throws:

XMPPException

SmackException

getCreator

public String getCreator()

getName

public String getName()

getJingleMediaSession

public JingleMediaSession getJingleMediaSession()

Get the JingleMediaSession of this Jingle Session

Returns:

the JingleMediaSession

addTransportNegotiator

public void addTransportNegotiator(TransportNegotiator transportNegotiator)

setJingleTransportManager

public void setJingleTransportManager(JingleTransportManager jingleTransportManager)

Parameters:

jingleTransportManager -

getTransportManager

public JingleTransportManager getTransportManager()

Returns:

the JingleTransportManager

doStart

protected void doStart()

Called from above when starting a new session.

Specified by:

doStart in class JingleNegotiator

close

public void close()

Prepare to close the media manager.

Overrides:

close in class JingleNegotiator

getMediaNegotiator

public MediaNegotiator getMediaNegotiator()

Obtain the description negotiator for this session

Returns:

the description negotiator

setMediaNegotiator

protected void setMediaNegotiator(MediaNegotiator mediaNeg)

Set the jmf negotiator.

Parameters:

mediaNeg - the description negotiator to set

destroyMediaNegotiator

protected void destroyMediaNegotiator()

Destroy the jmf negotiator.

getTransportNegotiator

public TransportNegotiator getTransportNegotiator()

Obtain the transport negotiator for this session.

Returns:

the transport negotiator instance

setTransportNegotiator

protected void setTransportNegotiator(TransportNegotiator transNeg)

Set TransportNegociator

Parameters:

transNeg - the transNeg to set

destroyTransportNegotiator

protected void destroyTransportNegotiator()

Destroy the transport negotiator.

isFullyEstablished

public boolean isFullyEstablished()

Return true if the transport and content negotiators have finished

getJingleContent

public JingleContent getJingleContent()

triggerContentEstablished

public void triggerContentEstablished()
                               throws SmackException.NotConnectedException

Throws:

SmackException.NotConnectedException

stopJingleMediaSession

public void stopJingleMediaSession()

Stop a Jingle media session.

getNegotiatorState

public JingleNegotiatorState getNegotiatorState()

The negotiator state for the ContentNegotiators is a special case. It is a roll-up of the sub-negotiator states.

Overrides:

getNegotiatorState in class JingleNegotiator