org.jivesoftware.smack.sasl.packet

Class SaslNonza.SASLFailure

java.lang.Object

org.jivesoftware.smack.packet.AbstractError

org.jivesoftware.smack.sasl.packet.SaslNonza.SASLFailure

All Implemented Interfaces:

Element, FullyQualifiedElement, NamedElement, Nonza, TopLevelStreamElement, XmlLangElement, SaslNonza

Enclosing interface:

SaslNonza

public static class SaslNonza.SASLFailure
extends AbstractError
implements SaslNonza

A SASL failure stream element, also called "SASL Error".

See Also:

RFC 6120 6.5 SASL Errors

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.AbstractError

AbstractError.Builder<B extends AbstractError.Builder<B>>

Nested classes/interfaces inherited from interface org.jivesoftware.smack.sasl.packet.SaslNonza

SaslNonza.AuthMechanism, SaslNonza.Challenge, SaslNonza.Response, SaslNonza.SASLFailure, SaslNonza.Success

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT
static javax.xml.namespace.QName	QNAME

Fields inherited from class org.jivesoftware.smack.packet.AbstractError

descriptiveTexts, extensions, textNamespace

Fields inherited from interface org.jivesoftware.smack.sasl.packet.SaslNonza

NAMESPACE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getElementName() Returns the root element name.
SASLError	getSASLError() Get the SASL related error condition.
java.lang.String	getSASLErrorString() Get the SASL error as String.
java.lang.String	toString()
XmlStringBuilder	toXML(XmlEnvironment enclosingNamespace)

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

addDescriptiveTextsAndExtensions, getDescriptiveText, getDescriptiveText, getExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jivesoftware.smack.sasl.packet.SaslNonza

getNamespace

Methods inherited from interface org.jivesoftware.smack.packet.FullyQualifiedElement

getLanguage, getQName

Methods inherited from interface org.jivesoftware.smack.packet.Element

toXML, toXML

Field Detail

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

QNAME

public static final javax.xml.namespace.QName QNAME

Constructor Detail

SASLFailure

public SASLFailure(java.lang.String saslError)

SASLFailure

public 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()

Get the SASL error as String.

Returns:

the SASL error as String

toXML

public XmlStringBuilder toXML(XmlEnvironment enclosingNamespace)

Specified by:

toXML in interface Element

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getElementName

public java.lang.String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.