com.esri.gpt.framework.security.principal
Class Role

java.lang.Object
  com.esri.gpt.framework.security.principal.SecurityPrincipal
      com.esri.gpt.framework.security.principal.Role

public class Role
extends SecurityPrincipal

Represents an application role within the system.

Constructor Summary

Role()
Default constructor.

Role(String key)
Construct with a supplied key.

Method Summary

void	buildFullRoleSet(Roles allRoles) Builds the full role set associated with this role.
RoleSet	getFullRoleSet() Gets full set of role keys applicable to this role.
String	getInherits() Gets the configured inheritance specification string.
void	setInherits(String inherits) Sets the configured inheritance specification string.
String	toString() Returns the string representation of the object.

Methods inherited from class com.esri.gpt.framework.security.principal.SecurityPrincipal

getDistinguishedName, getKey, getLocalID, getName, reset, setDistinguishedName, setKey, setLocalID, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

Role

public Role()

Default constructor.

Role

public Role(String key)

Construct with a supplied key.

Parameters:

key - the key

Method Detail

getFullRoleSet

public RoleSet getFullRoleSet()

Gets full set of role keys applicable to this role.
The set includes this role key, plus all inherited role keys.

Returns:

the full role set

getInherits

public String getInherits()

Gets the configured inheritance specification string.

Returns:

the inheritance string

setInherits

public void setInherits(String inherits)

Sets the configured inheritance specification string.

Parameters:

inherits - the inheritance string

buildFullRoleSet

public void buildFullRoleSet(Roles allRoles)

Builds the full role set associated with this role.
The full role set will contains this role plus all inherited roles.

Parameters:

allRoles - the collection of roles associated with the application configuration

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class SecurityPrincipal

Returns:

the string