StreamContext (Stringflow Java SDK 2.0.0 API)

java.lang.Object
- abs.ixi.client.xmpp.StreamContext

All Implemented Interfaces:

Resetable
```
public final class StreamContext
extends Object
implements Resetable
```
StreamContext captures state of the ongoing XMPP stream state. It contains all the vital attributes of the XMPP stream such as stream state, negotiated features, security, id, language, charset and version.
This implementation is thread-safe.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_RESUMPTION_TIME` Streams which have stream management enabled can be resumed.
`static String`	`STREAM_LANG` Default language for the stream; it's English
`static String`	`STREAM_VERSION` Default value of the XMPP stream version a
`static String`	`UTF8` XMPP protocol uses UTF-8 character encoding

Constructor Summary

Constructors
Constructor and Description
`StreamContext()` Default constructor which enables stream management and max resumption time is set to `MAX_RESUMPTION_TIME`
`StreamContext(boolean smSupported, int maxResumptionTime)` Instantiate StreamContext with given max stream resumption time (in secs) and a flag to indicate of the stream management is supported

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`enableStreamManagement(boolean isResumeable, int maxResumptionTimeInMillis)`
`int`	`getAckReceivedCount()`
`String`	`getEncoding()`
`int`	`getHandledStanzaCount()`
`String`	`getLang()`
`int`	`getMaxResumptionTimeInSecs()`
`SASLFeature.SASLMechanism`	`getSaslMechanism()`
`StreamState`	`getState()`
`String`	`getStreamId()`
`String`	`getVersion()`
`void`	`increaseHandledStanzaCount()`
`boolean`	`isReadyForUsePackets()` Check if this stream is ready for sending/receiving user packets.
`boolean`	`isResumable()`
`boolean`	`isSmEnabled()`
`boolean`	`isSMSupported()`
`void`	`reset(boolean full)` Flushes out data, repositions counters and markers held by this object
`void`	`setAckReceivedCount(int ackReceivedCount)`
`void`	`setEncoding(String encoding)`
`void`	`setHandledStanzaCount(int handledStanzaCount)`
`void`	`setLang(String lang)`
`void`	`setMaxResumptionTimeInSecs(int maxResumptionTimeInSecs)`
`void`	`setResumable(boolean resumable)`
`void`	`setSaslMechanism(SASLFeature.SASLMechanism saslMechanism)`
`void`	`setSmEnabled(boolean smEnabled)`
`void`	`setSMSupported(boolean isSMSupported)`
`void`	`setState(StreamState state)`
`void`	`setStreamId(String streamId)`
`void`	`setStreamState(Packet packet)`
`void`	`setVersion(String version)`

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

- Field Detail
  - UTF8
```
public static final String UTF8
```
    XMPP protocol uses UTF-8 character encoding
    
    See Also:
    
    Constant Field Values
  - STREAM_LANG
```
public static final String STREAM_LANG
```
    Default language for the stream; it's English
    
    See Also:
    
    Constant Field Values
  - STREAM_VERSION
```
public static final String STREAM_VERSION
```
    Default value of the XMPP stream version a
    
    See Also:
    
    Constant Field Values
  - MAX_RESUMPTION_TIME
```
public static final int MAX_RESUMPTION_TIME
```
    Streams which have stream management enabled can be resumed. However stream resumption is possible, if the request for resumption is made within a time limit i.e. max resumption time. Maximum resumption time is negotiated between server and client. Below value is the default time that SDK uses, if the application has not specified.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StreamContext
```
public StreamContext()
```
    Default constructor which enables stream management and max resumption time is set to MAX_RESUMPTION_TIME
  - StreamContext
```
public StreamContext(boolean smSupported,
                     int maxResumptionTime)
```
    Instantiate StreamContext with given max stream resumption time (in secs) and a flag to indicate of the stream management is supported
    
    Parameters:
    
    smSupported - flag to indicate if stream management is supported
    
    maxResumptionTime - max resumtpion time in seconds
- Method Detail
  - getStreamId
```
public String getStreamId()
```
  - setStreamId
```
public void setStreamId(String streamId)
```
  - getState
```
public StreamState getState()
```
  - setState
```
public void setState(StreamState state)
```
  - getSaslMechanism
```
public SASLFeature.SASLMechanism getSaslMechanism()
```
  - setSaslMechanism
```
public void setSaslMechanism(SASLFeature.SASLMechanism saslMechanism)
```
  - getEncoding
```
public String getEncoding()
```
  - setEncoding
```
public void setEncoding(String encoding)
```
  - getVersion
```
public String getVersion()
```
  - setVersion
```
public void setVersion(String version)
```
  - getLang
```
public String getLang()
```
  - setLang
```
public void setLang(String lang)
```
  - isSMSupported
```
public boolean isSMSupported()
```
  - setSMSupported
```
public void setSMSupported(boolean isSMSupported)
```
  - isSmEnabled
```
public boolean isSmEnabled()
```
  - setSmEnabled
```
public void setSmEnabled(boolean smEnabled)
```
  - isResumable
```
public boolean isResumable()
```
  - setResumable
```
public void setResumable(boolean resumable)
```
  - increaseHandledStanzaCount
```
public void increaseHandledStanzaCount()
```
  - getHandledStanzaCount
```
public int getHandledStanzaCount()
```
  - setHandledStanzaCount
```
public void setHandledStanzaCount(int handledStanzaCount)
```
  - getAckReceivedCount
```
public int getAckReceivedCount()
```
  - setAckReceivedCount
```
public void setAckReceivedCount(int ackReceivedCount)
```
  - setStreamState
```
public void setStreamState(Packet packet)
```
  - getMaxResumptionTimeInSecs
```
public int getMaxResumptionTimeInSecs()
```
  - setMaxResumptionTimeInSecs
```
public void setMaxResumptionTimeInSecs(int maxResumptionTimeInSecs)
```
  - enableStreamManagement
```
public void enableStreamManagement(boolean isResumeable,
                                   int maxResumptionTimeInMillis)
```
  - reset
```
public void reset(boolean full)
```
    Description copied from interface: Resetable
    
    Flushes out data, repositions counters and markers held by this object
    
    Specified by:
    
    reset in interface Resetable
    
    Parameters:
    
    full - true oe false
  - isReadyForUsePackets
```
public boolean isReadyForUsePackets()
```
    Check if this stream is ready for sending/receiving user packets. While stream is getting negotiated, it is NOT ready for sending/receiving user packets.
    
    Returns:
    
    true if the stream is ready to send/receive user packets otherwise false

Class StreamContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UTF8

STREAM_LANG

STREAM_VERSION

MAX_RESUMPTION_TIME

Constructor Detail

StreamContext

StreamContext

Method Detail

getStreamId

setStreamId

getState

setState

getSaslMechanism

setSaslMechanism

getEncoding

setEncoding

getVersion

setVersion

getLang

setLang

isSMSupported

setSMSupported

isSmEnabled

setSmEnabled

isResumable

setResumable

increaseHandledStanzaCount

getHandledStanzaCount

setHandledStanzaCount

getAckReceivedCount

setAckReceivedCount

setStreamState

getMaxResumptionTimeInSecs

setMaxResumptionTimeInSecs

enableStreamManagement

reset

isReadyForUsePackets