User (WSO2 Charon - Core 3.3.11 API)

java.lang.Object
- org.wso2.charon3.core.objects.ScimAttributeAware
- - org.wso2.charon3.core.objects.AbstractSCIMObject
  - - org.wso2.charon3.core.objects.User

All Implemented Interfaces:

Serializable, SCIMObject
```
public class User
extends AbstractSCIMObject
```
Represents the User object which is a collection of attributes defined by SCIM User-schema.

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.wso2.charon3.core.objects.AbstractSCIMObject
  attributeList, schemaList

Constructor Summary

Constructors
Constructor and Description

User()

Constructors
Constructor and Description
`User()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`getActive()` gets the current active value of this user
`List<ScimAddress>`	`getAddresses()` gets the addresses from this user or an empty list if there are none present
`String`	`getDisplayName()` gets the displayName of this user
`List<MultiValuedComplexType>`	`getEmails()` gets the emails from this user or an empty list if there are none present
`List<MultiValuedComplexType>`	`getGroups()` gets the groups from this user or an empty list if there are none present
`List<MultiValuedComplexType>`	`getInstantMessagingAddresses()` gets the instant messaging addresses from this user or an empty list if there are none present
`String`	`getLocale()` gets the current locale value of this user
`ScimName`	`getName()` extracts the complex "name" attribute from the Scim structure
`String`	`getNickName()` gets the nickname of this user
`String`	`getPassword()` return the password of the user
`List<MultiValuedComplexType>`	`getPhoneNumbers()` gets the phonenumbers from this user or an empty list if there are none present
`List<MultiValuedComplexType>`	`getPhotos()` gets the photo uris from this user or an empty list if there are none present
`String`	`getPreferredLanguage()` gets the preferred language value of this user
`String`	`getProfileUrl()` gets the profile url of this user
`List<MultiValuedComplexType>`	`getRoles()` gets the roles from this user or an empty list if there are none present
`String`	`getTimezone()` gets the current timezone value of this user
`String`	`getTitle()` gets the title value of this user
`String`	`getUsername()` returns the username of this user
`String`	`getUserName()` return userName of the user
`String`	`getUserType()` gets the user type of this user
`List<MultiValuedComplexType>`	`getX509Certificates()` gets the x509 certificates from this user or an empty list if there are none present
`void`	`replaceActive(boolean active)` deletes the current value of active and exchanges it with the given value
`void`	`replaceAddresses(List<ScimAddress> addressList)` deletes the addresses attributes and exchanges it with the given values
`void`	`replaceDisplayName(String displayName)` deletes the current value of displayName and exchanges it with the given value
`void`	`replaceEmails(List<MultiValuedComplexType> multiValuedComplexTypeList)` deletes the current complex emails attributes and exchanges it with the given values
`void`	`replaceGroups(List<MultiValuedComplexType> multiValuedComplexTypeList)` deletes the group attributes and exchanges it with the given values
`void`	`replaceInstantMessagingAddresses(List<MultiValuedComplexType> multiValuedComplexTypeList)` deletes the current complex instant messaging addresses attributes and exchanges it with the given values
`void`	`replaceLocale(String locale)` deletes the current value of preferred language and exchanges it with the given value
`void`	`replaceName(ScimName scimName)` deletes the current complex name attribute and exchanges it with the given value
`void`	`replaceNickName(String nickName)` deletes the current value of nickname and exchanges it with the given value
`void`	`replacePhoneNumbers(List<MultiValuedComplexType> multiValuedComplexTypeList)` deletes the current complex phonenumber attributes and exchanges it with the given values
`void`	`replacePhotos(List<MultiValuedComplexType> multiValuedComplexTypeList)` deletes the current photo uri attributes and exchanges it with the given values
`void`	`replacePreferredLanguage(String preferredLanguage)` deletes the preferred language attribute and exchanges it with the given value
`void`	`replaceProfileUrl(String profileUrl)` deletes the current value of profile url and exchanges it with the given value
`void`	`replaceRoles(List<MultiValuedComplexType> multiValuedComplexTypeList)` deletes the role attributes and exchanges it with the given values
`void`	`replaceTimezone(String timezone)` deletes the timezone attribute and exchanges it with the given value
`void`	`replaceTitle(String title)` deletes the current value of title and exchanges it with the given value
`void`	`replaceUsername(String username)` deletes the current value of username and exchanges it with the given value
`void`	`replaceUserName(String username)` deletes the username attribute and exchanges it with the given value
`void`	`replaceUserType(String userType)` deletes the current value of user type and exchanges it with the given value
`void`	`replaceX509Certificates(List<MultiValuedComplexType> multiValuedComplexTypeList)` deletes the current x509 certificate attributes and exchanges it with the given values
`void`	`setGroup(String type, Group group)` Set the associated groups of the user.
`void`	`setGroup(String type, String value, String display)` Deprecated. use `setGroup(String type, Group group)` instead.
`void`	`setPassword(String password)` set the password of the user
`void`	`setPreferredLanguage(String preferredLanguage)` deletes the current value of preferred language and exchanges it with the given value
`void`	`setSchemas()` set the schemas of the user
`void`	`setTimezone(String timezone)` deletes the current value of timezone and exchanges it with the given value
`void`	`setUserName(String userName)` set the userName of the user

Methods inherited from class org.wso2.charon3.core.objects.AbstractSCIMObject
createMetaAttribute, deleteAttribute, deleteSubAttribute, deleteSubSubAttribute, deleteSubValuesSubAttribute, deleteValuesSubAttribute, getAttribute, getAttributeList, getCreatedDate, getLastModified, getMetaAttribute, getResource, getSchemaList, isAttributeExist, isMetaAttributeExist, isSchemaExists, setAttribute, setAttribute, setCreatedDate, setCreatedInstant, setExternalId, setId, setLastModified, setLastModifiedInstant, setLocation, setResourceType, setSchema, toString

Methods inherited from class org.wso2.charon3.core.objects.ScimAttributeAware
addMultivaluedComplexAtribute, attributeMetaEquals, attributesEquals, complexAttributeEquals, equals, getComplexAttribute, getCreatedDateTime, getCreatedInstant, getCreatedLong, getExternalId, getId, getLastModifiedDateTime, getLastModifiedInstant, getLastModifiedLong, getLocation, getMultiValuedAttribute, getMultivaluedComplexType, getOrCrateComplexAttribute, getResourceType, getSetSubAttributeConsumer, getSimpleAttribute, getSimpleAttribute, getSimpleAttributeValue, hashCode, isBlank, isNotBlank, multiValuedAttributeEquals, replaceCreated, replaceCreated, replaceCreated, replaceExternalId, replaceId, replaceLastModified, replaceLastModified, replaceLastModified, replaceLocation, replaceResourceType, replaceSimpleAttribute, simpleAttributeEquals, stripToNull

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - User
```
public User()
```
- Method Detail
  - getUsername
```
public String getUsername()
```
    returns the username of this user
  - replaceUsername
```
public void replaceUsername(String username)
```
    deletes the current value of username and exchanges it with the given value
  - getDisplayName
```
public String getDisplayName()
```
    gets the displayName of this user
  - replaceDisplayName
```
public void replaceDisplayName(String displayName)
```
    deletes the current value of displayName and exchanges it with the given value
  - getNickName
```
public String getNickName()
```
    gets the nickname of this user
  - replaceNickName
```
public void replaceNickName(String nickName)
```
    deletes the current value of nickname and exchanges it with the given value
  - getProfileUrl
```
public String getProfileUrl()
```
    gets the profile url of this user
  - replaceProfileUrl
```
public void replaceProfileUrl(String profileUrl)
```
    deletes the current value of profile url and exchanges it with the given value
  - getUserType
```
public String getUserType()
```
    gets the user type of this user
  - replaceUserType
```
public void replaceUserType(String userType)
```
    deletes the current value of user type and exchanges it with the given value
  - getTitle
```
public String getTitle()
```
    gets the title value of this user
  - replaceTitle
```
public void replaceTitle(String title)
```
    deletes the current value of title and exchanges it with the given value
  - getPreferredLanguage
```
public String getPreferredLanguage()
```
    gets the preferred language value of this user
  - setPreferredLanguage
```
public void setPreferredLanguage(String preferredLanguage)
```
    deletes the current value of preferred language and exchanges it with the given value
  - replacePreferredLanguage
```
public void replacePreferredLanguage(String preferredLanguage)
```
    deletes the preferred language attribute and exchanges it with the given value
    
    Parameters:
    
    preferredLanguage - the new preferred language
  - getLocale
```
public String getLocale()
```
    gets the current locale value of this user
  - replaceLocale
```
public void replaceLocale(String locale)
```
    deletes the current value of preferred language and exchanges it with the given value
  - getTimezone
```
public String getTimezone()
```
    gets the current timezone value of this user
  - setTimezone
```
public void setTimezone(String timezone)
```
    deletes the current value of timezone and exchanges it with the given value
  - replaceTimezone
```
public void replaceTimezone(String timezone)
```
    deletes the timezone attribute and exchanges it with the given value
    
    Parameters:
    
    timezone - the new timezone
  - getActive
```
public boolean getActive()
```
    gets the current active value of this user
  - replaceActive
```
public void replaceActive(boolean active)
```
    deletes the current value of active and exchanges it with the given value
  - getName
```
public ScimName getName()
```
    extracts the complex "name" attribute from the Scim structure
  - replaceName
```
public void replaceName(ScimName scimName)
```
    deletes the current complex name attribute and exchanges it with the given value
  - getEmails
```
public List<MultiValuedComplexType> getEmails()
```
    gets the emails from this user or an empty list if there are none present
  - replaceEmails
```
public void replaceEmails(List<MultiValuedComplexType> multiValuedComplexTypeList)
```
    deletes the current complex emails attributes and exchanges it with the given values
  - getPhoneNumbers
```
public List<MultiValuedComplexType> getPhoneNumbers()
```
    gets the phonenumbers from this user or an empty list if there are none present
  - replacePhoneNumbers
```
public void replacePhoneNumbers(List<MultiValuedComplexType> multiValuedComplexTypeList)
```
    deletes the current complex phonenumber attributes and exchanges it with the given values
  - getInstantMessagingAddresses
```
public List<MultiValuedComplexType> getInstantMessagingAddresses()
```
    gets the instant messaging addresses from this user or an empty list if there are none present
  - replaceInstantMessagingAddresses
```
public void replaceInstantMessagingAddresses(List<MultiValuedComplexType> multiValuedComplexTypeList)
```
    deletes the current complex instant messaging addresses attributes and exchanges it with the given values
  - getPhotos
```
public List<MultiValuedComplexType> getPhotos()
```
    gets the photo uris from this user or an empty list if there are none present
  - replacePhotos
```
public void replacePhotos(List<MultiValuedComplexType> multiValuedComplexTypeList)
```
    deletes the current photo uri attributes and exchanges it with the given values
  - getX509Certificates
```
public List<MultiValuedComplexType> getX509Certificates()
```
    gets the x509 certificates from this user or an empty list if there are none present
  - replaceX509Certificates
```
public void replaceX509Certificates(List<MultiValuedComplexType> multiValuedComplexTypeList)
```
    deletes the current x509 certificate attributes and exchanges it with the given values
  - getGroups
```
public List<MultiValuedComplexType> getGroups()
```
    gets the groups from this user or an empty list if there are none present
  - replaceGroups
```
public void replaceGroups(List<MultiValuedComplexType> multiValuedComplexTypeList)
```
    deletes the group attributes and exchanges it with the given values
  - getRoles
```
public List<MultiValuedComplexType> getRoles()
```
    gets the roles from this user or an empty list if there are none present
  - replaceRoles
```
public void replaceRoles(List<MultiValuedComplexType> multiValuedComplexTypeList)
```
    deletes the role attributes and exchanges it with the given values
  - getAddresses
```
public List<ScimAddress> getAddresses()
```
    gets the addresses from this user or an empty list if there are none present
  - replaceAddresses
```
public void replaceAddresses(List<ScimAddress> addressList)
```
    deletes the addresses attributes and exchanges it with the given values
  - getUserName
```
public String getUserName()
                   throws CharonException
