Package sfs3.client.requests

Class LoginRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.LoginRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class LoginRequest
extends BaseRequest

Logs the current user in one of the server Zones.

Each Zone represent an independent multiuser application governed by SmartFoxServer. In order to join a Zone, a user name and password are usually required. In order to validate the user credentials, a custom login process should be implemented in the Zone's server-side Extension.

Read the SmartFoxServer 3 documentation about the login process for more informations.

If the login operation is successful, the current user receives a login event; otherwise the loginError event is fired.

See Also:

• SFSEvent.LOGIN
• SFSEvent.LOGIN_ERROR

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_CLUSTER_SID
static final String	KEY_ID
static final String	KEY_PARAMS
static final String	KEY_PASSWORD
static final String	KEY_PRIVILEGE_ID
static final String	KEY_RECONNECTION_SECONDS
static final String	KEY_ROOMLIST
static final String	KEY_USER_NAME
static final String	KEY_ZONE_NAME

Fields inherited from class sfs3.client.requests.BaseRequest

AddBuddy, AdminMessage, AutoJoin, BanUser, BanUsersFromRoom, BlockBuddy, CallExtension, ChangeRoomCapacity, ChangeRoomName, ChangeRoomPassword, ClusterInviteUsers, ClusterJoinOrCreate, CreateRoom, CreateSFSGame, FindRooms, FindUsers, GameServerConnectionRequired, GenericMessage, GetRoomList, GoOnline, Handshake, InitBuddyList, InvitationReply, InviteUser, JoinRoom, JoinRoomInvite, KEY_ERROR_CODE, KEY_ERROR_PARAMS, KickUser, LeaveRoom, Login, Logout, ManualDisconnection, ModeratorMessage, ObjectMessage, PingPong, PlayerToSpectator, PrivateMessage, PublicMessage, QuickJoinGame, QuickJoinOrCreateRoom, RemoveBuddy, SetBuddyVariables, SetRoomVariables, SetUserPosition, SetUserVariables, sfso, SpectatorToPlayer, SubscribeRoomGroup, targetController, UdpInit, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
LoginRequest(String userName)
LoginRequest(String userName, String password)
LoginRequest(String userName, String password, String zoneName)
LoginRequest(String userName, String password, String zoneName, ISFSObject params)	Creates a new LoginRequest instance.

Method Summary

Modifier and Type	Method	Description
void	execute(ISmartFox sfs)
void	validate(ISmartFox sfs)

Methods inherited from class sfs3.client.requests.BaseRequest

getId, getRequest, getTargetController, getTransportType, setId, setTargetController, setTransportType

Methods inherited from class java.lang.Object

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

Field Details

KEY_ZONE_NAME

public static final String KEY_ZONE_NAME

See Also:

• Constant Field Values

Internal

KEY_USER_NAME

public static final String KEY_USER_NAME

See Also:

• Constant Field Values

Internal

KEY_PASSWORD

public static final String KEY_PASSWORD

See Also:

• Constant Field Values

Internal

KEY_PARAMS

public static final String KEY_PARAMS

See Also:

• Constant Field Values

Internal

KEY_PRIVILEGE_ID

public static final String KEY_PRIVILEGE_ID

See Also:

• Constant Field Values

Internal

KEY_ID

public static final String KEY_ID

See Also:

• Constant Field Values

Internal

KEY_ROOMLIST

public static final String KEY_ROOMLIST

See Also:

• Constant Field Values

Internal

KEY_RECONNECTION_SECONDS

public static final String KEY_RECONNECTION_SECONDS

See Also:

• Constant Field Values

Internal

KEY_CLUSTER_SID

public static final String KEY_CLUSTER_SID

See Also:

• Constant Field Values

Internal

Constructor Details

LoginRequest

public LoginRequest(String userName,
 String password,
 String zoneName,
 ISFSObject params)

Creates a new LoginRequest instance. The instance must be passed to the SmartFox.send() method for the request to be performed.

Parameters:

userName - The name to be assigned to the user. If not passed and if the Zone allows guest users, the name is generated automatically by the server.

password - The user password to access the system. SmartFoxServer doesn't offer a default authentication system, so the password must be validated implementing a custom login system in the Zone's server-side Extension.

zoneName - The name (case-sensitive) of the server Zone to login to; if a Zone name is not specified, the client will use the setting loaded via SmartFox.loadConfig() method.

params - An instance of SFSObject containing custom parameters to be passed to the Zone Extension (requires a custom login system to be in place).

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• SFSObject

LoginRequest

public LoginRequest(String userName,
 String password,
 String zoneName)

See Also:

• LoginRequest(String, String, String, ISFSObject)

LoginRequest

public LoginRequest(String userName,
 String password)

See Also:

• LoginRequest(String, String, String, ISFSObject)

LoginRequest

public LoginRequest(String userName)

See Also:

• LoginRequest(String, String, String, ISFSObject)

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal