com.unboundid.scim.data.UserResource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scim-sdk Show documentation
Show all versions of scim-sdk Show documentation
The UnboundID SCIM SDK is a library that may be used to interact with various
types of SCIM-enabled endpoints (such as the UnboundID server products) to
perform lightweight, cloud-based identity management via the SCIM Protocol.
See http://www.simplecloud.info for more information.
/*
* Copyright 2011-2016 UnboundID Corp.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.scim.data;
import com.unboundid.scim.schema.ResourceDescriptor;
import com.unboundid.scim.sdk.InvalidResourceException;
import com.unboundid.scim.sdk.SCIMConstants;
import com.unboundid.scim.sdk.SCIMObject;
import java.util.Collection;
/**
* This class represents a User resource.
*/
public class UserResource extends BaseResource
{
/**
* A ResourceFactory for creating UserResource
* instances.
*/
public static final ResourceFactory USER_RESOURCE_FACTORY =
new ResourceFactory() {
/**
* {@inheritDoc}
*/
public UserResource createResource(
final ResourceDescriptor resourceDescriptor,
final SCIMObject scimObject) {
return new UserResource(resourceDescriptor, scimObject);
}
};
/**
* Construct an empty UserResource with the specified
* ResourceDescriptor.
*
* @param resourceDescriptor The resource descriptor for this SCIM resource.
*/
public UserResource(final ResourceDescriptor resourceDescriptor) {
super(resourceDescriptor);
}
/**
* Construct a UserResource with the specified
* ResourceDescriptor and backed by the given
* SCIMObject.
*
* @param resourceDescriptor The resource descriptor for this SCIM resource.
* @param scimObject The SCIMObject containing all the
* SCIM attributes and their values.
*/
public UserResource(final ResourceDescriptor resourceDescriptor,
final SCIMObject scimObject) {
super(resourceDescriptor, scimObject);
}
/**
* 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).
*
* @return The Unique identifier for the User.
*/
public String getUserName()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"userName", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the Unique identifier for the User.
*
* @param userName The Unique identifier for the User
* @return this resource instance.
*/
public UserResource setUserName(final String userName)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"userName", AttributeValueResolver.STRING_RESOLVER, userName);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the components of the User's real name.
*
* @return The components of the User's real name or null if
* it is not specified.
*/
public Name getName()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"name", Name.NAME_RESOLVER);
}
/**
* Sets the components of the User's real name.
*
* @param name The components of the User's real name.
* @return this resource instance.
*/
public UserResource setName(final Name name)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"name", Name.NAME_RESOLVER, name);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the name of the User, suitable for display to end-users.
*
* @return The name of the User, suitable for display to end-users or
* null if it is not specified.
*/
public String getDisplayName()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"displayName", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the name of the User, suitable for display to end-users.
*
* @param displayName The name of the User, suitable for display to end-users.
* @return this resource instance.
*/
public UserResource setDisplayName(final String displayName)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"displayName", AttributeValueResolver.STRING_RESOLVER, displayName);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the casual way to address the user in real life, e.g. "Bob" or
* "Bobby" instead of "Robert".
*
* @return The casual way to address the user in real life.
*/
public String getNickName()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"nickName", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the casual way to address the user in real life, e.g. "Bob" or
* "Bobby" instead of "Robert".
*
* @param nickName The casual way to address the user in real life.
* @return this resource instance.
*/
public UserResource setNickName(final String nickName)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"nickName", AttributeValueResolver.STRING_RESOLVER, nickName);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the URL to a page representing the User's online profile.
*
* @return The URL to a page representing the User's online profile or
* null if it is not specified.
*/
public String getProfileUrl()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"profileUrl", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the URL to a page representing the User's online profile.
*
* @param url The URL to a page representing the User's online profile.
* @return this resource instance.
*/
public UserResource setProfileUrl(final String url)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"profileUrl", AttributeValueResolver.STRING_RESOLVER, url);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the user's title, such as "Vice President".
*
* @return The user's title or null if it is not specified.
*/
public String getTitle()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"title", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the user's title, such as "Vice President".
*
* @param title The user's title.
* @return this resource instance.
*/
public UserResource setTitle(final String title)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"title", AttributeValueResolver.STRING_RESOLVER, title);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* 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.
*
* @return The the organization to user relationship or null
* if it is not specified.
*/
public String getUserType()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"userType", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the the organization to user relationship.
*
* @param userType The the organization to user relationship.
* @return this resource instance.
*/
public UserResource setUserType(final String userType)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"userType", AttributeValueResolver.STRING_RESOLVER, userType);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the User's preferred written or spoken language. Generally
* used for localizing the interface presented to the user.
*
* @return The User's preferred written or spoken language or
* null if it is not specified.
*/
public String getPreferredLanguage()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"preferredLanguage", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the User's preferred written or spoken language.
*
* @param language The User's preferred written or spoken language.
* @return this resource instance.
*/
public UserResource setPreferredLanguage(final String language)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"preferredLanguage", AttributeValueResolver.STRING_RESOLVER,
language);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the User's default location for purposes of localizing items
* such as currency, date time format, numerical representations, etc.
*
* @return The User's default location for purposes of localizing items or
* null if it is not specified.
*/
public String getLocale()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"locale", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the User's default location for purposes of localizing items.
*
* @param locale The User's default location for purposes of localizing items.
* @return this resource instance.
*/
public UserResource setLocale(final String locale)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"locale", AttributeValueResolver.STRING_RESOLVER, locale);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the User's time zone in the public-domain time zone database
* format; e.g.,'America/Denver'.
*
* @return The User's time zone or null if it is not specified.
*/
public String getTimeZone()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"timezone", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the User's time zone in the public-domain time zone database
* format; e.g.,'America/Denver'.
*
* @param timeZone The User's time zone
* @return this resource instance.
*/
public UserResource setTimeZone(final String timeZone)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"timezone", AttributeValueResolver.STRING_RESOLVER, timeZone);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the User's administrative status.
*
* @return true if the User's administrative status is active or
* false otherwise or null if it is not
* specified.
*/
public Boolean isActive()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"active", AttributeValueResolver.BOOLEAN_RESOLVER);
}
/**
* Sets the User's administrative status.
*
* @param active The User's administrative status.
* @return this resource instance.
*/
public UserResource setActive(final Boolean active)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"active", AttributeValueResolver.BOOLEAN_RESOLVER, active);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* 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.
*
* @return The User's clear text password.
*/
public String getPassword()
{
return getSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"password", AttributeValueResolver.STRING_RESOLVER);
}
/**
* Sets the User's clear text password.
*
* @param password The User's clear text password
* @return this resource instance.
*/
public UserResource setPassword(final String password)
{
try {
setSingularAttributeValue(SCIMConstants.SCHEMA_URI_CORE,
"password", AttributeValueResolver.STRING_RESOLVER, password);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the E-mail addresses for the User.
*
* @return The E-mail addresses for the User or null if it is
* not specified.
*/
public Collection> getEmails()
{
return getAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"emails", Entry.STRINGS_RESOLVER);
}
/**
* Sets the E-mail addresses for the User.
*
* @param emails The E-mail addresses for the User.
* @return this resource instance.
*/
public UserResource setEmails(final Collection> emails)
{
try {
setAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"emails", Entry.STRINGS_RESOLVER, emails);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the Phone numbers for the User.
*
* @return The Phone numbers for the User or null
* if it is not specified.
*/
public Collection> getPhoneNumbers()
{
return getAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"phoneNumbers", Entry.STRINGS_RESOLVER);
}
/**
* Sets the Phone numbers for the User.
*
* @param phoneNumbers The Phone numbers for the User.
* @return this resource instance.
*/
public UserResource setPhoneNumbers(
final Collection> phoneNumbers)
{
try {
setAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"phoneNumbers", Entry.STRINGS_RESOLVER, phoneNumbers);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the Instant messaging address for the User.
*
* @return The Instant messaging address for the User or null
* if it is not specified.
*/
public Collection> getIms()
{
return getAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"ims", Entry.STRINGS_RESOLVER);
}
/**
* Sets the Instant messaging address for the User.
*
* @param ims The Instant messaging address for the User.
* @return this resource instance.
*/
public UserResource setIms(final Collection> ims)
{
try {
setAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"ims", Entry.STRINGS_RESOLVER, ims);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the URL of a photo of the User.
*
* @return The URL of a photo of the User or null if
* it is not specified.
*/
public Collection> getPhotos()
{
return getAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"photos", Entry.STRINGS_RESOLVER);
}
/**
* Sets the URL of a photo of the User.
*
* @param photos The URL of a photo of the User.
* @return this resource instance.
*/
public UserResource setPhotos(final Collection> photos)
{
try {
setAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"photos", Entry.STRINGS_RESOLVER, photos);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the physical mailing address for this User.
*
* @return The physical mailing address for this User or null if
* it is not specified.
*/
public Collection getAddresses()
{
return getAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"addresses", Address.ADDRESS_RESOLVER);
}
/**
* Sets the physical mailing address for this User.
*
* @param addresses The physical mailing address for this User.
* @return this resource instance.
*/
public UserResource setAddresses(final Collection addresses)
{
try {
setAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"addresses", Address.ADDRESS_RESOLVER, addresses);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the list of groups that the user belongs to.
*
* @return The list of groups that the user belongs to or null if
* it is not specified.
*/
public Collection> getGroups()
{
return getAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"groups", Entry.STRINGS_RESOLVER);
}
/**
* Sets the list of groups that the user belongs to.
*
* @param groups The list of groups that the user belongs to.
* @return this resource instance.
*/
public UserResource setGroups(final Collection> groups)
{
try {
setAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"groups", Entry.STRINGS_RESOLVER, groups);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* 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.
*
* @return The list of entitlements for the User or null if
* it is not specified.
*/
public Collection> getEntitlements()
{
return getAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"entitlements", Entry.STRINGS_RESOLVER);
}
/**
* Sets the list of entitlements for the User.
*
* @param entitlements The list of entitlements for the User
* @return this resource instance.
*/
public UserResource setEntitlements(
final Collection> entitlements)
{
try {
setAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"entitlements", Entry.STRINGS_RESOLVER, entitlements);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
/**
* Retrieves the list of roles for the User that collectively represent who
* the User is; e.g., 'Student', "Faculty".
*
* @return The list of roles for the User or null if
* it is not specified.
*/
public Collection> getRoles()
{
return getAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"roles", Entry.STRINGS_RESOLVER);
}
/**
* Sets the list of roles for the User.
*
* @param roles The list of roles for the User.
* @return this resource instance.
*/
public UserResource setRoles(final Collection> roles)
{
try {
setAttributeValues(SCIMConstants.SCHEMA_URI_CORE,
"roles", Entry.STRINGS_RESOLVER, roles);
} catch (InvalidResourceException e) {
// This should never happen as these are core attributes...
throw new RuntimeException(e);
}
return this;
}
}