org.jivesoftware.smackx.jingle

Class JingleSession

java.lang.Object

org.jivesoftware.smackx.jingle.JingleNegotiator

org.jivesoftware.smackx.jingle.JingleSession

All Implemented Interfaces:

MediaReceivedListener

public class JingleSession
extends JingleNegotiator
implements MediaReceivedListener

An abstract Jingle session.

This class contains some basic properties of every Jingle session. However, the concrete implementation can be found in subclasses.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<JingleMediaManager>	jingleMediaManagers

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

session

Constructor Summary

Constructors

Constructor and Description
JingleSession(XMPPConnection conn, JingleSessionRequest request, String initiator, String responder, List<JingleMediaManager> jingleMediaManagers) JingleSession constructor (for an outgoing Jingle session)
JingleSession(XMPPConnection conn, String initiator, String responder, String sessionid, List<JingleMediaManager> jingleMediaManagers) Full featured JingleSession constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addContentNegotiator(ContentNegotiator inContentNegotiator) Add a new content negotiator on behalf of a section received.
void	addJingleMediaSession(String mediaManagerName, JingleMediaSession mediaSession) The jingle session may have one or more media managers that are trying to establish media sessions.
void	addMediaListener(JingleMediaListener li) Add a listener for jmf negotiation events
void	addTransportListener(JingleTransportListener li) Add a listener for transport negotiation events
void	close() Terminate negotiations.
IQ	createAck(IQ iq) Acknowledge a IQ packet.
static IQ	createError(String ID, String to, String from, int errCode, XMPPError error) A convience method to create an error packet.
static IQ	createIQ(String ID, String to, String from, IQ.Type type) A convience method to create an IQ packet.
IQ	createJingleError(IQ iq, JingleError jingleError) Complete and send an error.
List<IQ>	dispatchIncomingPacket(IQ iq, String id) Dispatch an incoming packet.
protected void	doStart() Each of the negotiators has their individual behavior when they start.
boolean	equals(Object obj)
protected static String	generateSessionId() Generate a unique session ID.
XMPPConnection	getConnection()
String	getInitiator() Get the session initiator
static JingleSession	getInstanceFor(XMPPConnection con) Returns the JingleSession related to a particular connection.
List<JingleMediaManager>	getMediaManagers() Get the Media Manager of this Jingle Session
JingleMediaSession	getMediaSession(String mediaManagerName) The jingle session may have one or more media managers that are trying to establish media sessions.
String	getResponder() Get the session responder
JingleSessionState	getSessionState()
String	getSid() Get the session ID
int	hashCode() Send a content info message.
boolean	isClosed()
boolean	isFullyEstablished() Return true if all of the media managers have finished
void	mediaReceived(String participant) Called when new Media is received.
void	receivePacketAndRespond(IQ iq) Process and respond to an incoming packet.
void	removeMediaListener(JingleMediaListener li) Remove a listener for jmf negotiation events
protected void	removePacketListener() Remove the packet listener used for processing packet.
void	removeTransportListener(JingleTransportListener li) Remove a listener for transport negotiation events
Jingle	sendFormattedJingle(IQ iq, Jingle jout) Complete and send a packet.
Jingle	sendFormattedJingle(Jingle jout) Complete and send a packet.
void	sendPacket(IQ iq)
void	setInitiator(String initiator) Set the session initiator
void	setMediaManagers(List<JingleMediaManager> jingleMediaManagers) Set the Media Manager of this Jingle Session
void	setResponder(String responder) Set the session responder.
void	setSessionState(JingleSessionState stateIs) Validate the state changes.
protected void	setSid(String sessionId) Set the session ID
void	setupListeners() Setup the listeners that act on events coming from the lower level negotiators.
void	startIncoming() This is the starting point for responding to a new session.
void	startOutgoing() This is the starting point for intitiating a new session.
void	terminate() Terminates the session with default reason.
void	terminate(String reason) Terminates the session with a custom reason.
protected void	triggerMediaReceived(String participant) Trigger a media received event.
protected void	triggerSessionClosed(String reason) Trigger a session closed event.
protected void	triggerSessionClosedOnError(XMPPException exc) Trigger a session closed event due to an error.
protected void	updatePacketListener() Install the packet listener.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

jingleMediaManagers

protected List<JingleMediaManager> jingleMediaManagers

Constructor Detail

JingleSession

public JingleSession(XMPPConnection conn,
             String initiator,
             String responder,
             String sessionid,
             List<JingleMediaManager> jingleMediaManagers)

Full featured JingleSession constructor

Parameters:

conn - the XMPPConnection which is used

initiator - the initiator JID

responder - the responder JID

sessionid - the session ID

jingleMediaManagers - the jingleMediaManager

JingleSession

public JingleSession(XMPPConnection conn,
             JingleSessionRequest request,
             String initiator,
             String responder,
             List<JingleMediaManager> jingleMediaManagers)

JingleSession constructor (for an outgoing Jingle session)

Parameters:

conn - Connection

initiator - the initiator JID

responder - the responder JID

jingleMediaManagers - the jingleMediaManager

Method Detail

getInitiator

public String getInitiator()

Get the session initiator

Returns:

the initiator

getConnection

public XMPPConnection getConnection()

Overrides:

getConnection in class JingleNegotiator

setInitiator

public void setInitiator(String initiator)

Set the session initiator

Parameters:

initiator - the initiator to set

getMediaManagers

public List<JingleMediaManager> getMediaManagers()

Get the Media Manager of this Jingle Session

Returns:

the JingleMediaManagers

setMediaManagers

public void setMediaManagers(List<JingleMediaManager> jingleMediaManagers)

Set the Media Manager of this Jingle Session

Parameters:

jingleMediaManagers -

getResponder

public String getResponder()

Get the session responder

Returns:

the responder

setResponder

public void setResponder(String responder)

Set the session responder.

Parameters:

responder - the receptor to set

getSid

public String getSid()

Get the session ID

Returns:

the sid

setSid

protected void setSid(String sessionId)

Set the session ID

Parameters:

sessionId - the sid to set

generateSessionId

protected static String generateSessionId()

Generate a unique session ID.

setSessionState

public void setSessionState(JingleSessionState stateIs)

Validate the state changes.

getSessionState

public JingleSessionState getSessionState()

isFullyEstablished

public boolean isFullyEstablished()

Return true if all of the media managers have finished

receivePacketAndRespond

public void receivePacketAndRespond(IQ iq)
                             throws XMPPException,
                                    SmackException

Process and respond to an incoming packet.

This method is called from the packet listener dispatcher when a new packet has arrived. The method is responsible for recognizing the packet type and, depending on the current state, delivering it to the right event handler and wait for a response. The response will be another Jingle packet that will be sent to the other end point.

Parameters:

iq - the packet received

Throws:

XMPPException

SmackException

dispatchIncomingPacket

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

Dispatch an incoming packet. The method is responsible for recognizing the packet type and, depending on the current state, delivering the packet to the right event handler and wait for a response.

Specified by:

dispatchIncomingPacket in class JingleNegotiator

Parameters:

iq - the packet received

id - the ID of the response that will be sent

Returns:

the new Jingle packet to send.

Throws:

XMPPException

SmackException

addContentNegotiator

public void addContentNegotiator(ContentNegotiator inContentNegotiator)

Add a new content negotiator on behalf of a section received.

sendPacket

public void sendPacket(IQ iq)
                throws SmackException.NotConnectedException

Throws:

SmackException.NotConnectedException

sendFormattedJingle

public Jingle sendFormattedJingle(Jingle jout)
                           throws SmackException.NotConnectedException

Complete and send a packet. Complete all the null fields in a Jingle reponse, using the session information we have.

Parameters:

jout - the Jingle packet we want to complete and send

Throws:

SmackException.NotConnectedException

sendFormattedJingle

public Jingle sendFormattedJingle(IQ iq,
                         Jingle jout)
                           throws SmackException.NotConnectedException

Complete and send a packet. Complete all the null fields in a Jingle reponse, using the session information we have or some info from the incoming packet.

Parameters:

iq - The Jingle packet we are responing to

jout - the Jingle packet we want to complete and send

Throws:

SmackException.NotConnectedException

createAck

public IQ createAck(IQ iq)

