User management API in WebDynpro

[Former Member]

Remember that to use UME in your WebDynpro components, you should add references to following DC's

• com.sap.security.api.sda
• security_api

The most important thing is that every object in WAS Java User Management Engine (UME) is based on a general interface - IPrincipal. The data we manipulate - group, user and role are available trough the IUser, IGroup and IRole interfaces, which are descendants of the IPrincipal interface.

Access to all the objects of UME is done using a static class - com.sap.security.api.UMFactory
This class provides standard methods for getting user, role and group factory and also other objects, like the SecurityManager.

WebDynpro user management is built somehow on top of the standard WAS UME. The basic class for the developer is the WDClientUser. It provides a static method, getClientUser() which returns the user currently logged on to the application. The user is an object implementing IWDClientUser interface, providing the method getSAPUser(), which returns the IUser object (a real WAS UME user).

Besides fetching the current user, one can access all available functions and methods - look at the linked URL to the UserManagement API.

To your convinience two source snippets are attached. The first one allows you to check wether the user is assigned to the specified role. A simple and effective way to perform authorizations checks, without building Permission objects and deploying them to the server. (however, it is not very nice to do so 😉
The second one is a simple implementation of a user search engine for WebDynpro - just add some context and a table view, and you have a working who-is-who. 🙂

Checking if user is assigned to role

// initializeboolean userHasRole = false;String roleName = "pl.com.bcc.AuthorityRole";// an exception should not occurtry { // get webdynpro user IWDClientUser wdcu = WDClientUser.getCurrentUser(); // get sap WAS user for WD user IUser sapUser = wdcu.getSAPUser(); // get role for name IRole sapRole = UMFactory.getRoleFactory().getRole(roleName); // check if user is member of role, // the "true" attribute means, that role assignment might be // indirect (ie. for a group in which user is a member userHasRole = sapRole.isUserMember(sapUser.getUniqueID(), true);// return a message in case of exception} catch (WDUMException e1) { wdComponentAPI.getMessageManager().reportWarning(  "Error when obtaining user information : " + e1.getMessage());} catch (UMException e2) { wdComponentAPI.getMessageManager().reportWarning(  "Error when obtaining user information : " + e2.getMessage());}// the userHasRole variable is true, if current user has the named role

Simple user search for a given phrase

// get base objectsIUserFactory iuf = UMFactory.getUserFactory();IUserSearchFilter usf = iuf.getUserSearchFilter();// config filterString search = wdContext.currentSearchElement().getSearchKey();// default wildcard searchsearch = "*" + search + "*";// search in all fields inlclusivelyusf.setSearchMethod(usf.SEARCHMETHOD_OR);// set search on all meaningful fieldsusf.setCellPhone(search, ISearchAttribute.LIKE_OPERATOR, false);usf.setCity(search, ISearchAttribute.LIKE_OPERATOR, false);usf.setEmail(search, ISearchAttribute.LIKE_OPERATOR, false);usf.setFirstName(search, ISearchAttribute.LIKE_OPERATOR, false);usf.setLastName(search, ISearchAttribute.LIKE_OPERATOR, false);usf.setJobTitle(search, ISearchAttribute.LIKE_OPERATOR, false);usf.setTelephone(search, ISearchAttribute.LIKE_OPERATOR, false);// perform the search using provided filterISearchResult res = iuf.searchUsers(usf);// get the results into the contextwhile (res.hasNext()) { IUser user = iuf.getUser(res.next().toString()); // przepisz dane do struktur context ISearchResultsElement sre =  wdContext.nodeSearchResults().createSearchResultsElement(); sre.setEmail(user.getEmail()); sre.setImie(user.getFirstName()); sre.setNazwisko(user.getLastName()); sre.setStanowisko(user.getJobTitle()); sre.setTelefon(user.getTelephone()); sre.setTelefonGSM(user.getCellPhone()); sre.setIdtechniczny(user.getUniqueName()); // zapisz w contexcie wdContext.nodeSearchResults().addElement(sre);}