com.sap.mdm.security
Class UserProperties

java.lang.Object
  extended bycom.sap.mdm.security.UserProperties
All Implemented Interfaces:
Cloneable, RepositoryItem

public class UserProperties
extends Object
implements RepositoryItem

This class represents a user in MDM. A user can belong to one or more roles.

See Also:
RoleProperties

Field Summary
static UserId ADMINISTRATOR_USER_ID
          The administrator user Id.
 
Constructor Summary
UserProperties()
           
UserProperties(UserProperties other)
          Copy c'tor.
 
Method Summary
 Object clone()
           
 boolean equals(Object obj)
           
 String getDescription()
          Returns the description for the user.
 String[] getEmails()
          Returns the list of email addresses for the user.
 int getFailedPasswordAttempts()
          Returns the number of failed password attempts.
 String getFullName()
          Returns the full name for the user.
 UserId getId()
          Returns the user ID.
 String getName()
          Returns the user name.
 String getPassword()
          Returns the user password.
 RoleId[] getRoleIds()
          Returns the list of roles the user belongs to.
 int hashCode()
           
 boolean isLocked()
          Returns true if the user account is locked, otherwise false.
 boolean isLoggedIn()
          Deprecated. This information is not correctly returned by the server when LDAP is used. It had been changed to always return false.
 boolean isPassword()
          For internal use only.
 boolean isPasswordChangeRequired()
          Returns true if the user requires to change the password as soon as the user logs in, otherwise false.
 boolean isPasswordNeverExpires()
          Returns true if the password will never expire, otherwise false.
 void setDescription(String description)
          Sets the description for the user.
 void setEmails(String[] emails)
          Sets the list of email addresses for the user.
 void setFailedPasswordAttempts(int failedPasswordAttempts)
          Sets the number of failed password attempts before the account is locked.
 void setFullName(String fullName)
          Sets the full name for the user.
 void setId(UserId id)
          Sets the user ID.
 void setLocked(boolean locked)
          Sets whether the user account is locked or not.
 void setLoggedIn(boolean isLoggedIn)
          Deprecated. see isLoggedIn()
 void setName(String name)
          Sets the user name.
 void setPassword(String password)
          Sets the user password.
 void setPasswordChangeRequired(boolean passwordChangeRequired)
          Sets whether a user requires to change the password as soon as the user logs in.
 void setPasswordNeverExpires(boolean passwordNeverExpires)
          Sets whether the password will expire or not.
 void setRoleIds(RoleId[] roleIds)
          Sets the list of roles the user belongs to.
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ADMINISTRATOR_USER_ID

public static final UserId ADMINISTRATOR_USER_ID
The administrator user Id.

Constructor Detail

UserProperties

public UserProperties()

UserProperties

public UserProperties(UserProperties other)
Copy c'tor. Creates deep copy of UserProperties object.

Parameters:
other - Object to copy
Since:
7.2
Method Detail

getDescription

public String getDescription()
Returns the description for the user.

Returns:
Returns the description.

setDescription

public void setDescription(String description)
Sets the description for the user.

Parameters:
description - The description to set.

getEmails

public String[] getEmails()
Returns the list of email addresses for the user.

Returns:
Returns the emails.

setEmails

public void setEmails(String[] emails)
Sets the list of email addresses for the user.

Parameters:
emails - The emails to set.

getFullName

public String getFullName()
Returns the full name for the user.

Returns:
Returns the full name.

setFullName

public void setFullName(String fullName)
Sets the full name for the user.

Parameters:
fullName - The full name to set.

getId

public UserId getId()
Returns the user ID.

Returns:
Returns the id.

setId

public void setId(UserId id)
Sets the user ID.

Note: The UserProperties.setId and UserProperties.setName should always be set to meaningful values when this data structure is use for modifying a user or for deleting a user.

Parameters:
id - The id to set.

isLoggedIn

public boolean isLoggedIn()
Deprecated. This information is not correctly returned by the server when LDAP is used. It had been changed to always return false.

Returns whether the user is currently connected to the repository.

Returns:
Returns whether the user is logged in.
See Also:
GetRepositoryLoginListCommand

setLoggedIn

public void setLoggedIn(boolean isLoggedIn)
Deprecated. see isLoggedIn()

Sets whether the user is connected to the repository.

Parameters:
isLoggedIn - whether the user is logged in.

getName

public String getName()
Returns the user name.

Returns:
Returns the name.

setName

public void setName(String name)
Sets the user name.

Note: The UserProperties.setId and UserProperties.setName should always be set to meaningful values when this data structure is use for modifying a user or for deleting a user.

Parameters:
name - The name to set.

getRoleIds

public RoleId[] getRoleIds()
Returns the list of roles the user belongs to.

Returns:
Returns the roleIds.

setRoleIds

public void setRoleIds(RoleId[] roleIds)
Sets the list of roles the user belongs to.

Parameters:
roleIds - The roleIds to set.

getPassword

public String getPassword()
Returns the user password.

Returns:
Returns the password.

setPassword

public void setPassword(String password)
Sets the user password.

Parameters:
password - The password to set.

isPassword

public boolean isPassword()
For internal use only. Returns whether the password has been set.

Returns:
Returns whether the password has been set.

hashCode

public int hashCode()

equals

public boolean equals(Object obj)

toString

public String toString()

getFailedPasswordAttempts

public int getFailedPasswordAttempts()
Returns the number of failed password attempts.

Returns:
the number of failed password attempts
Since:
7.10

setFailedPasswordAttempts

public void setFailedPasswordAttempts(int failedPasswordAttempts)
Sets the number of failed password attempts before the account is locked.

Parameters:
failedPasswordAttempts - the number of failed password attempts
Since:
7.10

isLocked

public boolean isLocked()
Returns true if the user account is locked, otherwise false. An account lock is temporary and is automatically unlocked after some amount of time.

Returns:
true if the user account is locked, otherwise false
Since:
7.10

setLocked

public void setLocked(boolean locked)
Sets whether the user account is locked or not. An account lock is temporary and is automatically unlocked after some amount of time.

Note: This method can be use to unlock an account. It cannot be use to lock an account though.

Parameters:
locked - true if the user account is locked, otherwise false
Since:
7.10

isPasswordChangeRequired

public boolean isPasswordChangeRequired()
Returns true if the user requires to change the password as soon as the user logs in, otherwise false.

Returns:
true if the user needs to change the password as soon as the user logs in, otherwise false
Since:
7.10

setPasswordChangeRequired

public void setPasswordChangeRequired(boolean passwordChangeRequired)
Sets whether a user requires to change the password as soon as the user logs in.

Parameters:
passwordChangeRequired -
Since:
7.10

isPasswordNeverExpires

public boolean isPasswordNeverExpires()
Returns true if the password will never expire, otherwise false.

Returns:
true if the password will never expire, otherwise false
Since:
7.10

setPasswordNeverExpires

public void setPasswordNeverExpires(boolean passwordNeverExpires)
Sets whether the password will expire or not.

Parameters:
passwordNeverExpires - true if the password will never expire, otherwise false
Since:
7.10

clone

public Object clone()


Copyright 2004-2007 by SAP AG. All Rights Reserved.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.