tigase.jaxmpp.core.client.xmpp.modules.auth

Class AuthModule

java.lang.Object

tigase.jaxmpp.core.client.xmpp.modules.auth.AuthModule

All Implemented Interfaces:

XmppModule

public class AuthModule
extends Object
implements XmppModule

Module used for authentication. This module automatically selects better authentication module to use. Currently it choose between SaslModule and NonSaslAuthModule.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthModule.AuthEvent
static class	AuthModule.DefaultCredentialsCallback

Field Summary

Fields

Modifier and Type	Field and Description
static EventType	AuthFailed
static String	AUTHORIZED
static EventType	AuthStart
static EventType	AuthSuccess
static String	CREDENTIALS_CALLBACK
static String	FORCE_NON_SASL If true then Non-SASL (XEP-0078) mechanism is used. Type: Boolean

Constructor Summary

Constructors

Constructor and Description
AuthModule(Observable parentObservable, SessionObject sessionObject, XmppModulesManager modulesManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(EventType eventType, Listener<? extends BaseEvent> listener)
void	addListener(Listener<? extends BaseEvent> listener)
Criteria	getCriteria() Criteria
String[]	getFeatures() Returns features what are implemented by Module.
Observable	getObservable()
static boolean	isAuthAvailable(SessionObject sessionObject)
void	login()
void	process(Element element) Main method of module.
void	removeAllListeners()
void	removeListener(EventType eventType, Listener<? extends BaseEvent> listener)

Methods inherited from class java.lang.Object

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

Field Detail

AuthFailed

public static final EventType AuthFailed

AUTHORIZED

public static final String AUTHORIZED

See Also:

Constant Field Values

AuthStart

public static final EventType AuthStart

AuthSuccess

public static final EventType AuthSuccess

CREDENTIALS_CALLBACK

public static final String CREDENTIALS_CALLBACK

See Also:

Constant Field Values

FORCE_NON_SASL

public static final String FORCE_NON_SASL

If true then Non-SASL (XEP-0078) mechanism is used.
Type: Boolean

See Also:

Constant Field Values

Constructor Detail

AuthModule

public AuthModule(Observable parentObservable,
          SessionObject sessionObject,
          XmppModulesManager modulesManager)

Method Detail

isAuthAvailable

public static boolean isAuthAvailable(SessionObject sessionObject)
                               throws XMLException

Throws:

XMLException

addListener

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

addListener

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

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

getObservable

public Observable getObservable()

login

public void login()
           throws JaxmppException

Throws:

JaxmppException

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

removeAllListeners

public void removeAllListeners()

removeListener

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