net.sf.opensmus
Interface ServerUser

All Known Implementing Classes:

MUSUser, ServerSideScript

public interface ServerUser

Method Summary

long	creationTime() Gets this user's creationTime on the server, equivalent to the user login
void	deleteUser() Deletes this user, disconnecting him from the server.
java.util.Vector<java.lang.String>	getGroupNames() Gets a list of the groups this user is a member of.
java.util.Vector<ServerGroup>	getGroups() Gets a list of the groups this user is a member of.
int	getGroupsCount() Gets the number of groups this user is a member of.
void	groupJoined(ServerGroup grp) Called by the OpenSMUS server when the user joins a group.
void	groupLeft(ServerGroup grp) Called by the OpenSMUS server when the user leaves a group.
java.lang.String	ipAddress() Gets this user's IP address as a String
java.lang.String	name() Returns the name of the user as a String
void	postMessage(MUSMessage msg) Posts a message to the OpenSMUS server dispatcher.
void	sendMessage(MUSMessage msg) Sends a message to this server user directly.
ServerMovie	serverMovie() Retrieves the ServerMovie object representing the movie this user is connected to.
void	setuserLevel(int level) Sets the user access level for this user.
int	userLevel() Gets the user access level for this user

Method Detail

sendMessage

void sendMessage(MUSMessage msg)

Sends a message to this server user directly.

Parameters:

msg - Message to send

postMessage

void postMessage(MUSMessage msg)

Posts a message to the OpenSMUS server dispatcher.
Scripts can use this method to post messages to the server as if they were a connected user, since the ServerSideScript class implements the ServerUser interface.

Parameters:

msg - Message to post

name

java.lang.String name()

Returns the name of the user as a String

userLevel

int userLevel()

Gets the user access level for this user

setuserLevel

void setuserLevel(int level)

Sets the user access level for this user.

Parameters:

level - new user access level

serverMovie

ServerMovie serverMovie()

Retrieves the ServerMovie object representing the movie this user is connected to.
Server side scripts can use this method to retrieve a pointer to the movie that created them.

creationTime

long creationTime()

Gets this user's creationTime on the server, equivalent to the user login

ipAddress

java.lang.String ipAddress()

Gets this user's IP address as a String

getGroupNames

java.util.Vector<java.lang.String> getGroupNames()

Gets a list of the groups this user is a member of. By default all users are at least members of one group, @AllUsers

Returns:

Java Vector with the group names as Strings.

getGroups

java.util.Vector<ServerGroup> getGroups()

Gets a list of the groups this user is a member of. By default all users are at least members of one group, @AllUsers

Returns:

Java Vector with the group objects.

getGroupsCount

int getGroupsCount()

Gets the number of groups this user is a member of. By default all users are at least members of one group, @AllUsers

Returns:

the number of groups

deleteUser

void deleteUser()

Deletes this user, disconnecting him from the server.

groupJoined

void groupJoined(ServerGroup grp)

Called by the OpenSMUS server when the user joins a group.

Parameters:

grp - ServerGroup reference

groupLeft

void groupLeft(ServerGroup grp)

Called by the OpenSMUS server when the user leaves a group.

Parameters:

grp - ServerGroup reference