org.osiam.resources.scim

Class User.Builder

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, schemas

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(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	addExtension(Extension extension) Sets a Extension to the User (See User.getExtension(String)).
User.Builder	addExtensions(Set<Extension> extensions) Sets a List of Extension to the User (See User.getAllExtensions()).
User	build() Builds the Object of the Builder
User.Builder	setActive(Boolean active) Sets a Boolean value indicating the User's administrative status.
User.Builder	setAddresses(List<Address> addresses) Sets the physical mailing addresses for this User (See User.getAddresses()).
User.Builder	setDisplayName(String displayName) Sets the display name (See User.getDisplayName()).
User.Builder	setEmails(List<MultiValuedAttribute> emails) Sets the E-mail addresses for the User (See User.getEmails()).
User.Builder	setEntitlements(List<MultiValuedAttribute> entitlements) Sets a list of entitlements for the User (See User.getEntitlements()).
User.Builder	setExternalId(String externalId) Sets the external id (See Resource.getExternalId()).
User.Builder	setGroups(List<MultiValuedAttribute> groups) Sets a list of groups that the user belongs to (See User.getGroups())
User.Builder	setId(String id) Sets the id of the resource.
User.Builder	setIms(List<MultiValuedAttribute> ims) Sets the instant messaging addresses for the User (See User.getIms()).
User.Builder	setLocale(String locale) Sets the default location of the User (See User.getLocale()).
User.Builder	setMeta(Meta meta) Sets the meta data
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	setPhoneNumbers(List<MultiValuedAttribute> phoneNumbers) Sets the phone numbers for the User (See User.getPhoneNumbers()).
User.Builder	setPhotos(List<MultiValuedAttribute> photos) Sets the URL's of photo's of the User (See User.getPhotos()).
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	setRoles(List<MultiValuedAttribute> roles) Sets a list of roles for the User (See User.getRoles()).
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()).
User.Builder	setX509Certificates(List<MultiValuedAttribute> x509Certificates) Sets a list of certificates issued to the User (See User.getX509Certificates()).

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)

Constructs a new builder by with a set userName

Parameters:

userName - Unique identifier for the User (See User.getUserName())

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

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

setEmails

public User.Builder setEmails(List<MultiValuedAttribute> emails)

Sets the E-mail addresses for the User (See User.getEmails()).

Parameters:

emails - the emails as Set

Returns:

the builder itself

setPhoneNumbers

public User.Builder setPhoneNumbers(List<MultiValuedAttribute> phoneNumbers)

Sets the phone numbers for the User (See User.getPhoneNumbers()).

Parameters:

phoneNumbers - the phone numbers of the the User

Returns:

the builder itself

setIms

public User.Builder setIms(List<MultiValuedAttribute> ims)

Sets the instant messaging addresses for the User (See User.getIms()).

Parameters:

ims - a list of the ims of the User

Returns:

the builder itself

setPhotos

public User.Builder setPhotos(List<MultiValuedAttribute> photos)

Sets the URL's of photo's of the User (See User.getPhotos()).

Parameters:

photos - the photos of the User

Returns:

the builder itself

setAddresses

public User.Builder setAddresses(List<Address> addresses)

Sets the physical mailing addresses for this User (See User.getAddresses()).

Parameters:

addresses - a list of the addresses of the User

Returns:

the builder itself

setGroups

public User.Builder setGroups(List<MultiValuedAttribute> groups)

Sets a list of groups that the user belongs to (See User.getGroups())

Parameters:

groups - groups of the User

Returns:

the builder itself

setEntitlements

public User.Builder setEntitlements(List<MultiValuedAttribute> entitlements)

Sets a list of entitlements for the User (See User.getEntitlements()).

Parameters:

entitlements - the entitlements of the User

Returns:

the builder itself

setRoles

public User.Builder setRoles(List<MultiValuedAttribute> roles)

Sets a list of roles for the User (See User.getRoles()).

Parameters:

roles - a list of roles

Returns:

the builder itself

setX509Certificates

public User.Builder setX509Certificates(List<MultiValuedAttribute> x509Certificates)

Sets a list of certificates issued to the User (See User.getX509Certificates()).

Parameters:

x509Certificates - the certificates of the User

Returns:

the builder itself

addExtensions

public User.Builder addExtensions(Set<Extension> extensions)

Sets a List of Extension to the User (See User.getAllExtensions()).

Parameters:

extensions - a list 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

setMeta

public User.Builder setMeta(Meta meta)

Description copied from class: Resource.Builder

Sets the meta data

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.

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