Interface ServerModelApi

All Known Implementing Classes:

ServerModel

public interface ServerModelApi

Defines a collection of methods that should be available in the ServerModel class. These methods will be used by the ServerBackend, and should therefore conform to this interface. You do not need to modify this file.

Method Summary

Modifier and Type	Method and Description
Broadcast	deregisterUser(int userId) Informs the model that the client with the given user ID has disconnected from the server.
Collection<String>	getChannels() Returns a collection of the names of all the channels that are present on the server.
String	getNickname(int userId) Returns the nickname currently associated with the given user ID.
String	getOwner(String channelName) Returns the nickname of the owner of the current channel.
Collection<String>	getRegisteredUsers() Returns a collection of the nicknames of all users that are registered with the server.
int	getUserId(String nickname) Returns the user ID currently associated with the given nickname.
Collection<String>	getUsers(String channelName) Returns a collection of the nicknames of all the users in a given channel.
Broadcast	registerUser(int userId) Informs the model that a client has connected to the server with the given user ID.

Method Detail

registerUser

Broadcast registerUser(int userId)

Informs the model that a client has connected to the server with the given user ID. The model should update its state so that it can identify this user during later interactions with the model. Any user that is registered with the server (without being later deregistered) should appear in the output of getRegisteredUsers().

Parameters:

userId - the unique ID created by the backend to represent this user

Returns:

a Broadcast to the user with their new nickname

deregisterUser

Broadcast deregisterUser(int userId)

Informs the model that the client with the given user ID has disconnected from the server. After a user ID is deregistered, the server backend is free to reassign this user ID to an entirely different client. As such, the model should take care to expunge any state pertaining to a user who has been deregistered. Any user that is deregistered (without later being registered) should not appear in the output of getRegisteredUsers(). The behavior of this method if the given user ID is not registered with the model is undefined.

Parameters:

userId - the unique ID created by the backend to represent this user

Returns:

A Broadcast instructing clients to remove the user from all channels.

getUserId

int getUserId(String nickname)

Returns the user ID currently associated with the given nickname. The returned ID is -1 if the nickname is not currently in use.

Parameters:

nickname - The user's nickname

Returns:

the nickname of said user

getNickname

String getNickname(int userId)

Returns the nickname currently associated with the given user ID. The returned string is null if the user ID is not currently in use.

Parameters:

userId - The ID whose nickname to return.

Returns:

The nickname associated with the current ID.

getRegisteredUsers

Collection<String> getRegisteredUsers()

Returns a collection of the nicknames of all users that are registered with the server. Provided for testing.

Returns:

the collection of registered user nicknames

getChannels

Collection<String> getChannels()

Returns a collection of the names of all the channels that are present on the server. Provided for testing.

Returns:

the collection of channel names

getUsers

Collection<String> getUsers(String channelName)

Returns a collection of the nicknames of all the users in a given channel. The returned collection is empty if no channel with the given name exists. Provided for testing.

Parameters:

channelName - The channel whose member nicknames should be returned

Returns:

the collection of user nicknames in the current channel

getOwner

String getOwner(String channelName)

Returns the nickname of the owner of the current channel. The result is null if no channel with the given name exists. Provided for testing.

Parameters:

channelName - The channel whose owner nickname should be returned

Returns:

the nickname of the channel owner