User.Builder (scim-schema 1.1 API)

java.lang.Object
- org.osiam.resources.scim.Resource.Builder
- - org.osiam.resources.scim.User.Builder

Enclosing class:

User
```
public static class User.Builder
extends Resource.Builder
```
Builder class that is used to build User instances

Field Summary
- Fields inherited from class org.osiam.resources.scim.Resource.Builder
  externalId

Constructor Summary

Constructors
Constructor and Description
`User.Builder()` Creates a new builder without a userName
`User.Builder(String userName)` Constructs a new builder by with a set userName
`User.Builder(String userName, User user)` creates a new User.Builder based on the given userName and user.
`User.Builder(User user)` Constructs a new builder by copying all values from the given `User`

Method Summary

Methods
Modifier and Type	Method and Description
`User.Builder`	`addAddress(Address address)` adds an Address to the User
`User.Builder`	`addAddresses(Collection<Address> addresses)` Adds the physical mailing addresses for this User (See `User.getAddresses()`).
`User.Builder`	`addEmail(Email email)` adds an email to the User
`User.Builder`	`addEmails(Collection<Email> emails)` Adds the E-mail addresses for the User (See `User.getEmails()`).
`User.Builder`	`addEntitlement(Entitlement entitlement)` adds an Entitlement to the User
`User.Builder`	`addEntitlements(Collection<Entitlement> entitlements)` Adds a collection of entitlements for the User (See `User.getEntitlements()`).
`User.Builder`	`addExtension(Extension extension)` Sets a Extension to the User (See `User.getExtension(String)`).
`User.Builder`	`addExtensions(Collection<Extension> extensions)` Adds a collection of Extension to the User (See `User.getExtensions()`).
`User.Builder`	`addIm(Im im)` adds an Im to the User
`User.Builder`	`addIms(Collection<Im> ims)` Adds the instant messaging addresses for the User (See `User.getIms()`).
`User.Builder`	`addPhoneNumber(PhoneNumber phoneNumber)` adds an phoneNumber to the User
`User.Builder`	`addPhoneNumbers(Collection<PhoneNumber> phoneNumbers)` Adds the phone numbers for the User (See `User.getPhoneNumbers()`).
`User.Builder`	`addPhoto(Photo photo)` adds an Photo to the User
`User.Builder`	`addPhotos(Collection<Photo> photos)` Adds the URL's of photo's of the User (See `User.getPhotos()`).
`User.Builder`	`addRole(Role role)` adds an Role to the User
`User.Builder`	`addRoles(Collection<Role> roles)` Sets a list of roles for the User (See `User.getRoles()`).
`User.Builder`	`addX509Certificate(X509Certificate x509Certificate)` adds an X509Certificate to the User
`User.Builder`	`addX509Certificates(Collection<X509Certificate> x509Certificates)` Sets a collection of certificates issued to the User (See `User.getX509Certificates()`).
`User`	`build()` Builds the Object of the Builder
`User.Builder`	`removeAddress(Address address)` removes one single Photo from the User
`User.Builder`	`removeAddresses()` removes all Addresses from the actual User
`User.Builder`	`removeEmail(Email email)` removes one single email from the User
`User.Builder`	`removeEmails()` removes all email from the actual User
`User.Builder`	`removeEntitlement(Entitlement entitlement)` removes one single Entitlement from the User
`User.Builder`	`removeEntitlements()` removes all Entitlements from the actual User
`User.Builder`	`removeExtension(String urn)` removes one single Extension from the User
`User.Builder`	`removeExtensions()` removes all Extensions from the actual User
`User.Builder`	`removeIm(Im im)` removes one single im from the User
`User.Builder`	`removeIms()` removes all ims from the actual User
`User.Builder`	`removePhoneNumber(PhoneNumber phoneNumber)` removes one single phoneNumber from the User
`User.Builder`	`removePhoneNumbers()` removes all phoneNumbers from the actual User
`User.Builder`	`removePhoto(Photo photo)` removes one single Photo from the User
`User.Builder`	`removePhotos()` removes all Photos from the actual User
`User.Builder`	`removeRole(Role role)` removes one single Role from the User
`User.Builder`	`removeRoles()` removes all Roles from the actual User
`User.Builder`	`removeX509Certificate(X509Certificate x509Certificate)` removes one single X509Certificate from the User
`User.Builder`	`removeX509Certificates()` removes all X509Certificates from the actual User
`User.Builder`	`setActive(Boolean active)` Sets a Boolean value indicating the User's administrative status.
`User.Builder`	`setDisplayName(String displayName)` Sets the display name (See `User.getDisplayName()`).
`User.Builder`	`setExternalId(String externalId)` Sets the external id (See `Resource.getExternalId()`).
`User.Builder`	`setGroups(List<GroupRef> groups)` Sets a list of groups that the user belongs to (See `User.getGroups()`) client info: The groups where the user is a member of will only be set from the OSIAM server.
`User.Builder`	`setId(String id)` Sets the id of the resource.
`User.Builder`	`setLocale(String locale)` Sets the default location of the User (See `User.getLocale()`).
`User.Builder`	`setMeta(Meta meta)` Sets the meta data client info: The meta information of a User will be created and set by the OSIAM server.
`User.Builder`	`setName(Name name)` Sets the components of the `User`'s real name (See `User.getName()`).
`User.Builder`	`setNickName(String nickName)` Sets the nick name (See `User.getNickName()`).
`User.Builder`	`setPassword(String password)` Sets the User's clear text password (See `User.getPassword()`).
`User.Builder`	`setPreferredLanguage(String preferredLanguage)` Sets the preferred language of the USer (See `User.getPreferredLanguage()`).
`User.Builder`	`setProfileUrl(String profileUrl)` Sets the profile URL (See `User.getProfileUrl()`).
`User.Builder`	`setSchemas(Set<String> schemas)` sets the schemas of the Resource
`User.Builder`	`setTimezone(String timezone)` Sets the User's time zone (See `User.getTimezone()`).
`User.Builder`	`setTitle(String title)` Sets the user's title (See `User.getTitle()`).
`User.Builder`	`setUserType(String userType)` Sets the user type (See `User.getUserType()`).

