com.vordel.api.adminusers.model

Class AdminUser

java.lang.Object

com.vordel.api.adminusers.model.AdminUser

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<AdminUser>

public class AdminUser
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<AdminUser>

This class models an admin user. Admin users are the users used to perform management operations on the domain. RBAC is applied to all management requests in order to determine if the admin user is allowed to invoke the request.

Constructor Summary

Constructors

Constructor and Description
AdminUser() Default constructor.
AdminUser(java.lang.String id, java.lang.String name, java.util.Collection<java.lang.String> roles) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
int	compareTo(AdminUser h)
boolean	equals(java.lang.Object other)
java.lang.String	getId() Get the admin user id.
java.lang.String	getName() Get the admin user name.
java.util.Collection<java.lang.String>	getRoles() Get the set of admin user roles.
int	hashCode()
void	setId(java.lang.String id) Set the admin user id.
void	setName(java.lang.String name) Set the admin user name.
void	setRoles(java.util.Collection<java.lang.String> roles) Set the admin user roles
boolean	valid() Check admin user is valid, name cannot be null or empty string.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdminUser

public AdminUser()

Default constructor.

AdminUser

public AdminUser(java.lang.String id,
         java.lang.String name,
         java.util.Collection<java.lang.String> roles)

Constructor.

Parameters:

id - The admin user id.

name - The name

roles - The set of roles

Method Detail

getId

public java.lang.String getId()

Get the admin user id. A unique id for the admin user of the form user-n.

Returns:

id

getName

public java.lang.String getName()

Get the admin user name.

Returns:

name

getRoles

public java.util.Collection<java.lang.String> getRoles()

Get the set of admin user roles.

Returns:

Collection of roles

setId

public void setId(java.lang.String id)

Set the admin user id.

Parameters:

id - The id

setName

public void setName(java.lang.String name)

Set the admin user name.

Parameters:

name - The name

setRoles

public void setRoles(java.util.Collection<java.lang.String> roles)

Set the admin user roles

Parameters:

roles - Collection of roles

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(AdminUser h)

Specified by:

compareTo in interface java.lang.Comparable<AdminUser>

valid

public boolean valid()

Check admin user is valid, name cannot be null or empty string.

Returns: