wtalk
Interface IUserList

All Known Implementing Classes:
UserList

public interface IUserList

Interface wtalk.WTalkProtocol uses to manipulate a user list in the shell.


Method Summary
 void addConnection(java.lang.String connectionName)
          Adds a connection named connectionName.
 void addGroup(java.lang.String groupName, java.lang.String connectionName)
          Adds a group named groupName to connectionName.
 void addUser(java.lang.String userName, java.lang.String groupName, java.lang.String connectionName)
          Adds userName to the specified group.
 void delConnection(java.lang.String connectionName)
          Removes the named connection, and everything under it.
 void delGroup(java.lang.String groupName, java.lang.String connectionName)
          Removes the named group, and all users under it.
 void delUser(java.lang.String userName, java.lang.String groupName, java.lang.String connectionName)
          Removes the named user, assuming user exists under the named group and connection.
 

Method Detail

addConnection

public void addConnection(java.lang.String connectionName)
Adds a connection named connectionName. If the connection already exists, no change is made.

If there is already a connection by this name, there is no change made.

Parameters:
connectionName - The name of connection to be added.

addGroup

public void addGroup(java.lang.String groupName,
                     java.lang.String connectionName)
Adds a group named groupName to connectionName. If groupName already exists under connectionName, no change is made. If connectionName does not exist, no change is made.

If the specified group already exists, no change is made.

Parameters:
groupName - The group to be added.
connectionName - An existing connection to which group is to be added.

addUser

public void addUser(java.lang.String userName,
                    java.lang.String groupName,
                    java.lang.String connectionName)
Adds userName to the specified group. If the user already exists in the group, or the group does not exist under the given connection, no change is made.

If the specified user already exists, no change is made.

Parameters:
userName - The name of the user to add.
groupName - The name of the group to add userName to.
connectionName - The connection in which to search for groupName.

delConnection

public void delConnection(java.lang.String connectionName)
Removes the named connection, and everything under it. No change is made if connectionName does not exist.

Parameters:
connectionName - Name of connection to remove.

delGroup

public void delGroup(java.lang.String groupName,
                     java.lang.String connectionName)
Removes the named group, and all users under it. No change is made if either the group or connection named do not exist.

Parameters:
groupName - Name of group to be removed.
connectionName - Name of connection under which group exists.

delUser

public void delUser(java.lang.String userName,
                    java.lang.String groupName,
                    java.lang.String connectionName)
Removes the named user, assuming user exists under the named group and connection. There should be no change otherwise.

Parameters:
userName - User to be removed from the user list.
groupName - Group name to which User belongs.
connectionName - Connection under which to search for groupName.