rocks.xmpp.extensions.compress

Class CompressionManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.stream.client.ClientStreamFeatureNegotiator<CompressionFeature>

rocks.xmpp.extensions.compress.CompressionManager

All Implemented Interfaces:

StreamFeatureNegotiator<CompressionFeature>

public final class CompressionManager
extends ClientStreamFeatureNegotiator<CompressionFeature>

Manages stream compression as described in XEP-0138: Stream Compression.

1. Introduction

XMPP Core [1] specifies the use of Transport Layer Security (TLS; see RFC 5246 [2]) for encryption of XML streams, and TLS includes the ability to compress encrypted traffic (see RFC 3749 [3]). However, not all computing platforms are able to implement TLS, and traffic compression may be desirable for communication by applications on such computing platforms. This document defines a mechanism for negotiating the compression of XML streams outside the context of TLS.

If you enable this manager, stream compression will be used, if available. Note that stream compression should not be used, when you use TLS.

Constructor Summary

Constructors

Constructor and Description
CompressionManager(XmppSession xmppSession, TcpBinding tcpBinding)

Method Summary

Modifier and Type	Method and Description
boolean	canProcess(java.lang.Object element)
java.util.List<CompressionMethod>	getConfiguredCompressionMethods() Gets the configured compression methods.
CompressionMethod	getNegotiatedCompressionMethod() Gets the negotiated compression method.
StreamNegotiationResult	processNegotiation(java.lang.Object element)

Methods inherited from class rocks.xmpp.core.stream.client.ClientStreamFeatureNegotiator

getFeatureClass

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

Constructor Detail

CompressionManager

public CompressionManager(XmppSession xmppSession,
                          TcpBinding tcpBinding)

Method Detail

processNegotiation

public final StreamNegotiationResult processNegotiation(java.lang.Object element)
                                                 throws StreamNegotiationException

Throws:

StreamNegotiationException

canProcess

public final boolean canProcess(java.lang.Object element)

getNegotiatedCompressionMethod

public final CompressionMethod getNegotiatedCompressionMethod()

Gets the negotiated compression method.

Returns:

The negotiated compression method.

getConfiguredCompressionMethods

public final java.util.List<CompressionMethod> getConfiguredCompressionMethods()

Gets the configured compression methods.

Returns:

The configured compression method.