rocks.xmpp.extensions.sm

Class StreamManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.stream.StreamFeatureNegotiator

rocks.xmpp.extensions.sm.StreamManager

public final class StreamManager
extends StreamFeatureNegotiator

Manages the stream as described in XEP-0198: Stream Management.

This class enables stream management during stream negotiation, if the stream management feature has been enabled before login:

 
 xmppSession.enableFeature(StreamManagement.NAMESPACE);
 
 

See Also:

XEP-0198: Stream Management

Nested Class Summary

Nested classes/interfaces inherited from class rocks.xmpp.core.stream.StreamFeatureNegotiator

StreamFeatureNegotiator.Status

Method Summary

Modifier and Type	Method and Description
boolean	canProcess(Object element) Checks, whether the element can be processed by the feature negotiator.
Predicate<Stanza>	getRequestStrategy() Gets the request strategy.
String	getStreamManagementId() Gets the "SM-ID".
void	incrementInboundStanzaCount() Increments the inbound stanza count.
boolean	isActive() Returns true, as soon as the server has enabled stream management, i.e. if both client and server are using stream management.
boolean	isResumable() If the server will allow the stream to be resumed.
void	markUnacknowledged(Stanza stanza) Marks a stanza as unacknowledged.
StreamFeatureNegotiator.Status	processNegotiation(Object element) Processes a feature protocol element or the feature element itself.
void	reset() Resets any client enabled state.
AsyncResult<Boolean>	resume() Resumes the stream.
void	setRequestStrategy(Predicate<Stanza> requestStrategy) Sets the request strategy.

Methods inherited from class rocks.xmpp.core.stream.StreamFeatureNegotiator

addFeatureListener, getFeatureClass, needsRestart

Methods inherited from class rocks.xmpp.core.session.Manager

isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Method Detail

processNegotiation

public final StreamFeatureNegotiator.Status processNegotiation(Object element)
                                                        throws StreamNegotiationException

Description copied from class: StreamFeatureNegotiator

Processes a feature protocol element or the feature element itself.

Specified by:

processNegotiation in class StreamFeatureNegotiator

Parameters:

element - The XML element, which belongs to the feature negotiation, e.g. <challenge/> for SASL negotiation or the feature element itself, e.g. <mechanisms/>.

Returns:

The status of the feature negotiation.

Throws:

StreamNegotiationException - Any exception which might be thrown during a feature negotiation. Note that any exception thrown during the feature negotiation process is thrown by the XmppSession.connect() method and therefore will abort the connection process.

canProcess

public final boolean canProcess(Object element)

Description copied from class: StreamFeatureNegotiator

Checks, whether the element can be processed by the feature negotiator.

Specified by:

canProcess in class StreamFeatureNegotiator

Parameters:

element - The feature protocol element, e.g. <challenge/>. The element is never the feature element itself, e.g. <mechanisms/>, which is advertised in the <stream:features/> element.

Returns:

True, if the element can be processed by the feature negotiator.

incrementInboundStanzaCount

public final void incrementInboundStanzaCount()

Increments the inbound stanza count.

markUnacknowledged

public void markUnacknowledged(Stanza stanza)

Marks a stanza as unacknowledged.

Parameters:

stanza - The stanza.

getRequestStrategy

public final Predicate<Stanza> getRequestStrategy()

Gets the request strategy.

Returns:

The request strategy.

See Also:

RequestStrategies

setRequestStrategy

public final void setRequestStrategy(Predicate<Stanza> requestStrategy)

Sets the request strategy.

Parameters:

requestStrategy - The request strategy.

See Also:

RequestStrategies

isActive

public final boolean isActive()

Returns true, as soon as the server has enabled stream management, i.e. if both client and server are using stream management.

Returns:

True, as soon as the server has enabled stream management.

isResumable

public final boolean isResumable()

If the server will allow the stream to be resumed.

Returns:

If the server will allow the stream to be resumed.

getStreamManagementId

public final String getStreamManagementId()

Gets the "SM-ID".

The 'id' attribute defines a unique identifier for purposes of stream management (an "SM-ID"). The SM-ID MUST be generated by the server. The client MUST consider the SM-ID to be opaque and therefore MUST NOT assign any semantic meaning to the SM-ID.

Returns:

The "SM-ID".

reset

public void reset()

Resets any client enabled state.

resume

public AsyncResult<Boolean> resume()

Resumes the stream.

Returns:

The async result, which is done, if either the stream is not resumable, or the server resumed the stream.

See Also:

5. Resumption