com.abiquo.server.core.enterprise

Class UserDto

java.lang.Object

com.abiquo.model.transport.SingleResourceTransportDto

com.abiquo.server.core.enterprise.UserDto

All Implemented Interfaces:

Expandable<PrivilegeDto>, Serializable

Direct Known Subclasses:

UserWithRoleDto

public class UserDto
extends SingleResourceTransportDto
implements Expandable<PrivilegeDto>

The User entity offers the functionality of managing the users of an enterprise in a logical way

Author:

destevezg

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MEDIA_TYPE
static String	MEDIA_TYPE_JSON
static String	MEDIA_TYPE_XML
static String	SHORT_MEDIA_TYPE_JSON
static String	SHORT_MEDIA_TYPE_XML

Fields inherited from class com.abiquo.model.transport.SingleResourceTransportDto

API_VERSION, API_VERSION_20, API_VERSION_22, API_VERSION_23, API_VERSION_24, API_VERSION_26, API_VERSION_27, API_VERSION_28, API_VERSION_29, APPLICATION, editLink, JSON, links, VERSION_PARAM, XML

Constructor Summary

Constructors

Constructor and Description
UserDto()
UserDto(String name, String surname, String email, String nick, String password, String locale, String description) Deprecated. use UserDto(String, String, String, String, String, String, String, String) instead.
UserDto(String name, String surname, String email, String nick, String password, String locale, String description, String authType) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthType() Auth type selected for this user: Abiquo managed or LDAP AuthType value.
String	getAvailableVirtualDatacenters() List with restricted VDCs for this user separated by commas
String	getBaseMediaType()
String	getDescription() A short description of the user
String	getEmail() The contact e-mail address of the user for Abiquo messages
PrivilegesDto	getExpands() This representation might include privileges.
Integer	getId() Identifier for this user
String	getLocale() Locale assigned to this user
String	getMediaType()
String	getName() User's real first name
String	getNick() User name / nickname.
String	getPassword() Password set for this user
String	getPublicSshKey()
String	getSurname() User's real last name
boolean	isActive() Flag indicating if the user is activated or not
void	setActive(boolean active)
void	setAuthType(String authType) AuthType value.
void	setAvailableVirtualDatacenters(String availableVirtualDatacenters)
void	setDescription(String description)
void	setEmail(String email)
void	setExpands(PrivilegesDto expands) This representation might include privileges.
void	setId(Integer id)
void	setLocale(String locale)
void	setName(String name)
void	setNick(String nick)
void	setPassword(String password)
void	setPublicSshKey(String publicSshKey)
void	setSurname(String surname)

Methods inherited from class com.abiquo.model.transport.SingleResourceTransportDto

addEditLink, addLink, addLinks, getEditLink, getIdFromLink, getLinks, modifyLink, searchLink, searchLink, searchLinkByHref, searchLinks, setLinks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MEDIA_TYPE

public static final String MEDIA_TYPE

See Also:

Constant Field Values

SHORT_MEDIA_TYPE_JSON

public static final String SHORT_MEDIA_TYPE_JSON

See Also:

Constant Field Values

SHORT_MEDIA_TYPE_XML

public static final String SHORT_MEDIA_TYPE_XML

See Also:

Constant Field Values

MEDIA_TYPE_XML

public static final String MEDIA_TYPE_XML

See Also:

Constant Field Values

MEDIA_TYPE_JSON

public static final String MEDIA_TYPE_JSON

See Also:

Constant Field Values

Constructor Detail

UserDto

public UserDto()

UserDto

@Deprecated
public UserDto(String name,
                  String surname,
                  String email,
                  String nick,
                  String password,
                  String locale,
                  String description)

Deprecated. use UserDto(String, String, String, String, String, String, String, String) instead.

Constructor.

Parameters:

name - Name.

surname - Surname.

email - Email Address.

nick - Login.

password - Password.

locale - Language.

description - Desc.

UserDto

public UserDto(String name,
       String surname,
       String email,
       String nick,
       String password,
       String locale,
       String description,
       String authType)

Constructor.

Parameters:

name - Name.

surname - Surname.

email - Email Address.

nick - Login.

password - Password.

locale - Language.

description - Desc.

authType - AuthType value.

Method Detail

getAuthType

@NotNull
public String getAuthType()

Auth type selected for this user: Abiquo managed or LDAP AuthType value.

getAvailableVirtualDatacenters

public String getAvailableVirtualDatacenters()

List with restricted VDCs for this user separated by commas

getDescription

public String getDescription()

A short description of the user

getEmail

public String getEmail()

The contact e-mail address of the user for Abiquo messages

getId

public Integer getId()

Identifier for this user

getLocale

public String getLocale()

Locale assigned to this user

getName

@NotNull
public String getName()

User's real first name

getNick

@NotNull
public String getNick()

User name / nickname. The username for login

getPassword

public String getPassword()

Password set for this user

getSurname

public String getSurname()

User's real last name

isActive

@NotNull
public boolean isActive()

Flag indicating if the user is activated or not

setActive

public void setActive(boolean active)

setAuthType

public void setAuthType(String authType)

AuthType value.

Parameters:

authType - AuthType value.

setAvailableVirtualDatacenters

public void setAvailableVirtualDatacenters(String availableVirtualDatacenters)

setDescription

public void setDescription(String description)

setEmail

public void setEmail(String email)

setId

public void setId(Integer id)

setLocale

public void setLocale(String locale)

setName

public void setName(String name)

setNick

public void setNick(String nick)

setPassword

public void setPassword(String password)

setSurname

public void setSurname(String surname)

getExpands

public PrivilegesDto getExpands()

This representation might include privileges.

Specified by:

getExpands in interface Expandable<PrivilegeDto>

Returns:

flat privileges.

setExpands

public void setExpands(PrivilegesDto expands)

This representation might include privileges.

getPublicSshKey

public String getPublicSshKey()

setPublicSshKey

public void setPublicSshKey(String publicSshKey)

getMediaType

public String getMediaType()

Specified by:

getMediaType in class SingleResourceTransportDto

getBaseMediaType

public String getBaseMediaType()

Specified by:

getBaseMediaType in class SingleResourceTransportDto