Methods inherited from class org.osiam.resources.scim.Resource.Builder
addSchema

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

- Constructor Detail
  - User.Builder
```
public User.Builder(String userName,
            User user)
```
    creates a new User.Builder based on the given userName and user. All values of the given user will be copied expect the userName will be be overridden by the given one
    
    Parameters:
    userName - the new userName of the user
    user - a existing user
  - User.Builder
```
public User.Builder(String userName)
```
    Constructs a new builder by with a set userName
    
    Parameters:
    userName - Unique identifier for the User (See User.getUserName())
    
    Throws:
    
    SCIMDataValidationException - if the given userName is null or empty
  - User.Builder
```
public User.Builder()
```
    Creates a new builder without a userName
  - User.Builder
```
public User.Builder(User user)
```
    Constructs a new builder by copying all values from the given User
    
    Parameters:
    user - a old User
    
    Throws:
    
    SCIMDataValidationException - if the given user is null
- Method Detail
  - setName
```
public User.Builder setName(Name name)
```
    Sets the components of the User's real name (See User.getName()).
    
    Parameters:
    name - the name object of the User
    
    Returns:
    the builder itself
  - setDisplayName
```
public User.Builder setDisplayName(String displayName)
```
    Sets the display name (See User.getDisplayName()).
    
    Parameters:
    displayName - the display name of the User
    
    Returns:
    the builder itself
  - setNickName
```
public User.Builder setNickName(String nickName)
```
    Sets the nick name (See User.getNickName()).
    
    Parameters:
    nickName - the nick name of the User
    
    Returns:
    the builder itself
  - setProfileUrl
```
public User.Builder setProfileUrl(String profileUrl)
```
    Sets the profile URL (See User.getProfileUrl()).
    
    Parameters:
    profileUrl - the profil URL of the User
    
    Returns:
    the builder itself
  - setTitle
```
public User.Builder setTitle(String title)
```
    Sets the user's title (See User.getTitle()).
    
    Parameters:
    title - the title of the User
    
    Returns:
    the builder itself
  - setUserType
