server.commands.user

Class UserLoginCommand

java.lang.Object

server.commands.user.UserLoginCommand

All Implemented Interfaces:

ICommand

public class UserLoginCommand
extends java.lang.Object
implements ICommand

Handles logging in to the game.

Author:

Jonathan Sadler

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	password
private int	playerID
private java.lang.String	response
private java.lang.String	username

Constructor Summary

Constructors

Constructor and Description
UserLoginCommand(java.lang.String username, java.lang.String password) Creates a command to log in the user.

Method Summary

Modifier and Type	Method and Description
boolean	Execute() Executes a command
java.lang.String	GetHeader() Gets the new server header associated with the request.
java.lang.String	GetResponse() Gets the response for the server.
boolean	Unexecute() Unexecutes a command.

Methods inherited from class java.lang.Object

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

Field Detail

username

private java.lang.String username

password

private java.lang.String password

playerID

private int playerID

response

private java.lang.String response

Constructor Detail

UserLoginCommand

public UserLoginCommand(java.lang.String username,
                        java.lang.String password)

Creates a command to log in the user.

Parameters:

username - The user name.

password - The user's password.

Method Detail

Execute

public boolean Execute()

Description copied from interface: ICommand

Executes a command

Specified by:

Execute in interface ICommand

Returns:

True if successful, else false.

Unexecute

public boolean Unexecute()

Description copied from interface: ICommand

Unexecutes a command.

Specified by:

Unexecute in interface ICommand

Returns:

True if successful, else false.

GetResponse

public java.lang.String GetResponse()

Description copied from interface: ICommand

Gets the response for the server.

Specified by:

GetResponse in interface ICommand

Returns:

The serialized response from the server.

GetHeader

public java.lang.String GetHeader()

Description copied from interface: ICommand

Gets the new server header associated with the request.

Specified by:

GetHeader in interface ICommand

Returns:

Returns the header if applicable, else null.