```
    return userName of the user
    
    Returns:
    
    Throws:
    
    CharonException
  - setUserName
```
public void setUserName(String userName)
                 throws CharonException,
                        BadRequestException
```
    set the userName of the user
    
    Parameters:
    
    userName -
    
    Throws:
    
    CharonException
    
    BadRequestException
  - replaceUserName
```
public void replaceUserName(String username)
```
    deletes the username attribute and exchanges it with the given value
    
    Parameters:
    
    username - the new username
  - getPassword
```
public String getPassword()
                   throws CharonException
```
    return the password of the user
    
    Returns:
    
    Throws:
    
    CharonException
  - setPassword
```
public void setPassword(String password)
                 throws CharonException,
                        BadRequestException
```
    set the password of the user
    
    Parameters:
    
    password -
    
    Throws:
    
    CharonException
    
    BadRequestException
  - setGroup
```
@Deprecated
public void setGroup(String type,
                                 String value,
                                 String display)
                          throws CharonException,
                                 BadRequestException
```
    Deprecated. use setGroup(String type, Group group) instead.
    
    This method used to add group details (attributes display and value) of a user. According to the SCIM specification need to add ref attribute as well along with display and value. Hence deprecated this method.
    
    Throws:
    
    CharonException
    
    BadRequestException
  - setGroup
```
public void setGroup(String type,
                     Group group)
              throws CharonException,
                     BadRequestException
