com.sap.tc.webdynpro.services.sal.um.api
Interface IWDClientUser

All Superinterfaces:

IWDService

public interface IWDClientUser

extends IWDService

IWDClientUser describes a Web Dynpro client user. It provides accessor methods to some attributes of the user profile. It also provides a method to access the com.sap.security.api.IUser which then can be used to get full access on the user's profile.
An IWDClientUser can represent an authenticated user or an anonymous user. See method isAnonymousUser() for details.

See Also:

com.sap.tc.webdynpro.services.sal.core.IClientUserFactory

Method Summary

void	checkPermission(java.security.Permission permission) If the user has (possibly via implication) the specified permission, this method does nothing.
java.lang.String	getClientUserID() Return is the client user ID of the actual client user.
java.lang.String	getFirstName() Return is the user's first name.
java.lang.String	getLastName() Return is the user's last name.
java.util.Locale	getLocale() Return is the locale the is specified for the current user by the user management system.
java.lang.String	getSalutation() Return is the salutation for the user.
com.sap.security.api.IUser	getSAPUser() Return is the com.sap.security.api.IUser representing the current user.
java.lang.String	getTitle() Return is the user's title.
boolean	hasPermission(java.security.Permission permission) Returns true if the user has (possibly via implication) the given permission.
boolean	isAnonymouseUser() Deprecated. The name of this method contained a typo, use isAnonymousUser() instead. The method with the old name has been kept for backward compatibility reasons only and may be withdrawn with the first new NetWeaver release in 2006.
boolean	isAnonymousUser() Return is true if the client user is an anonymous user, i.e.

Methods inherited from interface com.sap.tc.webdynpro.services.sal.api.IWDService

getDescription, getServiceName, getVersion

Method Detail

getClientUserID

public java.lang.String getClientUserID()

Return is the client user ID of the actual client user. This is the identifier used by Web Dynpro to identify an already existing client user.

Returns:

the client user ID of the actual client user

getFirstName

public java.lang.String getFirstName()

Return is the user's first name.

Returns:

the user's first name; in case of an anonymous user, the empty String is returned

getLastName

public java.lang.String getLastName()

Return is the user's last name.

Returns:

the user's last name; in case of an anonymous user, the empty String is returned

getTitle

public java.lang.String getTitle()

Return is the user's title.

Returns:

the user's title; in case of an anonymous user, the empty String is returned

getSalutation

public java.lang.String getSalutation()

Return is the salutation for the user.

Returns:

the salutation; in case of an anonymous user, the empty String is returned

getLocale

public java.util.Locale getLocale()

Return is the locale the is specified for the current user by the user management system. In case of an anonymous user, null is returned.
Please note that the user locale must not be the same as the session locale. The session locale also evaluates a locale set by URL parameter and the locale set in the browser settings. See also WDResourceHandler.getCurrentSessionLocale().

Returns:

the locale the user prefers; in case of an anonymous user, null is returned

isAnonymousUser

public boolean isAnonymousUser()

Return is true if the client user is an anonymous user, i.e. a user who can not be identified.

Returns:

true if the client user is an anonymous user

isAnonymouseUser

public boolean isAnonymouseUser()

Deprecated. The name of this method contained a typo, use isAnonymousUser() instead. The method with the old name has been kept for backward compatibility reasons only and may be withdrawn with the first new NetWeaver release in 2006.

Return is true if the client user is an anonymous user, i.e. a user who can not be identified.

Returns:

true if the client user is an anonymous user

getSAPUser

public com.sap.security.api.IUser getSAPUser()

Return is the com.sap.security.api.IUser representing the current user. In case of the current user represents an anonymous user, null is returned.

Returns:

the com.sap.security.api.IUser representing the current user

hasPermission

public boolean hasPermission(java.security.Permission permission)

Returns true if the user has (possibly via implication) the given permission. In case of an anonymous user, null is returned.

Parameters:

permission - the permission the user may have

Returns:

true if the user has the given permission

checkPermission

public void checkPermission(java.security.Permission permission)
                     throws java.security.AccessControlException

If the user has (possibly via implication) the specified permission, this method does nothing. If not, it will throw an AccessControlEcxeption, and possibly trigger appropriate tracing action.

In case of an anonymous user, an AccessControlEcxeption is thrown.

Parameters:

permission - the permission the user may have

Throws:

java.security.AccessControlException - if the user doesn't have the specified permission