com.unboundid.scim.data
Class UserResource

java.lang.Object
  com.unboundid.scim.data.BaseResource
      com.unboundid.scim.data.UserResource

All Implemented Interfaces:

SCIMResponse

public class UserResource
extends BaseResource

This class represents a User resource.

Field Summary

static ResourceFactory<UserResource>

USER_RESOURCE_FACTORY A ResourceFactory for creating UserResource instances.

Fields inherited from class com.unboundid.scim.data.BaseResource

BASE_RESOURCE_FACTORY

Constructor Summary

UserResource(ResourceDescriptor resourceDescriptor)
Construct an empty UserResource with the specified ResourceDescriptor.

UserResource(ResourceDescriptor resourceDescriptor, SCIMObject scimObject)
Construct a UserResource with the specified ResourceDescriptor and backed by the given SCIMObject.

Method Summary

Collection<Address>	getAddresses() Retrieves the physical mailing address for this User.
String	getDisplayName() Retrieves the name of the User, suitable for display to end-users.
Collection<Entry<String>>	getEmails() Retrieves the E-mail addresses for the User.
Collection<Entry<String>>	getEntitlements() Retrieves the list of entitlements for the User that represent a thing the User has.
Collection<Entry<String>>	getGroups() Retrieves the list of groups that the user belongs to.
Collection<Entry<String>>	getIms() Retrieves the Instant messaging address for the User.
String	getLocale() Retrieves the User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc.
Name	getName() Retrieves the components of the User's real name.
String	getNickName() Retrieves the casual way to address the user in real life, e.g.
String	getPassword() Retrieves the User's clear text password.
Collection<Entry<String>>	getPhoneNumbers() Retrieves the Phone numbers for the User.
Collection<Entry<String>>	getPhotos() Retrieves the URL of a photo of the User.
String	getPreferredLanguage() Retrieves the User's preferred written or spoken language.
String	getProfileUrl() Retrieves the URL to a page representing the User's online profile.
Collection<Entry<String>>	getRoles() Retrieves the list of roles for the User that collectively represent who the User is; e.g., 'Student', "Faculty".
String	getTimeZone() Retrieves the User's time zone in the public-domain time zone database format; e.g.,'America/Denver'.
String	getTitle() Retrieves the user's title, such as "Vice President".
String	getUserName() Retrieves the Unique identifier for the User, typically used by the user to directly authenticate to the service provider.
String	getUserType() Retrieves the the organization to user relationship.
Boolean	isActive() Retrieves the User's administrative status.
UserResource	setActive(Boolean active) Sets the User's administrative status.
UserResource	setAddresses(Collection<Address> addresses) Sets the physical mailing address for this User.
UserResource	setDisplayName(String displayName) Sets the name of the User, suitable for display to end-users.
UserResource	setEmails(Collection<Entry<String>> emails) Sets the E-mail addresses for the User.
UserResource	setEntitlements(Collection<Entry<String>> entitlements) Sets the list of entitlements for the User.
UserResource	setGroups(Collection<Entry<String>> groups) Sets the list of groups that the user belongs to.
UserResource	setIms(Collection<Entry<String>> ims) Sets the Instant messaging address for the User.
UserResource	setLocale(String locale) Sets the User's default location for purposes of localizing items.
UserResource	setName(Name name) Sets the components of the User's real name.
UserResource	setNickName(String nickName) Sets the casual way to address the user in real life, e.g.
UserResource	setPassword(String password) Sets the User's clear text password.
UserResource	setPhoneNumbers(Collection<Entry<String>> phoneNumbers) Sets the Phone numbers for the User.
UserResource	setPhotos(Collection<Entry<String>> photos) Sets the URL of a photo of the User.
UserResource	setPreferredLanguage(String language) Sets the User's preferred written or spoken language.
UserResource	setProfileUrl(String url) Sets the URL to a page representing the User's online profile.
UserResource	setRoles(Collection<Entry<String>> roles) Sets the list of roles for the User.
UserResource	setTimeZone(String timeZone) Sets the User's time zone in the public-domain time zone database format; e.g.,'America/Denver'.
UserResource	setTitle(String title) Sets the user's title, such as "Vice President".
UserResource	setUserName(String userName) Sets the Unique identifier for the User.
UserResource	setUserType(String userType) Sets the the organization to user relationship.

Methods inherited from class com.unboundid.scim.data.BaseResource

equals, getAttributeValues, getExternalId, getId, getMeta, getResourceDescriptor, getScimObject, getSingularAttributeValue, hashCode, marshal, setAttributeValues, setExternalId, setId, setMeta, setSingularAttributeValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

USER_RESOURCE_FACTORY

public static final ResourceFactory<UserResource> USER_RESOURCE_FACTORY

A ResourceFactory for creating UserResource instances.

Constructor Detail

UserResource

public UserResource(ResourceDescriptor resourceDescriptor)

Construct an empty UserResource with the specified ResourceDescriptor.

Parameters:

resourceDescriptor - The resource descriptor for this SCIM resource.

UserResource

public UserResource(ResourceDescriptor resourceDescriptor,
                    SCIMObject scimObject)

Construct a UserResource with the specified ResourceDescriptor and backed by the given SCIMObject.

Parameters:

resourceDescriptor - The resource descriptor for this SCIM resource.

scimObject - The SCIMObject containing all the SCIM attributes and their values.

Method Detail

getUserName

public String getUserName()

Retrieves the Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Often displayed to the user as their unique identifier within the system (as opposed to id o r externalId, which are generally opaque and not user-friendly identifiers).

Returns:

The Unique identifier for the User.

setUserName

public UserResource setUserName(String userName)

Sets the Unique identifier for the User.

Parameters:

userName - The Unique identifier for the User

Returns:

this resource instance.

getName

public Name getName()

Retrieves the components of the User's real name.

Returns:

The components of the User's real name or null if it is not specified.

setName

public UserResource setName(Name name)

Sets the components of the User's real name.

Parameters:

name - The components of the User's real name.

Returns:

this resource instance.

getDisplayName

public String getDisplayName()

Retrieves the name of the User, suitable for display to end-users.

Returns:

The name of the User, suitable for display to end-users or null if it is not specified.

setDisplayName

public UserResource setDisplayName(String displayName)

Sets the name of the User, suitable for display to end-users.

Parameters:

displayName - The name of the User, suitable for display to end-users.

Returns:

this resource instance.

getNickName

public String getNickName()

Retrieves the casual way to address the user in real life, e.g. "Bob" or "Bobby" instead of "Robert".

Returns:

The casual way to address the user in real life.

setNickName

public UserResource setNickName(String nickName)

Sets the casual way to address the user in real life, e.g. "Bob" or "Bobby" instead of "Robert".

Parameters:

nickName - The casual way to address the user in real life.

Returns:

this resource instance.

getProfileUrl

public String getProfileUrl()

Retrieves the URL to a page representing the User's online profile.

Returns:

The URL to a page representing the User's online profile or null if it is not specified.

setProfileUrl

public UserResource setProfileUrl(String url)

Sets the URL to a page representing the User's online profile.

Parameters:

url - The URL to a page representing the User's online profile.

Returns:

this resource instance.

getTitle

public String getTitle()

Retrieves the user's title, such as "Vice President".

Returns:

The user's title or null if it is not specified.

setTitle

public UserResource setTitle(String title)

Sets the user's title, such as "Vice President".

Parameters:

title - The user's title.

Returns:

this resource instance.

getUserType

public String getUserType()

Retrieves the the organization to user relationship. Typical values used might be "Contractor", "Employee", "Intern", "Temp", "External", and "Unknown" but any value may be used.

Returns:

The the organization to user relationship or null if it is not specified.

setUserType

public UserResource setUserType(String userType)

Sets the the organization to user relationship.

Parameters:

userType - The the organization to user relationship.

Returns:

this resource instance.

getPreferredLanguage

public String getPreferredLanguage()

Retrieves the User's preferred written or spoken language. Generally used for localizing the interface presented to the user.

Returns:

The User's preferred written or spoken language or null if it is not specified.

setPreferredLanguage

public UserResource setPreferredLanguage(String language)

Sets the User's preferred written or spoken language.

Parameters:

language - The User's preferred written or spoken language.

Returns:

this resource instance.

getLocale

public String getLocale()

Retrieves the User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc.

Returns:

The User's default location for purposes of localizing items or null if it is not specified.

setLocale

public UserResource setLocale(String locale)

Sets the User's default location for purposes of localizing items.

Parameters:

locale - The User's default location for purposes of localizing items.

Returns:

this resource instance.

getTimeZone

public String getTimeZone()

Retrieves the User's time zone in the public-domain time zone database format; e.g.,'America/Denver'.

Returns:

The User's time zone or null if it is not specified.

setTimeZone

public UserResource setTimeZone(String timeZone)

Sets the User's time zone in the public-domain time zone database format; e.g.,'America/Denver'.

Parameters:

timeZone - The User's time zone

Returns:

this resource instance.

isActive

public Boolean isActive()

Retrieves the User's administrative status.

Returns:

true if the User's administrative status is active or false otherwise or null if it is not specified.

setActive

public UserResource setActive(Boolean active)

Sets the User's administrative status.

Parameters:

active - The User's administrative status.

Returns:

this resource instance.

getPassword

public String getPassword()

Retrieves the User's clear text password. This is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password. This will never be returned by the service provider.

Returns:

The User's clear text password.

setPassword

public UserResource setPassword(String password)

Sets the User's clear text password.

Parameters:

password - The User's clear text password

Returns:

this resource instance.

getEmails

public Collection<Entry<String>> getEmails()

Retrieves the E-mail addresses for the User.

Returns:

The E-mail addresses for the User or null if it is not specified.

setEmails

public UserResource setEmails(Collection<Entry<String>> emails)

Sets the E-mail addresses for the User.

Parameters:

emails - The E-mail addresses for the User.

Returns:

this resource instance.

getPhoneNumbers

public Collection<Entry<String>> getPhoneNumbers()

Retrieves the Phone numbers for the User.

Returns:

The Phone numbers for the User or null if it is not specified.

setPhoneNumbers

public UserResource setPhoneNumbers(Collection<Entry<String>> phoneNumbers)

Sets the Phone numbers for the User.

Parameters:

phoneNumbers - The Phone numbers for the User.

Returns:

this resource instance.

getIms

public Collection<Entry<String>> getIms()

Retrieves the Instant messaging address for the User.

Returns:

The Instant messaging address for the User or null if it is not specified.

setIms

public UserResource setIms(Collection<Entry<String>> ims)

Sets the Instant messaging address for the User.

Parameters:

ims - The Instant messaging address for the User.

Returns:

this resource instance.

getPhotos

public Collection<Entry<String>> getPhotos()

Retrieves the URL of a photo of the User.

Returns:

The URL of a photo of the User or null if it is not specified.

setPhotos

public UserResource setPhotos(Collection<Entry<String>> photos)

Sets the URL of a photo of the User.

Parameters:

photos - The URL of a photo of the User.

Returns:

this resource instance.

getAddresses

public Collection<Address> getAddresses()

Retrieves the physical mailing address for this User.

Returns:

The physical mailing address for this User or null if it is not specified.

setAddresses

public UserResource setAddresses(Collection<Address> addresses)

Sets the physical mailing address for this User.

Parameters:

addresses - The physical mailing address for this User.

Returns:

this resource instance.

getGroups

public Collection<Entry<String>> getGroups()

Retrieves the list of groups that the user belongs to.

Returns:

The list of groups that the user belongs to or null if it is not specified.

setGroups

public UserResource setGroups(Collection<Entry<String>> groups)

Sets the list of groups that the user belongs to.

Parameters:

groups - The list of groups that the user belongs to.

Returns:

this resource instance.

getEntitlements

public Collection<Entry<String>> getEntitlements()

Retrieves the list of entitlements for the User that represent a thing the User has. That is, an entitlement is an additional right to a thing, object or service.

Returns:

The list of entitlements for the User or null if it is not specified.

setEntitlements

public UserResource setEntitlements(Collection<Entry<String>> entitlements)

Sets the list of entitlements for the User.

Parameters:

entitlements - The list of entitlements for the User

Returns:

this resource instance.

getRoles

public Collection<Entry<String>> getRoles()

Retrieves the list of roles for the User that collectively represent who the User is; e.g., 'Student', "Faculty".

Returns:

The list of roles for the User or null if it is not specified.

setRoles

public UserResource setRoles(Collection<Entry<String>> roles)

Sets the list of roles for the User.

Parameters:

roles - The list of roles for the User.

Returns:

this resource instance.