rocks.xmpp.extensions.jingle

Class JingleSession

java.lang.Object

rocks.xmpp.extensions.jingle.JingleSession

public final class JingleSession
extends Object

Author:

Christian Schudt

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JingleSession.State Represents the state of a Jingle session.

Method Summary

Modifier and Type	Method and Description
void	accept(Jingle.Content... contents) Accepts the session.
void	acceptTransport(String contentName, TransportMethod transportMethod)
void	addJingleListener(JingleListener jingleListener) Adds a Jingle listener, which allows to listen for Jingle events.
String	getSessionId() Gets the session id.
void	initiate() Initiates the session.
void	rejectTransport(String contentName, TransportMethod transportMethod)
void	removeJingleListener(JingleListener jingleListener) Removes a previously added Jingle listener.
void	replaceTransport(String contentName, TransportMethod transportMethod)
void	sendSessionInfo(Object object) Sends a session info.
void	terminate(Jingle.Reason reason) Terminates the Jingle session.

Methods inherited from class java.lang.Object

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

Method Detail

getSessionId

public String getSessionId()

Gets the session id.

Returns:

The session id.

initiate

public void initiate()
              throws rocks.xmpp.core.XmppException

Initiates the session.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.2 Initiation, 7.2.10 session-initiate

accept

public void accept(Jingle.Content... contents)
            throws rocks.xmpp.core.XmppException

Accepts the session. You must at least provide one content element.

Parameters:

contents - The contents.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.5 Acceptance, 7.2.8 session-accept

terminate

public void terminate(Jingle.Reason reason)
               throws rocks.xmpp.core.XmppException

Terminates the Jingle session.

Parameters:

reason - The reason for termination.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

6.7 Termination

replaceTransport

public void replaceTransport(String contentName,
                             TransportMethod transportMethod)
                      throws rocks.xmpp.core.XmppException

Parameters:

contentName - The content name.

transportMethod - The replaced transport method.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

7.2.15 transport-replace

acceptTransport

public void acceptTransport(String contentName,
                            TransportMethod transportMethod)
                     throws rocks.xmpp.core.XmppException

Throws:

rocks.xmpp.core.XmppException

rejectTransport

public void rejectTransport(String contentName,
                            TransportMethod transportMethod)
                     throws rocks.xmpp.core.XmppException

Throws:

rocks.xmpp.core.XmppException

sendSessionInfo

public void sendSessionInfo(Object object)
                     throws rocks.xmpp.core.XmppException

Sends a session info.

Parameters:

object - The session info payload.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

7.2.9 session-info

addJingleListener

public final void addJingleListener(JingleListener jingleListener)

Adds a Jingle listener, which allows to listen for Jingle events.

Parameters:

jingleListener - The listener.

See Also:

removeJingleListener(JingleListener)

removeJingleListener

public final void removeJingleListener(JingleListener jingleListener)

Removes a previously added Jingle listener.

Parameters:

jingleListener - The listener.

See Also:

addJingleListener(JingleListener)