ibi.broker.api.ws
Class UserManagerClientSF

java.lang.Object
  ibi.broker.api.ws.UserManagerClientSF

All Implemented Interfaces:

UserManager

public class UserManagerClientSF
extends java.lang.Object
implements UserManager

Field Summary

Fields inherited from interface ibi.broker.api.cci.UserManager

DELETE_USER_DELETE_SCHEDULE, DELETE_USER_ONLY, DELETE_USER_SET_SCHEDULE_INACTIVE

Constructor Summary

UserManagerClientSF(java.lang.String base, java.lang.String userName, java.lang.String password)

Method Summary

void	addExecId(ExecId execId)
void	addGroup(Group group) Adds group information, as encapsulated in the specified Group object, to the underlying repository.
void	addUser(User user) Adds the properties of a specified ReportCaster user, as contained in the passed User object, to the underlying database or repository.
void	addUserInToGroup(java.lang.String groupName, java.lang.String userName) Adds a userName to an existing group in the underlying repository, as identified by its group name.
int	deleteExecId(ExecId execId)
int	deleteGroup(java.lang.String groupName) Deletes group information, as encapsulated in the specified Group object, from the underlying repository.
int	deleteUser(java.lang.String userName, int deleteType) Deletes the specified user, identified by the passed username, from the underlying database or repository using one of the three provided deletion methods.
int	deleteUserFromGroup(java.lang.String groupName, java.lang.String userName) Deletes a user as identified by its ReportCaster userName from the specified groupName.
ExecId[]	getExecIdInfoList(java.lang.String user)
ExecId[]	getExecIdListByServerByOwner(java.lang.String serverName, User owner, java.lang.String type)
java.lang.String[]	getExecIdOwnerList()
Group	getGroup(java.lang.String groupName) Retrieves a Group object as identified by its groupName from the underlying database orrepository.
Group[]	getGroupList() Retrieves an array of Group objects representing a list of all groups to which the current user belongs.
Group[]	getGroupListByUserName(java.lang.String userName)
java.lang.String[]	getGroupNameListByUser(java.lang.String userName) Retrieves a string array representing a list of all group names where a specific ReportCaster user belongs to or is a member of these group names.
java.lang.String[]	getServerListByExecId(java.lang.String owner, java.lang.String type)
User	getUserByName(java.lang.String userName) Retrieves a User object based upon the specified ReportCaster username.
User[]	getUserList() Retrieves an array of User objects.
User[]	getUserList(java.lang.String capability)
java.lang.String[]	getUserNameListByGroup(java.lang.String groupName) Obtains a string array of usernames that belong to a specified Group as identified by its groupName.
java.lang.String[]	getUserNameListByGroup(java.lang.String groupName, java.lang.String capabilyty)
boolean	isExecId(ExecId execId)
java.lang.String	testExecIdCredential(ExecId execId)
void	updateExecId(ExecId execId)
void	updateGroup(Group group) After modifying properties contained in the Group object (except for the group name), updates the corresponding group data in the underlying repository.
void	updateGroupWithUser(Group group, java.lang.String[] userNameList) Updates a given Group with a String Array of user names representing the list of usernames belonging to the group.
void	updateUser(User user) Updates a user's property information in the underlying repository.
void	updateUserInfoProperties(User user) Allows an authenticated user to change limited properties belonging to him in the underlying repository.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserManagerClientSF

public UserManagerClientSF(java.lang.String base,
                           java.lang.String userName,
                           java.lang.String password)
                    throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getUserByName

public User getUserByName(java.lang.String userName)
                   throws CasterException

Description copied from interface: UserManager

Retrieves a User object based upon the specified ReportCaster username.

Specified by:

getUserByName in interface UserManager

Parameters:

userName - ReportCaster username of User.

Returns:

User

Throws:

CasterException - If a database access error occurs or userName doesn't exist or there is no permission to access this method.

getUserList

public User[] getUserList()
                   throws CasterException

Description copied from interface: UserManager

Retrieves an array of User objects. This method is accessible only by an administrator, and lists all the users in the system.

Specified by:

getUserList in interface UserManager

Returns:

An array (User[]) of Users.

Throws:

CasterException - If a database access error occurs or there is no permission to access this method.

getUserList

public User[] getUserList(java.lang.String capability)
                   throws CasterException

Specified by:

getUserList in interface UserManager

Throws:

CasterException

getUserNameListByGroup

public java.lang.String[] getUserNameListByGroup(java.lang.String groupName)
                                          throws CasterException