```
    Set the associated groups of the user. According to the SCIM specification need to add display, value and ref attributes.
    
    Parameters:
    
    type - Type of resource.
    
    group - Group object.
    
    Throws:
    
    CharonException
    
    BadRequestException
  - setSchemas
```
public void setSchemas()
```
    set the schemas of the user

Class User

Field Summary

Fields inherited from class org.wso2.charon3.core.objects.AbstractSCIMObject

Constructor Summary

Method Summary

Methods inherited from class org.wso2.charon3.core.objects.AbstractSCIMObject

Methods inherited from class org.wso2.charon3.core.objects.ScimAttributeAware

Methods inherited from class java.lang.Object

Constructor Detail

User

Method Detail

getUsername

replaceUsername

getDisplayName

replaceDisplayName

getNickName

replaceNickName

getProfileUrl

replaceProfileUrl

getUserType

replaceUserType

getTitle

replaceTitle

getPreferredLanguage

setPreferredLanguage

replacePreferredLanguage

getLocale

replaceLocale

getTimezone

setTimezone

replaceTimezone

getActive

replaceActive

getName

replaceName

getEmails

replaceEmails

getPhoneNumbers

replacePhoneNumbers

getInstantMessagingAddresses

replaceInstantMessagingAddresses

getPhotos

replacePhotos

getX509Certificates

replaceX509Certificates

getGroups

replaceGroups

getRoles

replaceRoles

getAddresses

replaceAddresses

getUserName

setUserName

replaceUserName

getPassword

setPassword

setGroup

setGroup

setSchemas