com.fatwire.assetapi.site

Interface User

@Exported
public interface User

An Object that represents a Content Server user

Method Summary

Modifier and Type	Method and Description
List<String>	getACLs() Get the current user's ACLs
String	getDescription() Gets the user description
String	getEmail() Gets the user email
List<String>	getGroups() Get the user's security Groups
String	getId() Gets the user id
Timestamp	getLastLoggedIn() Get the last logged in time for the user.
Locale	getLocalePreference() Get the prefered Locale for the user
String	getName() Gets the username
Map<String,String>	getOtherAttributes()
String	getPassword() Gets the encrypted password
List<String>	getRoles(String site) Gets the user roles for a given site
Set<String>	getSites() Gets the list of site that the user could access
String	getTimezonePreference() Get the prefered timezone for the user
String	getUserImage() Gets the user image
Map<String,List<Object>>	getUserProperties() Gets the user general properties
void	setACLs(List<String> ACLs) Set the user's ACL
void	setDescription(String desc) Sets the user description
void	setEmail(String email) Sets the user email
void	setId(String id) Sets the user id
void	setLastLoggedIn(Timestamp lastTime) Sets the last logged in time for the user
void	setLocalePreference(Locale locale) Sets the perfered Local for the user
void	setName(String name) Sets the username
void	setPassword(String password) Sets the encrypted password
void	setRoles(String site, List<String> roles) Sets the user roles for a given site, passing null or empty list for roles will result in the user being deleted from the site
void	setTimezonePreference(String timezone) Sets the perfered timezone for the user
void	setUserImage(String base64) Sets the user image as base 64 String

Method Detail

getName

String getName()

Gets the username

Returns:

the String username

setName

void setName(String name)

Sets the username

Parameters:

name - the String username

getPassword

String getPassword()

Gets the encrypted password

Returns:

the String format of the encrypted password

setPassword

void setPassword(String password)

Sets the encrypted password

Parameters:

password - the String format of the encrypted password

getUserImage

String getUserImage()

Gets the user image

Returns:

the base64 string for user image.

setUserImage

void setUserImage(String base64)

Sets the user image as base 64 String

Parameters:

base64 - the base64 string for user image.

getDescription

String getDescription()

Gets the user description

Returns:

the String user description

setDescription

void setDescription(String desc)

Sets the user description

Parameters:

desc - the String format of the user description

getSites

Set<String> getSites()

Gets the list of site that the user could access

Returns:

the list of Site ids

getRoles

List<String> getRoles(String site)

Gets the user roles for a given site

Parameters:

site - there site where the roles would be get for this current user

Returns:

the list of role names for this user at the given site

setRoles

void setRoles(String site,
              List<String> roles)

Sets the user roles for a given site, passing null or empty list for roles will result in the user being deleted from the site

Parameters:

site - the site to set the user roles

roles - the role lists

getId

String getId()

Gets the user id

Returns:

the user id

setId

void setId(String id)

Sets the user id

Parameters:

id - the user id

getEmail

String getEmail()

Gets the user email

Returns:

the user email

setEmail

void setEmail(String email)

Sets the user email

Parameters:

email - the email

getLocalePreference

Locale getLocalePreference()

Get the prefered Locale for the user

Returns:

the Locale

setLocalePreference

void setLocalePreference(Locale locale)

Sets the perfered Local for the user

Parameters:

locale - the Locale

getTimezonePreference

String getTimezonePreference()

Get the prefered timezone for the user

Returns:

the timezone

setTimezonePreference

void setTimezonePreference(String timezone)

Sets the perfered timezone for the user

Parameters:

timezone - the timezone

getUserProperties

Map<String,List<Object>> getUserProperties()

Gets the user general properties

Returns:

the property map

setLastLoggedIn

void setLastLoggedIn(Timestamp lastTime)

Sets the last logged in time for the user

Parameters:

lastTime - last logged

getLastLoggedIn

Timestamp getLastLoggedIn()

Get the last logged in time for the user.

Returns:

timestamp

getACLs

List<String> getACLs()

Get the current user's ACLs

Returns:

the user ACL list

setACLs

void setACLs(List<String> ACLs)

Set the user's ACL

Parameters:

ACLs - the ACL list

getGroups

List<String> getGroups()

Get the user's security Groups

Returns:

the user Group list

getOtherAttributes

Map<String,String> getOtherAttributes()