Description copied from interface: UserManager

Obtains a string array of usernames that belong to a specified Group as identified by its groupName. This method is only accessible by the Administrator.

Specified by:

getUserNameListByGroup in interface UserManager

Parameters:

groupName - name which uniquely identifies the group.

Returns:

String array (String[] ) of usernames. NULL if groupName doesn't exist.

Throws:

CasterException - If a database access error occurs or groupName is invalid or there is no permission to access this method.

getUserNameListByGroup

public java.lang.String[] getUserNameListByGroup(java.lang.String groupName,
                                                 java.lang.String capabilyty)
                                          throws CasterException

Specified by:

getUserNameListByGroup in interface UserManager

Throws:

CasterException

addUser

public void addUser(User user)
             throws CasterException

Description copied from interface: UserManager

Adds the properties of a specified ReportCaster user, as contained in the passed User object, to the underlying database or repository. This method is only accessible by the Administrator.

Specified by:

addUser in interface UserManager

Parameters:

user - object representing the user that is being added.

Throws:

CasterException - if a database access error occurs or there is no permission to access this method.

deleteUser

public int deleteUser(java.lang.String userName,
                      int deleteType)
               throws CasterException

Description copied from interface: UserManager

Deletes the specified user, identified by the passed username, from the underlying database or repository using one of the three provided deletion methods. The deletion types are represented by one of three constants: DELETE_USER_ONLY, DELETE_USER_DELETE_SCHEDULE,or DELETE_USER_SET_SCHEDULE_INACTIVE This method is only accessible by the Administrator.

Specified by:

deleteUser in interface UserManager

Parameters:

userName - the unique ReportCaster user name.

deleteType - one of three deletion methods as a integer.

Throws:

CasterException - if a database access error occurs or userName doesn't exist or there is no permission to access this method.

updateUserInfoProperties

public void updateUserInfoProperties(User user)
                              throws CasterException

Description copied from interface: UserManager

