Package org.openwms.core.uaa.impl

Class Role

java.lang.Object

org.ameba.integration.jpa.BaseEntity

org.ameba.integration.jpa.ApplicationEntity

org.openwms.core.uaa.impl.SecurityObject

org.openwms.core.uaa.impl.Role

All Implemented Interfaces:

Serializable, org.ameba.integration.TypedEntity<Long>

@Entity
public class Role
extends SecurityObject
implements Serializable

A Role is a group of Users. Basically more than one User belong to a Role. Security access policies are assigned to Roles instead of Users.

Author:

Heiko Scherrer

See Also:

• SecurityObject
• User
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Role.Builder	A builder class to construct Role instances.

Field Summary

Fields

Modifier and Type	Field	Description
private Set<SecurityObject>	grants	All SecurityObjects assigned to the Role.
private Boolean	immutable	Whether or not this Role is immutable.
static final String	NOT_ALLOWED_TO_CREATE_A_ROLE_WITH_AN_EMPTY_NAME
static final String	ROLE_PREFIX	The default prefix String for each created Role.
private Set<User>	users	All Users assigned to the Role.

Fields inherited from class org.ameba.integration.jpa.ApplicationEntity

C_ID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Role()	Dear JPA...
	Role(String name)	Create a new Role with a name.
	Role(String name, String description)	Create a new Role with a name and a description.

Method Summary

Modifier and Type	Method	Description
boolean	addGrant(SecurityObject grant)	Add an existing SecurityObject to the Role.
void	addGrants(Set<SecurityObject> grants)	Add existing SecurityObjects to the Role.
boolean	addUser(User user)	Add an existing User to the Role.
void	addUsers(Set<User> users)	Add existing Users to the Role.
boolean	equals(Object obj)	Compare the name.
Set<SecurityObject>	getGrants()	Return a Set of all SecurityObjects belonging to the Role.
Boolean	getImmutable()	Get the immutable.
Set<User>	getUsers()	Return a Set of all Users assigned to the Role.
int	hashCode()
String	normalizeName(String name)
boolean	removeGrant(SecurityObject grant)	Add an existing SecurityObject to the Role.
boolean	removeGrants(List<? extends SecurityObject> grants)	Add an existing SecurityObject to the Role.
void	removeUser(User user)	Remove a User from the Role.
void	setGrants(Set<SecurityObject> grants)	Set all SecurityObjects assigned to the Role.
void	setImmutable(Boolean immutable)	Set the Role as immutable.
protected void	setName(String name)
void	setPersistentKey(String pKey)
void	setUsers(Set<User> users)	Set all Users belonging to this Role.

Methods inherited from class org.openwms.core.uaa.impl.SecurityObject

getDescription, getName, setDescription, toString

Methods inherited from class org.ameba.integration.jpa.ApplicationEntity

getPersistentKey, hasPersistentKey, onEntityPersist, onPersist

Methods inherited from class org.ameba.integration.jpa.BaseEntity

getCreatedBy, getCreateDt, getLastModifiedBy, getLastModifiedDt, getOl, getPk, isNew, setCreatedBy, setCreateDt, setLastModifiedBy, setLastModifiedDt, setOl

Methods inherited from class java.lang.Object

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

Field Details

NOT_ALLOWED_TO_CREATE_A_ROLE_WITH_AN_EMPTY_NAME

public static final String NOT_ALLOWED_TO_CREATE_A_ROLE_WITH_AN_EMPTY_NAME

See Also:

• Constant Field Values

immutable

private Boolean immutable

Whether or not this Role is immutable. Immutable Roles can't be modified.

users

private Set<User> users

All Users assigned to the Role.

grants

private Set<SecurityObject> grants

All SecurityObjects assigned to the Role.

ROLE_PREFIX

public static final String ROLE_PREFIX

The default prefix String for each created Role. Name is "ROLE_" .

See Also:

• Constant Field Values

Constructor Details

Role

protected Role()

Dear JPA...

Role

public Role(String name)

Create a new Role with a name.

Parameters:

name - The name of the Role

Throws:

IllegalArgumentException - when name is null or empty

Role

public Role(String name,
 String description)

Create a new Role with a name and a description.

Parameters:

name - The name of the Role

description - The description text of the Role

Throws:

IllegalArgumentException - when name is null or empty

Method Details

normalizeName

public String normalizeName(String name)

setPersistentKey

public void setPersistentKey(String pKey)

Overrides:

setPersistentKey in class SecurityObject

setName

protected void setName(String name)

Overrides:

setName in class SecurityObject

getImmutable

public Boolean getImmutable()

Get the immutable.

Returns:

the immutable.

setImmutable

public void setImmutable(Boolean immutable)

Set the Role as immutable.

Parameters:

immutable - true if so

getUsers

public Set<User> getUsers()

Return a Set of all Users assigned to the Role.

Returns:

A Set of all Users assigned to the Role

addUser

public boolean addUser(User user)

Add an existing User to the Role.

Parameters:

user - The User to be added

Returns:

true if the User was new in the collection of Users, otherwise false

Throws:

IllegalArgumentException - if user is null

addUsers

public void addUsers(Set<User> users)

Add existing Users to the Role.

Parameters:

users - A Set of Users to be added to the Role

Throws:

IllegalArgumentException - if grants is null

removeUser

public void removeUser(User user)

Remove a User from the Role.

Parameters:

user - The User to be removed

Throws:

IllegalArgumentException - if user is null

setUsers

public void setUsers(Set<User> users)

Set all Users belonging to this Role.

Parameters:

users - A Set of Users to be assigned to the Role

Throws:

IllegalArgumentException - if users is null

getGrants

public Set<SecurityObject> getGrants()

Return a Set of all SecurityObjects belonging to the Role.

Returns:

A Set of all SecurityObjects belonging to this Role

addGrant

public boolean addGrant(SecurityObject grant)

Add an existing SecurityObject to the Role.

Parameters:

grant - The SecurityObject to be added to the Role.

Returns:

true if the SecurityObject was new to the collection of SecurityObjects, otherwise false

Throws:

IllegalArgumentException - if grant is null

addGrants

public void addGrants(Set<SecurityObject> grants)

Add existing SecurityObjects to the Role.

Parameters:

grants - A Set of SecurityObjects to be added to the Role

Throws:

IllegalArgumentException - if grants is null

removeGrant

public boolean removeGrant(SecurityObject grant)

Add an existing SecurityObject to the Role.

Parameters:

grant - The SecurityObject to be added to the Role

Returns:

true if the SecurityObject was successfully removed from the Set of SecurityObjects, otherwise false

Throws:

IllegalArgumentException - if grant is null

removeGrants

public boolean removeGrants(List<? extends SecurityObject> grants)

Add an existing SecurityObject to the Role.

Parameters:

grants - A list of SecurityObjects to be removed from the Role

Returns:

true if the SecurityObject was successfully removed from the Set of SecurityObjects, otherwise false

Throws:

IllegalArgumentException - if grants is null

setGrants

public void setGrants(Set<SecurityObject> grants)

Set all SecurityObjects assigned to the Role. Already existing SecurityObjects will be removed.

Parameters:

grants - A Set of SecurityObjects to be assigned to the Role

Throws:

IllegalArgumentException - if grants is null

hashCode

public int hashCode()

Delegates to the superclass and uses the hashCode of the String ROLE for calculation.

Overrides:

hashCode in class SecurityObject

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Compare the name.

Does not delegate to the SecurityObject.equals(Object) and uses the name for comparison.

Overrides:

equals in class SecurityObject

See Also:

• Object.equals(java.lang.Object)