rocks.xmpp.extensions.register

Class RegistrationManager

java.lang.Object

rocks.xmpp.core.session.Manager

rocks.xmpp.core.session.ExtensionManager

rocks.xmpp.extensions.register.RegistrationManager

public final class RegistrationManager
extends ExtensionManager

This manager allows to register, cancel an existing registration (i.e. remove an account) or change the password with a host.

Author:

Christian Schudt

Field Summary

Fields inherited from class rocks.xmpp.core.session.ExtensionManager

features, xmppSession

Method Summary

Modifier and Type	Method and Description
void	cancelRegistration() Cancels a registration.
void	changePassword(String username, String password) Changes the password for the current user.
Registration	getRegistration() Gets the registration data (instructions, fields and form) from the server.
boolean	isRegistrationSupported() Determines, if in-band registration is supported by the server.
void	register(Registration registration) Registers a new account.

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

setEnabled

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

isEnabled

Methods inherited from class java.lang.Object

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

Method Detail

isRegistrationSupported

public boolean isRegistrationSupported()
                                throws rocks.xmpp.core.XmppException

Determines, if in-band registration is supported by the server.

Returns:

True if registration is supported by the server; otherwise false.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the server returned a stanza error. Common errors are Conflict (username is already in use) or NotAcceptable (some required information not provided).

NoResponseException - If the server did not respond.

rocks.xmpp.core.XmppException

getRegistration

public Registration getRegistration()
                             throws rocks.xmpp.core.XmppException

Gets the registration data (instructions, fields and form) from the server.

In order to check if a field is required, you should check if a field is not null.

If you are already registered to the server, this method returns your registration data and Registration.isRegistered() returns true.

Returns:

The registration data.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the server returned a stanza error.

NoResponseException - If the server did not respond.

rocks.xmpp.core.XmppException

See Also:

3.1 Entity Registers with a Host, Registration

register

public void register(Registration registration)
              throws rocks.xmpp.core.XmppException

Registers a new account. Call this method before authenticating.

Parameters:

registration - The registration.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the server returned a stanza error. Common errors are Conflict (username is already in use) or NotAcceptable (some required information not provided).

NoResponseException - If the server did not respond.

rocks.xmpp.core.XmppException

See Also:

3.1 Entity Registers with a Host

cancelRegistration

public void cancelRegistration()
                        throws rocks.xmpp.core.XmppException

Cancels a registration. This method must be called after having authenticated to the server.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the server returned a stanza error.

NoResponseException - If the server did not respond.

rocks.xmpp.core.XmppException

See Also:

3.2 Entity Cancels an Existing Registration

changePassword

public void changePassword(String username,
                           String password)
                    throws rocks.xmpp.core.XmppException

Changes the password for the current user. This method must be called after having authenticated to the server.

Parameters:

username - The user name.

password - The password.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the server returned a stanza error.

NoResponseException - If the server did not respond.

rocks.xmpp.core.XmppException

See Also:

3.3 User Changes Password