cz.cuni.amis.pogamut.udk.communication.messages.gbcommands

Class SetPassword

java.lang.Object

cz.cuni.amis.pogamut.base.communication.messages.CommandMessage

cz.cuni.amis.pogamut.udk.communication.messages.gbcommands.SetPassword

public class SetPassword
extends CommandMessage

Sets the password for Bot and control connections. If the password is set the initiation of GB communication is changed to this: 1) A ---> GB sends HELLO message 2) B <--- user sends READY 3) C ... if the server is protected by pass: 3.a) C1 ---> GB sends PASSWORD {BlockedByIP="ip adress with port of the blocker (195.113.12.3:3001)"} 3.b) C2 <--- user sends password ( PASSWORD {Password pass}) ... if correct 3.c) C3 ---> GB sends PASSWDOK and info batch messages, user can continue normally .... if the password is wrong 3.d) C4 ---> PASSWDWRONG and connection ends Note: If the user knows that server is passworded he can use PASSWORD {Password pass} command instead of READY, and will be checked and sent info batch messages immediately Corresponding GameBots command is SETPASS.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	Password Holds the password.

Constructor Summary

Constructors

Constructor and Description
SetPassword() Creates new instance of command SetPassword.
SetPassword(SetPassword original) Cloning constructor.
SetPassword(String Password) Creates new instance of command SetPassword.

Method Summary

Methods

Modifier and Type	Method and Description
String	getPassword() Holds the password.
SetPassword	setPassword(String Password) Holds the password.
String	toHtmlString()
String	toMessage()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

Password

protected String Password

Holds the password.

Constructor Detail

SetPassword

public SetPassword(String Password)

Creates new instance of command SetPassword. Sets the password for Bot and control connections. If the password is set the initiation of GB communication is changed to this: 1) A ---> GB sends HELLO message 2) B <--- user sends READY 3) C ... if the server is protected by pass: 3.a) C1 ---> GB sends PASSWORD {BlockedByIP="ip adress with port of the blocker (195.113.12.3:3001)"} 3.b) C2 <--- user sends password ( PASSWORD {Password pass}) ... if correct 3.c) C3 ---> GB sends PASSWDOK and info batch messages, user can continue normally .... if the password is wrong 3.d) C4 ---> PASSWDWRONG and connection ends Note: If the user knows that server is passworded he can use PASSWORD {Password pass} command instead of READY, and will be checked and sent info batch messages immediately Corresponding GameBots message for this command is SETPASS.

Parameters:

Password - Holds the password.

SetPassword

public SetPassword()

Creates new instance of command SetPassword. Sets the password for Bot and control connections. If the password is set the initiation of GB communication is changed to this: 1) A ---> GB sends HELLO message 2) B <--- user sends READY 3) C ... if the server is protected by pass: 3.a) C1 ---> GB sends PASSWORD {BlockedByIP="ip adress with port of the blocker (195.113.12.3:3001)"} 3.b) C2 <--- user sends password ( PASSWORD {Password pass}) ... if correct 3.c) C3 ---> GB sends PASSWDOK and info batch messages, user can continue normally .... if the password is wrong 3.d) C4 ---> PASSWDWRONG and connection ends Note: If the user knows that server is passworded he can use PASSWORD {Password pass} command instead of READY, and will be checked and sent info batch messages immediately Corresponding GameBots message for this command is SETPASS.

WARNING: this is empty-command constructor, you have to use setters to fill it up!

SetPassword

public SetPassword(SetPassword original)

Cloning constructor.

Method Detail

getPassword

public String getPassword()

Holds the password.

setPassword

public SetPassword setPassword(String Password)

Holds the password.

toString

public String toString()

Overrides:

toString in class CommandMessage

toHtmlString

public String toHtmlString()

toMessage

public String toMessage()