```
public User.Builder setUserType(String userType)
```
    Sets the user type (See User.getUserType()).
    
    Parameters:
    userType - the type of the User
    
    Returns:
    the builder itself
  - setPreferredLanguage
```
public User.Builder setPreferredLanguage(String preferredLanguage)
```
    Sets the preferred language of the USer (See User.getPreferredLanguage()).
    
    Parameters:
    preferredLanguage - sets the preferred language of the User
    
    Returns:
    the builder itself
  - setLocale
```
public User.Builder setLocale(String locale)
```
    Sets the default location of the User (See User.getLocale()).
    
    Parameters:
    locale - sets the local of the User
    
    Returns:
    the builder itself
  - setTimezone
```
public User.Builder setTimezone(String timezone)
```
    Sets the User's time zone (See User.getTimezone()).
    
    Parameters:
    timezone - sets the time zone of the User
    
    Returns:
    the builder itself
  - setActive
```
public User.Builder setActive(Boolean active)
```
    Sets a Boolean value indicating the User's administrative status. (See User.isActive())
    
    Parameters:
    active - the active status of the User
    
    Returns:
    the builder itself
  - setPassword
```
public User.Builder setPassword(String password)
```
    Sets the User's clear text password (See User.getPassword()).
    
    Parameters:
    password - the password as clear text
    
    Returns:
    the builder itself
  - addEmails
```
public User.Builder addEmails(Collection<Email> emails)
```
    Adds the E-mail addresses for the User (See User.getEmails()).
    
    Parameters:
    emails - a collection of email to be added
    
    Returns:
    the builder itself
  - addEmail
```
public User.Builder addEmail(Email email)
```
    adds an email to the User
    
    Parameters:
    email - an email to add
    
    Returns:
    the builder itself
  - removeEmails
```
public User.Builder removeEmails()
```
    removes all email from the actual User
    
    Returns:
    the builder itself
  - removeEmail
```
public User.Builder removeEmail(Email email)
```
    removes one single email from the User
    
    Parameters:
    email - an email to be removed
    
    Returns:
    the builder itself
  - addPhoneNumbers
```
public User.Builder addPhoneNumbers(Collection<PhoneNumber> phoneNumbers)
```
    Adds the phone numbers for the User (See User.getPhoneNumbers()).
    
    Parameters:
    phoneNumbers - the phone numbers of the the User
    
    Returns:
    the builder itself
  - addPhoneNumber
```
public User.Builder addPhoneNumber(PhoneNumber phoneNumber)
```
    adds an phoneNumber to the User
    
    Parameters:
    phoneNumber - a phoneNumber to add
    
    Returns:
    the builder itself
  - removePhoneNumbers
```
public User.Builder removePhoneNumbers()
```
    removes all phoneNumbers from the actual User
    
    Returns:
    the builder itself
  - removePhoneNumber
```
public User.Builder removePhoneNumber(PhoneNumber phoneNumber)
```
    removes one single phoneNumber from the User
    
    Parameters:
    phoneNumber - an phoneNumber to be removed
    
    Returns:
    the builder itself
  - addIms
```
public User.Builder addIms(Collection<Im> ims)
```
    Adds the instant messaging addresses for the User (See User.getIms()).
    
    Parameters:
    ims - a collection of the ims of the User
    
    Returns:
    the builder itself
  - addIm
```
public User.Builder addIm(Im im)
```
    adds an Im to the User
    
    Parameters:
    im - a Im to add
    
    Returns:
    the builder itself
  - removeIms
```
public User.Builder removeIms()
```
    removes all ims from the actual User
    
    Returns:
    the builder itself
  - removeIm
```
public User.Builder removeIm(Im im)
```
    removes one single im from the User
    
    Parameters:
    im - a im to be removed
    
    Returns:
    the builder itself
  - addPhotos
```
public User.Builder addPhotos(Collection<Photo> photos)
```
    Adds the URL's of photo's of the User (See User.getPhotos()).
    
    Parameters:
    photos - the photos of the User
    
    Returns:
    the builder itself
  - addPhoto
