StreamManagement.Enabled

java.lang.Object

org.jivesoftware.smack.sm.packet.StreamManagement.Enabled

All Implemented Interfaces:: Element, NamedElement, Nonza, TopLevelStreamElement, XmlElement, XmlLangElement

Enclosing class:: StreamManagement

public static class StreamManagement.Enabled extends Object

A Stream Management 'enabled' element.

Here is a full example, all attributes besides 'xmlns' are optional.

 
 <enabled xmlns='urn:xmpp:sm:3'
      id='some-long-sm-id'
      location='[2001:41D0:1:A49b::1]:9222'
      resume='true'/>

Field Summary

Fields

Modifier and Type

Field

Description

static final String

ELEMENT

protected int

max

Preferred maximum resumption time in seconds (optional).

protected boolean

resume
Constructor Summary

Constructors

Constructor

Description

Enabled(String id, boolean resume)

Enabled(String id, boolean resume, String location, int max)
Method Summary

Modifier and Type

Method

Description

String

getElementName()

Returns the root element name.

String

getId()

String

getLocation()

int

getMaxResumptionTime()

Return the max resumption time in seconds.

final String

getNamespace()

Returns the root element XML namespace.

boolean

isResumeSet()

protected void

maybeAddMaxAttributeTo(XmlStringBuilder xml)

protected void

maybeAddResumeAttributeTo(XmlStringBuilder xml)

CharSequence

toXML(XmlEnvironment enclosingNamespace)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Methods inherited from interface org.jivesoftware.smack.packet.XmlElement
getLanguage, getQName

Field Details
- ELEMENT
  
  public static final String ELEMENT
  See Also:
  
  Constant Field Values
- max
  
  protected int max
  
  Preferred maximum resumption time in seconds (optional).
- resume
  
  protected boolean resume
Constructor Details
- Enabled
  
  public Enabled(String id, boolean resume)
- Enabled
  
  public Enabled(String id, boolean resume, String location, int max)
Method Details
- getId
  
  public String getId()
- getLocation
  
  public String getLocation()
- toXML
  
  public CharSequence toXML(XmlEnvironment enclosingNamespace)
- getElementName
  
  public String getElementName()
  
  Description copied from interface: NamedElement
  
  Returns the root element name.
  
  Returns:
  
  the element name.
- maybeAddResumeAttributeTo
  
  protected void maybeAddResumeAttributeTo(XmlStringBuilder xml)
- maybeAddMaxAttributeTo
  
  protected void maybeAddMaxAttributeTo(XmlStringBuilder xml)
- isResumeSet
  
  public boolean isResumeSet()
- getMaxResumptionTime
  
  public int getMaxResumptionTime()
  
  Return the max resumption time in seconds.
  
  Returns:
  
  the max resumption time in seconds
- getNamespace
  
  public final String getNamespace()
  
  Description copied from interface: XmlElement
  
  Returns the root element XML namespace.
  
  Specified by:
  
  getNamespace in interface XmlElement
  
  Returns:
  
  the namespace.