tigase.jaxmpp.core.client.xmpp.modules.streammng

Class StreamManagementModule

java.lang.Object

tigase.jaxmpp.core.client.xmpp.modules.streammng.StreamManagementModule

All Implemented Interfaces:

ObservableAware, XmppModule

public class StreamManagementModule
extends Object
implements XmppModule, ObservableAware

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamManagementModule.AbstractStreamManagementEvent
static class	StreamManagementModule.StreamManagementEnabledEvent
static class	StreamManagementModule.StreamManagementFailedEvent
static class	StreamManagementModule.StreamResumedEvent
static class	StreamManagementModule.UnacknowledgedEvent

Field Summary

Fields

Modifier and Type	Field and Description
static String	INCOMING_STREAM_H_KEY
protected Logger	log
static String	OUTGOING_STREAM_H_KEY
static String	STREAM_MANAGEMENT_DISABLED_KEY Property to disable stream management module.
static String	STREAM_MANAGEMENT_RESUME_KEY
static String	STREAM_MANAGEMENT_RESUMPTION_ID_KEY
static String	STREAM_MANAGEMENT_RESUMPTION_TIME_KEY
static String	STREAM_MANAGEMENT_TURNED_ON_KEY Property to keep Boolean if stream management is turned on.
static EventType	StreamManagementEnabled
static EventType	StreamManagementFailed
static EventType	StreamResumed
static EventType	Unacknowledged
static String	XMLNS

Constructor Summary

Constructors

Constructor and Description
StreamManagementModule(JaxmppCore jaxmpp, SessionObject sessionObject, PacketWriter writer)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(EventType eventType, Listener<? extends BaseEvent> listener) Adds a listener bound by the given event type.
void	addListener(Listener<? extends BaseEvent> listener) Add a listener bound by the all event types.
void	enable() Client enables stream management.
Criteria	getCriteria() Criteria
String[]	getFeatures() Returns features what are implemented by Module.
static long	getResumptionTime(SessionObject sessionObject, long defaultValue)
static boolean	isAckEnabled(SessionObject sessionObject)
static boolean	isResumptionEnabled(SessionObject sessionObject)
static boolean	isStreamManagementAvailable(SessionObject sessionObject)
static boolean	isStreamManagementTurnedOn(SessionObject sessionObject)
void	process(Element element) Main method of module.
boolean	processIncomingStanza(Element element)
void	processOutgoingElement(Element element)
void	removeAllListeners() Removes all listeners.
void	removeListener(EventType eventType, Listener<? extends BaseEvent> listener) Removes a listener.
void	removeListener(Listener<? extends BaseEvent> listener) Removes a listener.
void	request() Request acknowledgement of received stanzas.
static void	reset(AbstractSessionObject sessionObject)
void	resume()
void	setObservable(Observable observable) Set the new instance of Observable.

Methods inherited from class java.lang.Object

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

Field Detail

INCOMING_STREAM_H_KEY

public static final String INCOMING_STREAM_H_KEY

See Also:

Constant Field Values

OUTGOING_STREAM_H_KEY

public static final String OUTGOING_STREAM_H_KEY

See Also:

Constant Field Values

STREAM_MANAGEMENT_DISABLED_KEY

public static final String STREAM_MANAGEMENT_DISABLED_KEY

Property to disable stream management module.

See Also:

Constant Field Values

STREAM_MANAGEMENT_RESUME_KEY

public static final String STREAM_MANAGEMENT_RESUME_KEY

See Also:

Constant Field Values

STREAM_MANAGEMENT_RESUMPTION_ID_KEY

public static final String STREAM_MANAGEMENT_RESUMPTION_ID_KEY

See Also:

Constant Field Values

STREAM_MANAGEMENT_RESUMPTION_TIME_KEY

public static final String STREAM_MANAGEMENT_RESUMPTION_TIME_KEY

See Also:

Constant Field Values

STREAM_MANAGEMENT_TURNED_ON_KEY

public static final String STREAM_MANAGEMENT_TURNED_ON_KEY

Property to keep Boolean if stream management is turned on.

See Also:

Constant Field Values

StreamManagementEnabled

public static final EventType StreamManagementEnabled

StreamManagementFailed

public static final EventType StreamManagementFailed

StreamResumed

public static final EventType StreamResumed

Unacknowledged

public static final EventType Unacknowledged

XMLNS

public static final String XMLNS

See Also:

Constant Field Values

log

protected final Logger log

Constructor Detail

StreamManagementModule

public StreamManagementModule(JaxmppCore jaxmpp,
                      SessionObject sessionObject,
                      PacketWriter writer)

Method Detail

getResumptionTime

public static long getResumptionTime(SessionObject sessionObject,
                     long defaultValue)

isAckEnabled

public static boolean isAckEnabled(SessionObject sessionObject)

isResumptionEnabled

public static boolean isResumptionEnabled(SessionObject sessionObject)

isStreamManagementAvailable

public static boolean isStreamManagementAvailable(SessionObject sessionObject)
                                           throws JaxmppException

Throws:

JaxmppException

isStreamManagementTurnedOn

public static boolean isStreamManagementTurnedOn(SessionObject sessionObject)

reset

public static void reset(AbstractSessionObject sessionObject)

addListener

public void addListener(EventType eventType,
               Listener<? extends BaseEvent> listener)

Adds a listener bound by the given event type.

Parameters:

eventType - type of event

listener - the listener

addListener

public void addListener(Listener<? extends BaseEvent> listener)

Add a listener bound by the all event types.

Parameters:

listener - the listener

enable

public void enable()
            throws JaxmppException

Client enables stream management.

Throws:

JaxmppException

getCriteria

public Criteria getCriteria()

Description copied from interface: XmppModule

Criteria

Specified by:

getCriteria in interface XmppModule

Returns:

getFeatures

public String[] getFeatures()

Description copied from interface: XmppModule

Returns features what are implemented by Module.

See Service Discovery Features

Specified by:

getFeatures in interface XmppModule

Returns:

array of features

process

public void process(Element element)
             throws XMPPException,
                    XMLException,
                    JaxmppException

Description copied from interface: XmppModule

Main method of module. Module will process incoming stanza by call this method.

Specified by:

process in interface XmppModule

Parameters:

element - incoming XMPP stanza

Throws:

XMPPException

XMLException

JaxmppException

processIncomingStanza

public boolean processIncomingStanza(Element element)
                              throws XMLException

Throws:

XMLException

processOutgoingElement

public void processOutgoingElement(Element element)
                            throws JaxmppException

Throws:

JaxmppException

removeAllListeners

public void removeAllListeners()

Removes all listeners.

removeListener

public void removeListener(EventType eventType,
                  Listener<? extends BaseEvent> listener)

Removes a listener.

Parameters:

eventType - type of event

listener - listener

removeListener

public void removeListener(Listener<? extends BaseEvent> listener)

Removes a listener.

Parameters:

listener - listener

request

public void request()
             throws JaxmppException

Request acknowledgement of received stanzas.

Throws:

JaxmppException

resume

public void resume()
            throws JaxmppException

Throws:

JaxmppException

setObservable

public void setObservable(Observable observable)

Description copied from interface: ObservableAware

Set the new instance of Observable.

Specified by:

setObservable in interface ObservableAware

Parameters:

observable - new instance of Observable