Acknowledge a IQ packet.

Parameters:

iq - The IQ to acknowledge

hashCode

public int hashCode()

Send a content info message.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getInstanceFor

public static JingleSession getInstanceFor(XMPPConnection con)

Returns the JingleSession related to a particular connection.

Parameters:

con - A XMPP connection

Returns:

a Jingle session

removePacketListener

protected void removePacketListener()

Remove the packet listener used for processing packet.

updatePacketListener

protected void updatePacketListener()

Install the packet listener. The listener is responsible for responding to any packet that we receive...

addMediaListener

public void addMediaListener(JingleMediaListener li)

Add a listener for jmf negotiation events

Parameters:

li - The listener

removeMediaListener

public void removeMediaListener(JingleMediaListener li)

Remove a listener for jmf negotiation events

Parameters:

li - The listener

addTransportListener

public void addTransportListener(JingleTransportListener li)

Add a listener for transport negotiation events

Parameters:

li - The listener

removeTransportListener

public void removeTransportListener(JingleTransportListener li)

Remove a listener for transport negotiation events

Parameters:

li - The listener

setupListeners

public void setupListeners()

Setup the listeners that act on events coming from the lower level negotiators.

triggerSessionClosed

protected void triggerSessionClosed(String reason)

Trigger a session closed event.

triggerSessionClosedOnError

protected void triggerSessionClosedOnError(XMPPException exc)

Trigger a session closed event due to an error.

triggerMediaReceived

protected void triggerMediaReceived(String participant)

Trigger a media received event.

terminate

public void terminate()
               throws XMPPException,
                      SmackException.NotConnectedException

Terminates the session with default reason.

Throws:

XMPPException

SmackException.NotConnectedException

terminate

public void terminate(String reason)
               throws XMPPException,
                      SmackException.NotConnectedException

Terminates the session with a custom reason.

Throws:

XMPPException

SmackException.NotConnectedException

close

public void close()

Terminate negotiations.

Overrides:

close in class JingleNegotiator

isClosed

public boolean isClosed()

createIQ

public static IQ createIQ(String ID,
          String to,
          String from,
          IQ.Type type)

A convience method to create an IQ packet.

Parameters:

ID - The packet ID of the

to - To whom the packet is addressed.

from - From whom the packet is sent.

type - The iq type of the packet.

Returns:

The created IQ packet.

createError

public static IQ createError(String ID,
             String to,
             String from,
             int errCode,
             XMPPError error)

A convience method to create an error packet.

Parameters:

ID - The packet ID of the

to - To whom the packet is addressed.

from - From whom the packet is sent.

errCode - The error code.

error - The XMPPError string.

Returns:

The created IQ packet.

createJingleError

public IQ createJingleError(IQ iq,
                   JingleError jingleError)

Complete and send an error. Complete all the null fields in an IQ error reponse, using the sesssion information we have or some info from the incoming packet.

Parameters:

iq - The Jingle packet we are responing to

jingleError - the IQ packet we want to complete and send

mediaReceived

public void mediaReceived(String participant)

Called when new Media is received.

Specified by:

mediaReceived in interface MediaReceivedListener

startOutgoing

public void startOutgoing()
                   throws IllegalStateException,
                          SmackException

This is the starting point for intitiating a new session.

Throws:

IllegalStateException

SmackException

startIncoming

public void startIncoming()

This is the starting point for responding to a new session.

doStart

protected void doStart()

Description copied from class: JingleNegotiator

Each of the negotiators has their individual behavior when they start.

Specified by:

doStart in class JingleNegotiator

addJingleMediaSession

public void addJingleMediaSession(String mediaManagerName,
                         JingleMediaSession mediaSession)

The jingle session may have one or more media managers that are trying to establish media sessions. When the media manager succeeds in creating a media session is registers it with the session by the media manager's static name. This routine is where the media manager does the registering.

getMediaSession

public JingleMediaSession getMediaSession(String mediaManagerName)

The jingle session may have one or more media managers that are trying to establish media sessions. When the media manager succeeds in creating a media session is registers it with the session by the media manager's static name. This routine is where other objects can access the registered media sessions. NB: If the media manager has not succeeded in establishing a media session then this could return null.