rocks.xmpp.core.stream

Class StreamFeatureNegotiator

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.stream.StreamFeatureNegotiator

Direct Known Subclasses:

CompressionManager

public abstract class StreamFeatureNegotiator
extends Manager

A base class to negotiate features.

Classes which extend from this class are responsible to negotiate a single feature.

Feature negotiators are registered with the StreamFeaturesManager.addFeatureNegotiator(StreamFeatureNegotiator) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamFeatureNegotiator.Status Represents the status of the feature negotiation.

Constructor Summary

Constructors

Constructor and Description
StreamFeatureNegotiator(XmppSession xmppSession, Class<? extends StreamFeature> featureClass) Constructs a feature negotiator.

Method Summary

Modifier and Type	Method and Description
void	addFeatureListener(StreamFeatureListener streamFeatureListener) Adds a feature listener, which will get notified about feature negotiation status changes.
abstract boolean	canProcess(Object element) Checks, whether the element can be processed by the feature negotiator.
Class<? extends StreamFeature>	getFeatureClass() Gets the feature class, this negotiator is responsible for.
boolean	needsRestart() Checks, if the feature needs a stream restart after it has been successfully negotiated.
abstract StreamFeatureNegotiator.Status	processNegotiation(Object element) Processes a feature protocol element or the feature element itself.

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

StreamFeatureNegotiator

public StreamFeatureNegotiator(XmppSession xmppSession,
                               Class<? extends StreamFeature> featureClass)

Constructs a feature negotiator.

Parameters:

xmppSession - The XMPP session.

featureClass - The feature class, which represents the feature, which will be negotiated.

Method Detail

addFeatureListener

public final void addFeatureListener(StreamFeatureListener streamFeatureListener)

Adds a feature listener, which will get notified about feature negotiation status changes.

Parameters:

streamFeatureListener - The feature listener.

processNegotiation

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

Processes a feature protocol element or the feature element itself.

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.

needsRestart

public boolean needsRestart()

Checks, if the feature needs a stream restart after it has been successfully negotiated. Override this method (returning true), if the feature requires a stream restart after negotiation.

By default this method returns false.

Returns:

True, if the stream requires a restart after feature negotiation.

canProcess

public abstract boolean canProcess(Object element)

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

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.

getFeatureClass

public final Class<? extends StreamFeature> getFeatureClass()

Gets the feature class, this negotiator is responsible for.

Returns:

The feature class.