org.jivesoftware.smack.sasl.packet

Class SaslStreamElements.SASLFailure

java.lang.Object

org.jivesoftware.smack.packet.AbstractError

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

All Implemented Interfaces:

Element, ExtensionElement, NamedElement, Nonza, TopLevelStreamElement

Enclosing class:

SaslStreamElements

public static class SaslStreamElements.SASLFailure
extends AbstractError
implements Nonza

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>>

Field Summary

Fields

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

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

descriptiveTexts, extensions, textNamespace

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.
java.lang.String	getNamespace() Returns the root element XML namespace.
SASLError	getSASLError() Get the SASL related error condition.
java.lang.String	getSASLErrorString() Get the SASL error as String.
java.lang.String	toString()
XmlStringBuilder	toXML(java.lang.String enclosingNamespace) Returns the XML representation of this Element.

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

Field Detail

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

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(java.lang.String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getNamespace

public java.lang.String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

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.