Package rocks.xmpp.extensions.jingle.model

Class Jingle.Reason

java.lang.Object

rocks.xmpp.extensions.jingle.model.Jingle.Reason

Enclosing class:

Jingle

public static final class Jingle.Reason
extends Object

The implementation of the <reason/> element.

See Also:

7.4 Reason Element

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Jingle.Reason.AlternativeSession	The party prefers to use an existing session with the peer rather than initiate a new session; the Jingle session ID of the alternative session SHOULD be provided as the XML character data of the <sid/> child.
static class	Jingle.Reason.Busy	The party is busy and cannot accept a session.
static class	Jingle.Reason.Cancel	The initiator wishes to formally cancel the session initiation request.
static class	Jingle.Reason.Condition	The base class for the defined conditions for a reason.
static class	Jingle.Reason.ConnectivityError	The action is related to connectivity problems.
static class	Jingle.Reason.Decline	The party wishes to formally decline the session.
static class	Jingle.Reason.Expired	The session length has exceeded a pre-defined time limit (e.g., a meeting hosted at a conference service).
static class	Jingle.Reason.FailedApplication	The party has been unable to initialize processing related to the application type.
static class	Jingle.Reason.FailedTransport	The party has been unable to establish connectivity for the transport method.
static class	Jingle.Reason.GeneralError	The action is related to a non-specific application error.
static class	Jingle.Reason.Gone	The entity is going offline or is no longer available.
static class	Jingle.Reason.IncompatibleParameters	The party supports the offered application type but does not support the offered or negotiated parameters.
static class	Jingle.Reason.MediaError	The action is related to media processing problems.
static class	Jingle.Reason.SecurityError	The action is related to a violation of local security policies.
static class	Jingle.Reason.Success	The action is generated during the normal course of state management and does not reflect any error.
static class	Jingle.Reason.Timeout	A request has not been answered so the sender is timing out the request.
static class	Jingle.Reason.UnsupportedApplications	The party supports none of the offered application types.
static class	Jingle.Reason.UnsupportedTransports	The party supports none of the offered transport methods.

Constructor Summary

Constructors

Constructor	Description
Reason(Jingle.Reason.Condition condition)	Creates a reason element with a defined condition.
Reason(Jingle.Reason.Condition condition, String text)	Creates a reason element with a defined condition and a text.
Reason(Jingle.Reason.Condition condition, String text, Object extension)	Creates a reason element with a defined condition and a text.

Method Summary

Modifier and Type	Method	Description
Object	getExtension()	Gets the extension, which defines more detailed information about the reason.
String	getText()	Gets human-readable information about the reason for the action.
Jingle.Reason.Condition	getType()	Gets the type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Reason

public Reason(Jingle.Reason.Condition condition)

Creates a reason element with a defined condition.

Parameters:

condition - The condition.

Reason

public Reason(Jingle.Reason.Condition condition,
              String text)

Creates a reason element with a defined condition and a text.

Parameters:

condition - The condition.

text - The optional text for the reason.

Reason

public Reason(Jingle.Reason.Condition condition,
              String text,
              Object extension)

Creates a reason element with a defined condition and a text.

Parameters:

condition - The condition.

text - The optional text for the reason.

extension - An object to provide more detailed information about the reason.

Method Detail

getType

public Jingle.Reason.Condition getType()

Gets the type.

Returns:

The type.

getText

public String getText()

Gets human-readable information about the reason for the action.

Returns:

The information.

getExtension

public Object getExtension()

Gets the extension, which defines more detailed information about the reason.

Returns:

The reason.