rocks.xmpp.core.sasl.model

Class Failure

java.lang.Object

rocks.xmpp.core.sasl.model.Failure

All Implemented Interfaces:

StreamElement

public final class Failure
extends Object
implements StreamElement

The implementation of the <failure/> element, which indicates a SASL failure.

6.4.5. SASL Failure

The receiving entity reports failure of the handshake for this authentication mechanism by sending a <failure/> element qualified by the 'urn:ietf:params:xml:ns:xmpp-sasl' namespace.

This class is immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Failure.Condition A general class for a SASL failure condition.

Constructor Summary

Constructors

Constructor and Description
Failure(Failure.Condition condition)
Failure(Failure.Condition condition, String text, Locale locale)

Method Summary

Modifier and Type	Method and Description
Failure.Condition	getCondition() Gets the defined error condition.
Locale	getLanguage() Gets the language of the text.
String	getText() Gets the text of the failure.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Failure

public Failure(Failure.Condition condition)

Failure

public Failure(Failure.Condition condition,
               String text,
               Locale locale)

Method Detail

getCondition

public final Failure.Condition getCondition()

Gets the defined error condition.

Returns:

The error condition.

getText

public final String getText()

Gets the text of the failure.

Returns:

The text.

getLanguage

public final Locale getLanguage()

Gets the language of the text.

Returns:

The language.

toString

public final String toString()

Overrides:

toString in class Object