com.neurosys.security.auth.domain

Class Role

java.lang.Object

com.neurosys.domain.ModelObject

com.neurosys.security.auth.domain.Role

All Implemented Interfaces:

Serializable

@MappedSuperclass
public class Role
extends ModelObject

Role : Roll-up of various Authorizations for Authorizable components. The Role is an umbrella definition of Authorizations available to the server. If a User is assigned a Role, then the Role is validated against the service and expanded to its actual set of Authorizations.

Equality: Two Roles are equal if their names are exactly equal. While comparing roles their individual compositions are ignored by default. The reason is Authorizations based on role comparisons are usually based on name; the idea of using a Role in the first place is to roll-up into a single name. However this also assumes that role requests are trusted to ask by name. If not, one may want to override this. See equals(Object) for the implementation if this needs to be overriden.

Author:

Arjun Dhar

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Role()
Role(Map<Authorizable,Collection<Authorization>> authorizations)
Role(Role role)
Role(String name)
Role(String name, Map<Authorizable,Collection<Authorization>> authorizations)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Map<Authorizable,Collection<Authorization>>	getAuthorizations() Map for an Authorizable what are the Authorizations this Role represents. The Map itself is transient, if Role to be persisted then save as JSON and marshal/unmarshal to this.
Supplier	getEnvironmentSupplier() When role is active, it loads this context and supplies it to the Session. Example: What is the default page for the Role etc.
String	getName()
int	hashCode()
void	setAuthorizations(Map<Authorizable,Collection<Authorization>> authorizations) Map for an Authorizable what are the Authorizations this Role represents. The Map itself is transient, if Role to be persisted then save as JSON and marshal/unmarshal to this.
void	setName(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

Role

public Role()

Role

public Role(String name)

Role

public Role(Role role)

Role

public Role(Map<Authorizable,Collection<Authorization>> authorizations)

Role

public Role(String name,
            Map<Authorizable,Collection<Authorization>> authorizations)

Method Detail

getName

public String getName()

setName

public void setName(String name)

getAuthorizations

public Map<Authorizable,Collection<Authorization>> getAuthorizations()

Map for an Authorizable what are the Authorizations this Role represents.
The Map itself is transient, if Role to be persisted then save as JSON and marshal/unmarshal to this.

setAuthorizations

public void setAuthorizations(Map<Authorizable,Collection<Authorization>> authorizations)

Map for an Authorizable what are the Authorizations this Role represents.
The Map itself is transient, if Role to be persisted then save as JSON and marshal/unmarshal to this.

getEnvironmentSupplier

public Supplier getEnvironmentSupplier()

When role is active, it loads this context and supplies it to the Session.
Example: What is the default page for the Role etc.

Can be null:

true

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object