Allows an authenticated user to change limited properties belonging to him in the underlying repository. The properties contained in the User object that can be changed by this method are: Description (see User.getDescription()), Address (see User.getAddress()), and Password.(see User.getAddress(). This method is accessible by the Administrator and the calling user.

Specified by:

updateUserInfoProperties in interface UserManager

Parameters:

user - object representing the user that is being added.

Throws:

CasterException - If a database access error occurs or user is NULL or user object doesn't exist in the underlying database or there is no permission to access this method.

updateUser

public void updateUser(User user)
                throws CasterException

Description copied from interface: UserManager

Updates a user's property information in the underlying repository. All properties can be modified except Name (see User.getName()), which uniquely identifies the user in the database. This method is only accessible by the Administrator.

Specified by:

updateUser in interface UserManager

Parameters:

user - Accepts a user object containing properties encapsulating the user that is being updated.

Throws:

CasterException - If a database access error occurs or user is NULL or user doesn't exist in the underlying database or there is no permission to access this method.

getGroup

public Group getGroup(java.lang.String groupName)
               throws CasterException

Description copied from interface: UserManager

Retrieves a Group object as identified by its groupName from the underlying database orrepository. The specified groupName uniquely identifes a Group in the database. This method is only accessible by the Administrator.

Specified by:

getGroup in interface UserManager

Parameters:

groupName - Unique name string identifying the group.

Returns:

Group object encapsulating the specified group name.

Throws:

CasterException - if a database access error occurs or groupName doesn't exist or there is no permission to access this method.

getGroupList

public Group[] getGroupList()
                     throws CasterException

Description copied from interface: UserManager

Retrieves an array of Group objects representing a list of all groups to which the current user belongs. This method is only accessible by the Administrator.

Specified by:

getGroupList in interface UserManager

Returns:

Array of groups(Group[]).

Throws:

CasterException - If a database access error occurs or there is no permission to access this method.

getGroupListByUserName

public Group[] getGroupListByUserName(java.lang.String userName)
                               throws CasterException

Specified by:

getGroupListByUserName in interface UserManager

Throws:

CasterException

getGroupNameListByUser

public java.lang.String[] getGroupNameListByUser(java.lang.String userName)
                                          throws CasterException

Description copied from interface: UserManager

Retrieves a string array representing a list of all group names where a specific ReportCaster user belongs to or is a member of these group names. This method is only accessible by the Administrator.

Specified by:

getGroupNameListByUser in interface UserManager

Parameters:

userName - username as a String.

Returns:

a String Array representing the group names. If no group exist for this user it returns NULL.

Throws:

CasterException - If a database access error occurs or there is no permission to access this method.

addGroup

public void addGroup(Group group)
              throws CasterException

Description copied from interface: UserManager

Adds group information, as encapsulated in the specified Group object, to the underlying repository. This method is only accessible by the Administrator.

Specified by:

addGroup in interface UserManager

Parameters:

group - object representing the group that is being added.

Throws:

CasterException - If a database access error occurs or there is no permission to access this method.

deleteGroup

public int deleteGroup(java.lang.String groupName)
                throws CasterException

Description copied from interface: UserManager

Deletes group information, as encapsulated in the specified Group object, from the underlying repository. This method is only accessible by the Administrator.

Specified by:

deleteGroup in interface UserManager

Parameters:

groupName - unique name of group.

Throws:

CasterException - If a database access error occurs or there is no permission to access this method.

updateGroupWithUser

public void updateGroupWithUser(Group group,
                                java.lang.String[] userNameList)
                         throws CasterException

Description copied from interface: UserManager

Updates a given Group with a String Array of user names representing the list of usernames belonging to the group. This new list of user names replaces the existing list of user names. This method is only accessible by the Administrator.

Specified by:

updateGroupWithUser in interface UserManager

Parameters:

group - object representing the group that is being added.

userNameList - usernameList as a String name.

Throws:

CasterException - If a database access error occurs or group is NULL or Group doesn't exist in the underlying database or there is no permission to access this method.

updateGroup

public void updateGroup(Group group)
                 throws CasterException

Description copied from interface: UserManager

After modifying properties contained in the Group object (except for the group name), updates the corresponding group data in the underlying repository. This method is only accessible by the Administrator.

Specified by:

updateGroup in interface UserManager

Parameters:

group - Group object representing the group that is being modified.

Throws:

CasterException - If a database access error occurs or group is NULL or Group doesn't exist in the underlying database or there is no permission to access this method.

addUserInToGroup

public void addUserInToGroup(java.lang.String groupName,
                             java.lang.String userName)
                      throws CasterException

Description copied from interface: UserManager

Adds a userName to an existing group in the underlying repository, as identified by its group name. This method is only accessible by the Administrator.

Specified by:

addUserInToGroup in interface UserManager

Parameters:

groupName - unique name of the group as a string.

userName - as a String.

Throws:

CasterException - If a database access error occurs or groupName is invalid or userName is invalid or there is no permission to access this method.

deleteUserFromGroup

public int deleteUserFromGroup(java.lang.String groupName,
                               java.lang.String userName)
                        throws CasterException

Description copied from interface: UserManager

Deletes a user as identified by its ReportCaster userName from the specified groupName. This method is only accessible by the Administrator.

Specified by:

deleteUserFromGroup in interface UserManager

Parameters:

groupName - unique name of group as a String.

userName - unique name of user as String.

Throws:

CasterException - If a database access error occurs or there is no permission to access this method.

getExecIdListByServerByOwner

public ExecId[] getExecIdListByServerByOwner(java.lang.String serverName,
                                             User owner,
                                             java.lang.String type)
                                      throws CasterException

Specified by:

getExecIdListByServerByOwner in interface UserManager

Throws:

CasterException

addExecId

public void addExecId(ExecId execId)
               throws CasterException

Specified by:

addExecId in interface UserManager

Throws:

CasterException

testExecIdCredential

public java.lang.String testExecIdCredential(ExecId execId)
                                      throws CasterException

Specified by:

testExecIdCredential in interface UserManager

Throws:

CasterException

updateExecId

public void updateExecId(ExecId execId)
                  throws CasterException

Specified by:

updateExecId in interface UserManager

Throws:

CasterException

deleteExecId

public int deleteExecId(ExecId execId)
                 throws CasterException

Specified by:

deleteExecId in interface UserManager

Throws:

CasterException

isExecId

public boolean isExecId(ExecId execId)
                 throws CasterException

Specified by:

isExecId in interface UserManager

Throws:

CasterException

getServerListByExecId

public java.lang.String[] getServerListByExecId(java.lang.String owner,
                                                java.lang.String type)
                                         throws CasterException

Throws:

CasterException

getExecIdOwnerList

public java.lang.String[] getExecIdOwnerList()
                                      throws CasterException

Throws:

CasterException

getExecIdInfoList

public ExecId[] getExecIdInfoList(java.lang.String user)
                           throws CasterException

Throws:

CasterException