org.jivesoftware.smack.sasl.packet

Class SaslStreamElements.SASLFailure

java.lang.Object

org.jivesoftware.smack.packet.TopLevelStreamElement

org.jivesoftware.smack.packet.PlainStreamElement

org.jivesoftware.smack.sasl.packet.SaslStreamElements.SASLFailure

All Implemented Interfaces:

Element

Enclosing class:

SaslStreamElements

public static class SaslStreamElements.SASLFailure
extends PlainStreamElement

A SASL failure stream element.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
SaslStreamElements.SASLFailure(java.lang.String saslError)
SaslStreamElements.SASLFailure(java.lang.String saslError, java.util.Map<java.lang.String,java.lang.String> descriptiveTexts)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescriptiveText() Get the descriptive text of this SASLFailure.
java.lang.String	getDescriptiveText(java.lang.String xmllang) Get the descriptive test of this SASLFailure.
SASLError	getSASLError() Get the SASL related error condition.
java.lang.String	getSASLErrorString()
XmlStringBuilder	toXML() Returns the XML representation of this Element.

Methods inherited from class org.jivesoftware.smack.packet.TopLevelStreamElement

toString

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

Constructor Detail

SaslStreamElements.SASLFailure

public SaslStreamElements.SASLFailure(java.lang.String saslError)

SaslStreamElements.SASLFailure

public SaslStreamElements.SASLFailure(java.lang.String saslError,
                              java.util.Map<java.lang.String,java.lang.String> descriptiveTexts)

Method Detail

getSASLError

public SASLError getSASLError()

Get the SASL related error condition.

Returns:

the SASL related error condition.

getSASLErrorString

public java.lang.String getSASLErrorString()

Returns:

the SASL error as String

getDescriptiveText

public java.lang.String getDescriptiveText()

Get the descriptive text of this SASLFailure.

Returns the descriptive text of this SASLFailure in the system default language if possible. May return null.

Returns:

the descriptive text or null.

getDescriptiveText

public java.lang.String getDescriptiveText(java.lang.String xmllang)

Get the descriptive test of this SASLFailure.

Returns the descriptive text of this SASLFailure in the given language. May return null if not available.

Parameters:

xmllang - the language.

Returns:

the descriptive text or null.

toXML

public XmlStringBuilder toXML()

Description copied from interface: Element

Returns the XML representation of this Element.

Returns:

the packet extension as XML.