com.bankframe.services.accesscontrol.administration.user
Interface UserAdministration

All Superinterfaces:

javax.ejb.EJBObject, ESessionRemote, java.rmi.Remote

public interface UserAdministration

extends ESessionRemote

UserAdministration Interface Class defines the mehtods and the parameters for the UserAdministrationBean

Author:

Rob O'Neill

Method Summary

void	addUserPermission(java.lang.String userId, java.lang.String permission) This method updates the EJBUSER_PERMISSIONS table with a permission for a user.
void	addUserToGroup(java.lang.String userId, java.lang.String group) This method will add a specified user to a group.
void	createUser(java.lang.String userId, java.lang.String userName, java.lang.String password) This method creates a new user.
void	deleteUser(java.lang.String userId) This method deletes a user.
void	deleteUserFromGroup(java.lang.String userId, java.lang.String group) This method will remove a specified user from a group.
void	deleteUserPermission(java.lang.String userId, java.lang.String permission) This method deletes a permission associated with a user.
java.util.Enumeration	getAllUsers() This method will get all the users currently registered in the system.
EJBUser	getUser(java.lang.String userId) This method finds a user by its primary key, the UserID.
java.util.Vector	getUserPermissions(java.lang.String userId) This method gets the permissions specified for a user.
java.util.Vector	unassignedUserPermissions(java.lang.String userId) This method returns the permissions a user does not have.

Methods inherited from interface com.bankframe.ejb.ESessionRemote

processDataPacket, processDataPackets

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Method Detail

addUserPermission

public void addUserPermission(java.lang.String userId,
                              java.lang.String permission)
                       throws ProcessingErrorException,
                              java.rmi.RemoteException

This method updates the EJBUSER_PERMISSIONS table with a permission for a user.

Parameters:

userId - the id of user to update

permission - the permission to update the specified user with

Throws:

ProcessingErrorException - if processing fails

java.rmi.RemoteException

addUserToGroup

public void addUserToGroup(java.lang.String userId,
                           java.lang.String group)
                    throws ProcessingErrorException,
                           java.rmi.RemoteException

This method will add a specified user to a group.

Parameters:

userId - the id of user to add to group

group - the group to add the specified user to

Throws:

ProcessingErrorException - if processing fails.

java.rmi.RemoteException

createUser

public void createUser(java.lang.String userId,
                       java.lang.String userName,
                       java.lang.String password)
                throws ProcessingErrorException,
                       java.rmi.RemoteException

This method creates a new user.

Parameters:

userId - ID of user to create

userName - Name of user to create

password - password to assign to new user

Throws:

ProcessingErrorException - this exception is thrown if processing fails.

java.rmi.RemoteException

deleteUser

public void deleteUser(java.lang.String userId)
                throws ProcessingErrorException,
                       java.rmi.RemoteException

This method deletes a user.

Parameters:

userId - the id of the user to delete

Throws:

ProcessingErrorException - if processing fails.

java.rmi.RemoteException

deleteUserFromGroup

public void deleteUserFromGroup(java.lang.String userId,
                                java.lang.String group)
                         throws ProcessingErrorException,
                                java.rmi.RemoteException

This method will remove a specified user from a group.

Parameters:

userId - the id of the user to add to a group

group - the group to remove the specified userfrom

Throws:

ProcessingErrorException - if processing fails.

java.rmi.RemoteException

deleteUserPermission

public void deleteUserPermission(java.lang.String userId,
                                 java.lang.String permission)
                          throws ProcessingErrorException,
                                 java.rmi.RemoteException

This method deletes a permission associated with a user.

Parameters:

userId - the id of user

permission - the permission to remove from this user

Throws:

ProcessingErrorException - if processing fails

java.rmi.RemoteException

getAllUsers

public java.util.Enumeration getAllUsers()
                                  throws ProcessingErrorException,
                                         java.rmi.RemoteException

This method will get all the users currently registered in the system.

Returns:

an enumeration of Users

Throws:

ProcessingErrorException - if processing fails

java.rmi.RemoteException

getUser

public EJBUser getUser(java.lang.String userId)
                throws ProcessingErrorException,
                       java.rmi.RemoteException

This method finds a user by its primary key, the UserID.

Parameters:

userId - the id of user to check

Returns:

true if group exists, false otherwise

Throws:

ProcessingErrorException - if processing fails.

java.rmi.RemoteException

getUserPermissions

public java.util.Vector getUserPermissions(java.lang.String userId)
                                    throws ProcessingErrorException,
                                           java.rmi.RemoteException

This method gets the permissions specified for a user.

Parameters:

userId - the id of user to fetch permissions for

Returns:

a vector of requestIds denoting permissions for the specified user

Throws:

ProcessingErrorException - this exception is thrown if processing fails.

java.rmi.RemoteException

unassignedUserPermissions

public java.util.Vector unassignedUserPermissions(java.lang.String userId)
                                           throws ProcessingErrorException,
                                                  java.rmi.RemoteException

This method returns the permissions a user does not have.

Parameters:

userId - the id of user to check unassigned permissions for

Returns:

a vector of permissions.

Throws:

ProcessingErrorException - if processing fails.

java.rmi.RemoteException