net.java.sip.communicator.service.protocol
Class RegistrationState

java.lang.Object
  net.java.sip.communicator.service.protocol.RegistrationState

public class RegistrationState
extends Object

The class represents a set of states that a protocol provider may take while registering, logging in, or signing on to a public service server, such as a SIP registrar, the ICQ/AIM login and registration servers or a Jabber server. States are generally supposed to be appearing in the following order:

Note that the order strongly depends on the particular protocol, which may also influence the exact states that might actually be entered.

For more information on the particular states, please check the documentation for each of them.

Author:

Emil Ivov

Field Summary

static String	_AUTHENTICATING
static String	_AUTHENTICATION_FAILED
static String	_CHALLENGED_FOR_AUTHENTICATION
static String	_CONNECTION_FAILED
static String	_EXPIRED
static String	_FINALIZING_REGISTRATION
static String	_REGISTERED
static String	_REGISTERING
static String	_UNREGISTERED
static String	_UNREGISTERING
static String	_UPDATING_REGISTRATION
static RegistrationState	AUTHENTICATING In the process of authenticating.
static RegistrationState	AUTHENTICATION_FAILED Registration has failed because of a problem with the authentication.
static RegistrationState	CHALLENGED_FOR_AUTHENTICATION The registrar service requires authentication and we are about to send one.
static RegistrationState	CONNECTION_FAILED Registration has failed for a technical reason, such as connection disruption for example.
static RegistrationState	EXPIRED The registration has expired.
static RegistrationState	FINALIZING_REGISTRATION Representing any transition state after authentication is completed and before it has been completed.
static RegistrationState	INIT The initial state of a protocol provider, assigned to it upon creation and before any registration action has been undertaken by the user.
static RegistrationState	REGISTERED Registration has completed successfully and we are currently signed on the registration service.
static RegistrationState	REGISTERING A transition state indicating that registration has been undertaken but has not yet been confirmed by the registrar server/service.
static RegistrationState	UNREGISTERED The Protocol Provider is not registered.
static RegistrationState	UNREGISTERING The Protocol Provider is being unregistered.
static RegistrationState	UPDATING_REGISTRATION Indicates that a protocol provider is currently updating its registration.

Method Summary

boolean	equals(Object obj) Returns true if the specified object is equal to this provider state.
String	getStateName() Returns a String representation of the provider state.
String	toString() Returns a String representation of the provider state.

Methods inherited from class java.lang.Object

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

Field Detail

INIT

public static final RegistrationState INIT

The initial state of a protocol provider, assigned to it upon creation and before any registration action has been undertaken by the user.

_REGISTERING

public static final String _REGISTERING

See Also:

Constant Field Values

REGISTERING

public static final RegistrationState REGISTERING

A transition state indicating that registration has been undertaken but has not yet been confirmed by the registrar server/service. The state generally occurs after the client has undertaken action to completing the registration and the server is about to respond.

_CHALLENGED_FOR_AUTHENTICATION

public static final String _CHALLENGED_FOR_AUTHENTICATION

See Also:

Constant Field Values

CHALLENGED_FOR_AUTHENTICATION

public static final RegistrationState CHALLENGED_FOR_AUTHENTICATION

The registrar service requires authentication and we are about to send one.

_AUTHENTICATING

public static final String _AUTHENTICATING

See Also:

Constant Field Values

AUTHENTICATING

public static final RegistrationState AUTHENTICATING

In the process of authenticating. The state is entered when a protocol provider sends authentication info and waits for a confirmation

_FINALIZING_REGISTRATION

public static final String _FINALIZING_REGISTRATION

See Also:

Constant Field Values

FINALIZING_REGISTRATION

public static final RegistrationState FINALIZING_REGISTRATION

Representing any transition state after authentication is completed and before it has been completed. This state wouldn't make sense for many services, and would only be used with others such as ICQ/AIM for example.

_REGISTERED

public static final String _REGISTERED

See Also:

Constant Field Values

REGISTERED

public static final RegistrationState REGISTERED

Registration has completed successfully and we are currently signed on the registration service.

_CONNECTION_FAILED

public static final String _CONNECTION_FAILED

See Also:

Constant Field Values

CONNECTION_FAILED

public static final RegistrationState CONNECTION_FAILED

Registration has failed for a technical reason, such as connection disruption for example.

_AUTHENTICATION_FAILED

public static final String _AUTHENTICATION_FAILED

See Also:

Constant Field Values

AUTHENTICATION_FAILED

public static final RegistrationState AUTHENTICATION_FAILED

Registration has failed because of a problem with the authentication.

_UPDATING_REGISTRATION

public static final String _UPDATING_REGISTRATION

See Also:

Constant Field Values

UPDATING_REGISTRATION

public static final RegistrationState UPDATING_REGISTRATION

Indicates that a protocol provider is currently updating its registration.

_EXPIRED

public static final String _EXPIRED

See Also:

Constant Field Values

EXPIRED

public static final RegistrationState EXPIRED

The registration has expired.

_UNREGISTERING

public static final String _UNREGISTERING

See Also:

Constant Field Values

UNREGISTERING

public static final RegistrationState UNREGISTERING

The Protocol Provider is being unregistered. Most probably due to a user request.

_UNREGISTERED

public static final String _UNREGISTERED

See Also:

Constant Field Values

UNREGISTERED

public static final RegistrationState UNREGISTERED

The Protocol Provider is not registered. Most probably due to a unregistration.

Method Detail

getStateName

public String getStateName()

Returns a String representation of the provider state.

Returns:

a String representation of the state.

toString

public String toString()

Returns a String representation of the provider state.

Overrides:

toString in class Object

Returns:

a String representation of the state.

equals

public boolean equals(Object obj)

Returns true if the specified object is equal to this provider state.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this provider state with.

Returns:

true if the specified object represents the same state as this one.