StanzaError (Smack 4.3.0 API)

java.lang.Object
- org.jivesoftware.smack.packet.AbstractError
- - org.jivesoftware.smack.packet.StanzaError

All Implemented Interfaces:: Element, ExtensionElement, NamedElement

public class StanzaError
extends AbstractError
implements ExtensionElement

Represents an XMPP error sub-packet. Typically, a server responds to a request that has problems by sending the stanza back and including an error packet. Each error has a type, error condition as well as as an optional text explanation. Typical errors are:

XMPP Errors
XMPP Error Condition	Type	RFC 6120 Section
bad-request	MODIFY	8.3.3.1
conflict	CANCEL	8.3.3.2
feature-not-implemented	CANCEL	8.3.3.3
forbidden	AUTH	8.3.3.4
gone	CANCEL	8.3.3.5
internal-server-error	WAIT	8.3.3.6
item-not-found	CANCEL	8.3.3.7
jid-malformed	MODIFY	8.3.3.8
not-acceptable	MODIFY	8.3.3.9
not-allowed	CANCEL	8.3.3.10
not-authorized	AUTH	8.3.3.11
policy-violation	MODIFY	8.3.3.12
recipient-unavailable	WAIT	8.3.3.13
redirect	MODIFY	8.3.3.14
registration-required	AUTH	8.3.3.15
remote-server-not-found	CANCEL	8.3.3.16
remote-server-timeout	WAIT	8.3.3.17
resource-constraint	WAIT	8.3.3.18
service-unavailable	CANCEL	8.3.3.19
subscription-required	AUTH	8.3.3.20
undefined-condition	MODIFY	8.3.3.21
unexpected-request	WAIT	8.3.3.22

See Also:: RFC 6120 - 8.3.2 Syntax: The Syntax of XMPP error stanzas

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StanzaError.Builder`
`static class`	`StanzaError.Condition`
`static class`	`StanzaError.Type` A class to represent the type of the Error.

Field Summary

Fields
Modifier and Type Field and Description

static String ERROR

static String ERROR_CONDITION_AND_TEXT_NAMESPACE

static String NAMESPACE
Deprecated.
- Fields inherited from class org.jivesoftware.smack.packet.AbstractError
  descriptiveTexts, extensions, textNamespace

Fields
Modifier and Type	Field and Description
`static String`	`ERROR`
`static String`	`ERROR_CONDITION_AND_TEXT_NAMESPACE`
`static String`	`NAMESPACE` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`StanzaError(StanzaError.Condition condition, String conditionText, String errorGenerator, StanzaError.Type type, Map<String,String> descriptiveTexts, List<ExtensionElement> extensions, Stanza stanza)` Creates a new error with the specified type, condition and message.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StanzaError.Builder`	`from(StanzaError.Condition condition, String descriptiveText)`
`static StanzaError.Builder`	`getBuilder()`
`static StanzaError.Builder`	`getBuilder(StanzaError.Condition condition)`
`static StanzaError.Builder`	`getBuilder(StanzaError xmppError)`
`StanzaError.Condition`	`getCondition()` Returns the error condition.
`String`	`getConditionText()`
`String`	`getElementName()` Returns the root element name.
`String`	`getErrorGenerator()`
`String`	`getNamespace()` Returns the root element XML namespace.
`Stanza`	`getStanza()` Get the stanza carrying the XMPP error.
`StanzaError.Type`	`getType()` Returns the error type.
`String`	`toString()`
`XmlStringBuilder`	`toXML()` Returns the error as XML.
`XmlStringBuilder`	`toXML(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
  - ERROR_CONDITION_AND_TEXT_NAMESPACE
```
public static final String ERROR_CONDITION_AND_TEXT_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - NAMESPACE
```
@Deprecated
public static final String NAMESPACE
```
    Deprecated.
    
    TODO describe me.
    
    See Also:
    
    Constant Field Values
  - ERROR
```
public static final String ERROR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StanzaError
```
public StanzaError(StanzaError.Condition condition,
                   String conditionText,
                   String errorGenerator,
                   StanzaError.Type type,
                   Map<String,String> descriptiveTexts,
                   List<ExtensionElement> extensions,
                   Stanza stanza)
```
    Creates a new error with the specified type, condition and message. This constructor is used when the condition is not recognized automatically by XMPPError i.e. there is not a defined instance of ErrorCondition or it does not apply the default specification.
    
    Parameters:
    
    type - the error type.
    
    condition - the error condition.
    
    conditionText -
    
    errorGenerator -
    
    descriptiveTexts -
    
    extensions - list of stanza extensions
    
    stanza - the stanza carrying this XMPP error.
- Method Detail
  - getCondition
```
public StanzaError.Condition getCondition()
```
    Returns the error condition.
    
    Returns:
    
    the error condition.
  - getType
```
public StanzaError.Type getType()
```
    Returns the error type.
    
    Returns:
    
    the error type.
  - getErrorGenerator
```
public String getErrorGenerator()
```
  - getConditionText
```
public String getConditionText()
```
  - getStanza
```
public Stanza getStanza()
```
    Get the stanza carrying the XMPP error.
    
    Returns:
    
    the stanza carrying the XMPP error.
    
    Since:
    
    4.2
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getElementName
```
public String getElementName()
```
    Description copied from interface: NamedElement
    
    Returns the root element name.
    
    Specified by:
    
    getElementName in interface NamedElement
    
    Returns:
    
    the element name.
  - getNamespace
```
public String getNamespace()
```
    Description copied from interface: ExtensionElement
    
    Returns the root element XML namespace.
    
    Specified by:
    
    getNamespace in interface ExtensionElement
    
    Returns:
    
    the namespace.
  - toXML
```
public XmlStringBuilder toXML()
```
    Returns the error as XML.
    
    Returns:
    
    the error as XML.
  - toXML
```
public XmlStringBuilder toXML(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.
  - from
```
public static StanzaError.Builder from(StanzaError.Condition condition,
                                       String descriptiveText)
```
  - getBuilder
```
public static StanzaError.Builder getBuilder()
```
  - getBuilder
```
public static StanzaError.Builder getBuilder(StanzaError.Condition condition)
```
  - getBuilder
```
public static StanzaError.Builder getBuilder(StanzaError xmppError)
```

Class StanzaError

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

ERROR_CONDITION_AND_TEXT_NAMESPACE

NAMESPACE

ERROR

Constructor Detail

StanzaError

Method Detail

getCondition

getType

getErrorGenerator

getConditionText

getStanza

toString

getElementName

getNamespace

toXML

toXML

from

getBuilder

getBuilder

getBuilder