```
public User.Builder addPhoto(Photo photo)
```
    adds an Photo to the User
    
    Parameters:
    photo - a Photo to add
    
    Returns:
    the builder itself
  - removePhotos
```
public User.Builder removePhotos()
```
    removes all Photos from the actual User
    
    Returns:
    the builder itself
  - removePhoto
```
public User.Builder removePhoto(Photo photo)
```
    removes one single Photo from the User
    
    Parameters:
    photo - a photo to be removed
    
    Returns:
    the builder itself
  - addAddresses
```
public User.Builder addAddresses(Collection<Address> addresses)
```
    Adds the physical mailing addresses for this User (See User.getAddresses()).
    
    Parameters:
    addresses - a collection of the addresses of the User
    
    Returns:
    the builder itself
  - addAddress
```
public User.Builder addAddress(Address address)
```
    adds an Address to the User
    
    Parameters:
    address - a Address to add
    
    Returns:
    the builder itself
  - removeAddresses
```
public User.Builder removeAddresses()
```
    removes all Addresses from the actual User
    
    Returns:
    the builder itself
  - removeAddress
```
public User.Builder removeAddress(Address address)
```
    removes one single Photo from the User
    
    Parameters:
    address - a Address to be removed
    
    Returns:
    the builder itself
  - setGroups
```
public User.Builder setGroups(List<GroupRef> groups)
```
    Sets a list of groups that the user belongs to (See User.getGroups())
    client info: The groups where the user is a member of will only be set from the OSIAM server. If you want to put a user into a group, you have to add the user as a member to the group. If a User which is send to the OSIAM server has this value filled, the value will be ignored or the action will be rejected.
    
    Parameters:
    groups - groups of the User
    
    Returns:
    the builder itself
  - addEntitlements
```
public User.Builder addEntitlements(Collection<Entitlement> entitlements)
```
    Adds a collection of entitlements for the User (See User.getEntitlements()).
    
    Parameters:
    entitlements - the entitlements of the User
    
    Returns:
    the builder itself
  - addEntitlement
```
public User.Builder addEntitlement(Entitlement entitlement)
```
    adds an Entitlement to the User
    
    Parameters:
    entitlement - a Entitlement to add
    
    Returns:
    the builder itself
  - removeEntitlements
```
public User.Builder removeEntitlements()
```
    removes all Entitlements from the actual User
    
    Returns:
    the builder itself
  - removeEntitlement
```
public User.Builder removeEntitlement(Entitlement entitlement)
```
    removes one single Entitlement from the User
    
    Parameters:
    entitlement - a Entitlement to be removed
    
    Returns:
    the builder itself
  - addRoles
```
public User.Builder addRoles(Collection<Role> roles)
```
    Sets a list of roles for the User (See User.getRoles()).
    
    Parameters:
    roles - a list of roles
    
    Returns:
    the builder itself
  - addRole
```
public User.Builder addRole(Role role)
```
    adds an Role to the User
    
    Parameters:
    role - a Role to add
    
    Returns:
    the builder itself
  - removeRoles
```
public User.Builder removeRoles()
```
    removes all Roles from the actual User
    
    Returns:
    the builder itself
  - removeRole
```
public User.Builder removeRole(Role role)
```
    removes one single Role from the User
    
    Parameters:
    role - a Role to be removed
    
    Returns:
    the builder itself
  - addX509Certificates
```
public User.Builder addX509Certificates(Collection<X509Certificate> x509Certificates)
```
    Sets a collection of certificates issued to the User (See User.getX509Certificates()).
    
    Parameters:
    x509Certificates - the certificates of the User
    
    Returns:
    the builder itself
  - addX509Certificate
```
public User.Builder addX509Certificate(X509Certificate x509Certificate)
```
    adds an X509Certificate to the User
    
    Parameters:
    x509Certificate - a X509Certificate to add
    
    Returns:
    the builder itself
  - removeX509Certificates
```
public User.Builder removeX509Certificates()
```
    removes all X509Certificates from the actual User
    
    Returns:
    the builder itself
  - removeX509Certificate
