com.vordel.api.adminusers.model

Class AdminUserRole

java.lang.Object

com.vordel.api.adminusers.model.AdminUserRole

All Implemented Interfaces:

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

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

This class models an admin user role. 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. An admin user has a set of admin user roles which are used when RBAC is applied.

Constructor Summary

Constructors

Constructor and Description
AdminUserRole() Default constructor.
AdminUserRole(java.lang.String id, java.lang.String name) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone()
int	compareTo(AdminUserRole h)
boolean	equals(java.lang.Object other)
java.lang.String	getId() Get the admin user role id.
java.lang.String	getName() Get the admin user role name, e.g.
int	hashCode()
void	setId(java.lang.String id) Set the admin user role id.
void	setName(java.lang.String name) Set the admin user role name.
boolean	valid() Check validity.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminUserRole

public AdminUserRole()

Default constructor.

AdminUserRole

public AdminUserRole(java.lang.String id,
             java.lang.String name)

Constructor

Parameters:

id - The admin user role id.

name - The admin user role name.

Method Detail

getId

public java.lang.String getId()

Get the admin user role id. This is of the form role-n.

Returns:

The id

getName

public java.lang.String getName()

Get the admin user role name, e.g. API Server Administrator.

Returns:

The name

setId

public void setId(java.lang.String id)

Set the admin user role id.

Parameters:

id - The admin user role id.

setName

public void setName(java.lang.String name)

Set the admin user role name.

Parameters:

name - The name

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(AdminUserRole h)

Specified by:

compareTo in interface java.lang.Comparable<AdminUserRole>

valid

public boolean valid()

Check validity. The name must not be null or empty string.

Returns: