com.sap.scimono.entity

Class User

java.lang.Object

com.sap.scimono.entity.Resource<User>

com.sap.scimono.entity.User

All Implemented Interfaces:

Serializable

public final class User
extends Resource<User>

User resources are meant to enable expression of common User information. It should be possible to express most user data with the core attributes. If more information need to be saved in a user object the user extension can be used to store all customized data.

For more detailed information please look at the SCIM core schema 2.0, section 6

client info: The scim schema is mainly meant as a connection link between the OSIAM server and a client like the connector4Java. Some values will not be accepted by the OSIAM server. These specific values have an own client info documentation section.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.Builder Builder class that is used to build User instances

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_TYPE_USER
static String	SCHEMA

Fields inherited from class com.sap.scimono.entity.Resource

CORE_SCHEMA

Method Summary

Modifier and Type	Method and Description
User.Builder	builder()
boolean	equals(Object obj)
List<Address>	getAddresses() Gets the physical mailing addresses for this user.
String	getDisplayName() Gets the name of the User, suitable for display to end-users.
List<Email>	getEmails() Gets all E-mail addresses for the User.
List<Entitlement>	getEntitlements() Gets a list of entitlements for the user that represent a thing the User has.
List<GroupRef>	getGroups() Gets a list of groups that the user belongs to.
List<Im>	getIms() Gets the instant messaging address for the user.
String	getLocale() Gets the default location of the User in ISO 639-1 two letter language code, e.g.
Name	getName() Gets the components of the User's real name.
String	getNickName() Gets the casual way to address the user in real life,
String	getPassword() Gets the password from the User.
List<PhoneNumber>	getPhoneNumbers() Gets the phone numbers for the user.
List<Photo>	getPhotos() Gets the URL's of the photos of the user.
String	getPreferredLanguage() Gets the preferred written or spoken language of the User in ISO 3166-1 alpha 2 format, e.g.
Optional<Email>	getPrimaryOrFirstEmail() try to extract an email from the User.
String	getProfileUrl() Gets a fully qualified URL to a page representing the User's online profile.
List<Role>	getRoles() Gets a list of roles for the user that collectively represent who the User is e.g., 'Student', "Faculty"
Set<String>	getSchemas() Gets the list of defined schemas
String	getTimezone() Gets the User's time zone in the "Olson" timezone database format
String	getTitle() The user's title, such as "Vice President."
String	getUserName() Gets the unique identifier for the User.
String	getUserType() Gets the type of the User
List<X509Certificate>	getX509Certificates() Gets a list of certificates issued to the user.
int	hashCode()
Boolean	isActive() Gets a Boolean that indicates the User's administrative status.
String	toString()

Methods inherited from class com.sap.scimono.entity.Resource

getCustomExtensions, getExtension, getExtensions, getExternalId, getId, getMeta, handleExtensionSchema, hasCustomExtensions, hasExtensions, isExtensionPresent

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_TYPE_USER

public static final String RESOURCE_TYPE_USER

See Also:

Constant Field Values

SCHEMA

public static final String SCHEMA

See Also:

Constant Field Values

Method Detail

getUserName

public String getUserName()

Gets the unique identifier for the User.

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the user name

getName

public Name getName()

Gets the components of the User's real name.

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the real Name of the User

getDisplayName

public String getDisplayName()

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

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the display name of the User

getNickName

public String getNickName()

Gets the casual way to address the user in real life,

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the nickname of the User

getProfileUrl

public String getProfileUrl()

Gets a fully qualified URL to a page representing the User's online profile.

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the progile URL of the User

getTitle

public String getTitle()

The user's title, such as "Vice President."

Returns:

the title of the User

getUserType

public String getUserType()

Gets the type of the User

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the type of the User

getPreferredLanguage

public String getPreferredLanguage()

Gets the preferred written or spoken language of the User in ISO 3166-1 alpha 2 format, e.g. "DE" or "US".

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the preferred language of the User

getLocale

public String getLocale()

Gets the default location of the User in ISO 639-1 two letter language code, e.g. 'de_DE' or 'en_US'

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the default location of the User

getTimezone

public String getTimezone()

Gets the User's time zone in the "Olson" timezone database format

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the time zone of the User

isActive

public Boolean isActive()

Gets a Boolean that indicates the User's administrative status.

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the active status of the User

getPassword

public String getPassword()

Gets the password from the User.

For more detailed information please look at the SCIM core schema 2.0, section 6

Returns:

the password of the User

getEmails

public List<Email> getEmails()

Gets all E-mail addresses for the User.

For more detailed information please look at the SCIM core schema 2.0, section 6.2

Returns:

the email addresses of the User

getPrimaryOrFirstEmail

public Optional<Email> getPrimaryOrFirstEmail()

try to extract an email from the User. If the User has a primary email address this email will be returned. If not the first email address found will be returned. If no Email has been found email.isPresent() == false

Returns:

an email if found

getPhoneNumbers

public List<PhoneNumber> getPhoneNumbers()

Gets the phone numbers for the user.

For more detailed information please look at the SCIM core schema 2.0, section 6.2

Returns:

the phone numbers of the User

getIms

public List<Im> getIms()

Gets the instant messaging address for the user.

For more detailed information please look at the SCIM core schema 2.0, section 6.2

Returns:

the ims of the User

getPhotos

public List<Photo> getPhotos()

Gets the URL's of the photos of the user.

For more detailed information please look at the SCIM core schema 2.0, section 6.2

Returns:

the photo URL's of the User

getAddresses

public List<Address> getAddresses()

Gets the physical mailing addresses for this user.

For more detailed information please look at the SCIM core schema 2.0, section 6.2

Returns:

the addresses of the User

getGroups

public List<GroupRef> getGroups()

Gets a list of groups that the user belongs to.

For more detailed information please look at the SCIM core schema 2.0, section 6.2

Returns:

a list of all Groups where the User is a member of

getEntitlements

public List<Entitlement> getEntitlements()

Gets a list of entitlements for the user that represent a thing the User has.

For more detailed information please look at the SCIM core schema 2.0, section 6.2

Returns:

a list of all entitlements of the User

getRoles

public List<Role> getRoles()

Gets a list of roles for the user that collectively represent who the User is e.g., 'Student', "Faculty"

For more detailed information please look at the SCIM core schema 2.0, section 6.2

Returns:

a list of the roles of the User

getX509Certificates

public List<X509Certificate> getX509Certificates()

Gets a list of certificates issued to the user. Values are Binary and DER encoded x509.

For more detailed information please look at the SCIM core schema 2.0, section 6.2

Returns:

a list of the certificates of the User

toString

public String toString()

Overrides:

toString in class Object

getSchemas

@ValidCoreSchema(value="urn:ietf:params:scim:schemas:core:2.0:User")
public Set<String> getSchemas()

Description copied from class: Resource

Gets the list of defined schemas

Overrides:

getSchemas in class Resource<User>

Returns:

a the list of schemas as a Set

builder

public User.Builder builder()

Specified by:

builder in class Resource<User>

hashCode

public int hashCode()

Overrides:

hashCode in class Resource<User>

equals

public boolean equals(Object obj)

Overrides:

equals in class Resource<User>