```
public User.Builder removeX509Certificate(X509Certificate x509Certificate)
```
    removes one single X509Certificate from the User
    
    Parameters:
    x509Certificate - a X509Certificate to be removed
    
    Returns:
    the builder itself
  - addExtensions
```
public User.Builder addExtensions(Collection<Extension> extensions)
```
    Adds a collection of Extension to the User (See User.getExtensions()).
    
    Parameters:
    extensions - a collection of extensions
    
    Returns:
    the builder itself
  - addExtension
```
public User.Builder addExtension(Extension extension)
```
    Sets a Extension to the User (See User.getExtension(String)).
    
    Parameters:
    extension - a single Extension
    
    Returns:
    the builder itself
  - removeExtensions
```
public User.Builder removeExtensions()
```
    removes all Extensions from the actual User
    
    Returns:
    the builder itself
  - removeExtension
```
public User.Builder removeExtension(String urn)
```
    removes one single Extension from the User
    
    Parameters:
    urn - the urn from the Extension to be removed
    
    Returns:
    the builder itself
  - setMeta
```
public User.Builder setMeta(Meta meta)
```
    Description copied from class: Resource.Builder
    
    Sets the meta data
    client info: The meta information of a User will be created and set by the OSIAM server. If a User or Group which is send to the OSIAM server has this value filled, the value will be ignored or the action will be rejected. For an update(PATCH) the attribute value can be set by the client. In normal case this should be set by the UpdateUser or UpdateGroup and not by the client directly.
    
    Overrides:
    
    setMeta in class Resource.Builder
    
    Parameters:
    meta - the meta object
    
    Returns:
    the builder itself
  - setExternalId
```
public User.Builder setExternalId(String externalId)
```
    Description copied from class: Resource.Builder
    
    Sets the external id (See Resource.getExternalId()).
    
    Overrides:
    
    setExternalId in class Resource.Builder
    
    Parameters:
    externalId - the external id
    
    Returns:
    the builder itself
  - setId
```
public User.Builder setId(String id)
```
    Description copied from class: Resource.Builder
    
    Sets the id of the resource.
    client info: The id of a User will be created and set by the OSIAM server. If a User or Group which is send to the OSIAM server has this value filled, the value will be ignored or the action will be rejected.
    
    Overrides:
    
    setId in class Resource.Builder
    
    Parameters:
    id - if of the resource
    
    Returns:
    the builder itself
  - setSchemas
```
public User.Builder setSchemas(Set<String> schemas)
```
    Description copied from class: Resource.Builder
    
    sets the schemas of the Resource
    
    Overrides:
    
    setSchemas in class Resource.Builder
    
    Parameters:
    schemas - actual schemas
    
    Returns:
    the builder itself
  - build
```
public User build()
```
    Description copied from class: Resource.Builder
    
    Builds the Object of the Builder
    
    Specified by:
    
    build in class Resource.Builder
    
    Returns:
    a new main Object of the Builder

Class User.Builder

Field Summary

Fields inherited from class org.osiam.resources.scim.Resource.Builder

Constructor Summary

Method Summary

Methods inherited from class org.osiam.resources.scim.Resource.Builder

Methods inherited from class java.lang.Object

Constructor Detail

User.Builder

User.Builder

User.Builder

User.Builder

Method Detail

setName

setDisplayName

setNickName

setProfileUrl

setTitle

setUserType

setPreferredLanguage

setLocale

setTimezone

setActive

setPassword

addEmails

addEmail

removeEmails

removeEmail

addPhoneNumbers

addPhoneNumber

removePhoneNumbers

removePhoneNumber

addIms

addIm

removeIms

removeIm

addPhotos

addPhoto

removePhotos

removePhoto

addAddresses

addAddress

removeAddresses

removeAddress

setGroups

addEntitlements

addEntitlement

removeEntitlements

removeEntitlement

addRoles

addRole

removeRoles

removeRole

addX509Certificates

addX509Certificate

removeX509Certificates

removeX509Certificate

addExtensions

addExtension

removeExtensions

removeExtension

setMeta

setExternalId

setId

setSchemas

build