org.jivesoftware.smack

Class XMPPException.XMPPErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.jivesoftware.smack.XMPPException

org.jivesoftware.smack.XMPPException.XMPPErrorException

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

XMPPException

public static class XMPPException.XMPPErrorException
extends XMPPException

An exception caused by an XMPP error stanza response on the protocol level. You can examine the underlying StanzaError by calling getStanzaError().

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jivesoftware.smack.XMPPException

XMPPException.FailedNonzaException, XMPPException.StreamErrorException, XMPPException.XMPPErrorException

Constructor Summary

Constructors

Constructor and Description
XMPPErrorException(StanzaError.Builder xmppErrorBuilder) Deprecated. Use #XMPPErrorException(Stanza, StanzaError) instead.
XMPPErrorException(Stanza stanza, StanzaError error) Creates a new XMPPErrorException with the XMPPError that was the root case of the exception.
XMPPErrorException(Stanza stanza, StanzaError error, Stanza request) Creates a new XMPPErrorException with the XMPPError that was the root case of the exception.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage()
Stanza	getRequest() Get the request which triggered the error response causing this exception.
StanzaError	getStanzaError() Returns the stanza error extension element associated with this exception.
StanzaError	getXMPPError() Deprecated. use getStanzaError() instead.
static void	ifHasErrorThenThrow(Stanza packet)
static void	ifHasErrorThenThrow(Stanza packet, Stanza request)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XMPPErrorException

@Deprecated
public XMPPErrorException(StanzaError.Builder xmppErrorBuilder)

Deprecated. Use #XMPPErrorException(Stanza, StanzaError) instead.

Creates a new XMPPErrorException with the given builder.

Parameters:

xmppErrorBuilder -

XMPPErrorException

public XMPPErrorException(Stanza stanza,
                          StanzaError error)

Creates a new XMPPErrorException with the XMPPError that was the root case of the exception.

Parameters:

stanza - stanza that contained the exception.

error - the root cause of the exception.

XMPPErrorException

public XMPPErrorException(Stanza stanza,
                          StanzaError error,
                          Stanza request)

Creates a new XMPPErrorException with the XMPPError that was the root case of the exception.

Parameters:

request - the request which triggered the error.

stanza - stanza that contained the exception.

error - the root cause of the exception.

Since:

4.3.0

Method Detail

getXMPPError

@Deprecated
public StanzaError getXMPPError()

Deprecated. use getStanzaError() instead.

Returns the XMPPError associated with this exception, or null if there isn't one.

Returns:

the XMPPError associated with this exception.

getStanzaError

public StanzaError getStanzaError()

Returns the stanza error extension element associated with this exception.

Returns:

the stanza error extension element associated with this exception.

getRequest

public Stanza getRequest()

Get the request which triggered the error response causing this exception.

Returns:

the request or null.

Since:

4.3.0

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

ifHasErrorThenThrow

public static void ifHasErrorThenThrow(Stanza packet)
                                throws XMPPException.XMPPErrorException

Throws:

XMPPException.XMPPErrorException

ifHasErrorThenThrow

public static void ifHasErrorThenThrow(Stanza packet,
                                       Stanza request)
                                throws XMPPException.XMPPErrorException

Throws:

XMPPException.XMPPErrorException