org.opensrp.api.domain

Class User

java.lang.Object

org.opensrp.api.domain.BaseDataObject

org.opensrp.api.domain.BaseEntity

org.opensrp.api.domain.User

public class User
extends BaseEntity

The person who actually entered or modified data into system. The User before getting access to any service in system have to be authenticated by system. A user may also be linked with a Provider by BaseEntity

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	User()
	User(String baseEntityId)
	User(String baseEntityId, String username, String password, String salt)
	User(String baseEntityId, String username, String password, String salt, String status, List<String> roles, List<String> permissions)
	User(String baseEntityId, String username, String password, String preferredName, String salt, String status, List<String> roles, List<String> permissions)

Method Summary

Modifier and Type	Method and Description
void	addPermission(String permission)
void	addRole(String role)
String	getPassword()
List<String>	getPermissions()
String	getPreferredName()
List<String>	getRoles()
String	getSalt()
String	getStatus()
String	getUsername()
boolean	hasAdminRights()
boolean	hasPermission(String permission)
boolean	hasRole(String role)
boolean	isDefaultAdmin()
boolean	removePermission(String permission)
boolean	removeRole(String role)
void	setPassword(String password)
void	setPermissions(List<String> permissions) WARNING: Overrides all existing permissions
void	setPreferredName(String preferredName)
void	setRoles(List<String> roles) WARNING: Overrides all existing roles
void	setSalt(String salt)
void	setStatus(String status)
void	setUsername(String username)
String	toString()
User	withPassword(String password)
User	withPermission(String permission)
User	withPermissions(List<String> permissions) WARNING: Overrides all existing permissions
User	withRole(String role)
User	withRoles(List<String> roles) WARNING: Overrides all existing roles
User	withSalt(String salt)
User	withStatus(String status)
User	withUsername(String username)

Methods inherited from class org.opensrp.api.domain.BaseEntity

addAddress, addAttribute, addIdentifier, getAddresses, getAttribute, getAttributes, getBaseEntityId, getIdentifier, getIdentifierMatchingRegex, getIdentifiers, removeAttribute, removeIdentifier, setAddresses, setAttributes, setBaseEntityId, setIdentifiers, withAddress, withAddresses, withAttribute, withAttributes, withBaseEntityId, withIdentifier, withIdentifiers

Methods inherited from class org.opensrp.api.domain.BaseDataObject

getCreator, getDateCreated, getDateEdited, getDateVoided, getEditor, getVoided, getVoider, getVoidReason, setCreator, setDateCreated, setDateEdited, setDateVoided, setEditor, setVoided, setVoider, setVoidReason, withCreator, withDateCreated, withDateEdited, withDateVoided, withEditor, withVoided, withVoider, withVoidReason

Methods inherited from class java.lang.Object

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

Constructor Detail

User

protected User()

User

public User(String baseEntityId)

User

public User(String baseEntityId,
            String username,
            String password,
            String salt)

User

public User(String baseEntityId,
            String username,
            String password,
            String salt,
            String status,
            List<String> roles,
            List<String> permissions)

User

public User(String baseEntityId,
            String username,
            String password,
            String preferredName,
            String salt,
            String status,
            List<String> roles,
            List<String> permissions)

Method Detail

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getSalt

public String getSalt()

setSalt

public void setSalt(String salt)

getStatus

public String getStatus()

setStatus

public void setStatus(String status)

getRoles

public List<String> getRoles()

setRoles

public void setRoles(List<String> roles)

WARNING: Overrides all existing roles

Parameters:

roles -

addRole

public void addRole(String role)

removeRole

public boolean removeRole(String role)

hasRole

public boolean hasRole(String role)

isDefaultAdmin

public boolean isDefaultAdmin()

hasAdminRights

public boolean hasAdminRights()

getPermissions

public List<String> getPermissions()

setPermissions

public void setPermissions(List<String> permissions)

WARNING: Overrides all existing permissions

Parameters:

permissions -

addPermission

public void addPermission(String permission)

removePermission

public boolean removePermission(String permission)

hasPermission

public boolean hasPermission(String permission)

withUsername

public User withUsername(String username)

withPassword

public User withPassword(String password)

withSalt

public User withSalt(String salt)

withStatus

public User withStatus(String status)

withRoles

public User withRoles(List<String> roles)

WARNING: Overrides all existing roles

Parameters:

roles -

Returns:

withRole

public User withRole(String role)

withPermissions

public User withPermissions(List<String> permissions)

WARNING: Overrides all existing permissions

Parameters:

permissions -

Returns:

withPermission

public User withPermission(String permission)

toString

public String toString()

Overrides:

toString in class BaseEntity

getPreferredName

public String getPreferredName()

setPreferredName

public void setPreferredName(String preferredName)