rocks.xmpp.core.tls

Class SecurityManager

java.lang.Object

rocks.xmpp.core.stream.StreamFeatureNegotiator

rocks.xmpp.core.tls.SecurityManager

public final class SecurityManager
extends StreamFeatureNegotiator

Negotiates transport layer security during stream negotiation.

Author:

Christian Schudt

See Also:

STARTTLS Negotiation

Nested Class Summary

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

StreamFeatureNegotiator.Status

Constructor Summary

Constructors

Constructor and Description
SecurityManager(XmppSession xmppSession, StreamFeatureListener streamFeatureListener, boolean isSecure)

Method Summary

Modifier and Type	Method and Description
boolean	canProcess(Object element) Checks, whether the element can be processed by the feature negotiator.
boolean	needsRestart() Checks, if the feature needs a stream restart after it has been successfully negotiated.
StreamFeatureNegotiator.Status	processNegotiation(Object element) Processes a feature protocol element or the feature element itself.

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

addFeatureListener, getFeatureClass, notifyFeatureNegotiated, removeFeatureListener

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityManager

public SecurityManager(XmppSession xmppSession,
                       StreamFeatureListener streamFeatureListener,
                       boolean isSecure)

Method Detail

processNegotiation

public StreamFeatureNegotiator.Status processNegotiation(Object element)
                                                  throws Exception

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:

Exception - 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()

Description copied from class: StreamFeatureNegotiator

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.

Overrides:

needsRestart in class StreamFeatureNegotiator

Returns:

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

canProcess

public 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.