com.appiancorp.suiteapi.common

Class RoleMap

java.lang.Object

com.appiancorp.suiteapi.common.RoleMap

All Implemented Interfaces:

XMLable, java.io.Serializable, java.util.Map

Direct Known Subclasses:

AdminConsoleRoleMap, CollaborationRoleMap, ContentRoleMap, ProcessApplicationRoleMap, ProcessRoleMap, PublicRoleMap, ThreadRoleMap

public class RoleMap
extends java.lang.Object
implements java.util.Map, XMLable, java.io.Serializable

A mapping of roles and the users and groups that fill those roles.

N.B. The ComplexForeignKey.requiredByIxSpec() for groups is set true in RoleBinder.getRefMd(Role, ReferenceContext, boolean) in order to prevent the import of objects referencing missing security groups.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AGGREGATE_SECURITY_KEY
static java.lang.String	SECURITY_KEY
static java.lang.String	TYPE_AGGREGATE_GROUP
static java.lang.String	TYPE_AGGREGATE_USER
static java.lang.String	TYPE_GROUP
static java.lang.String	TYPE_GROUP_UUIDS
static java.lang.String	TYPE_USER
static java.lang.String	TYPE_USER_UUIDS

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
RoleMap()

Method Summary

Modifier and Type	Method and Description
void	addActorsToRole(java.lang.String role_, java.lang.String type_, java.lang.Long[] id_) Adds groups to the specified role.
void	addActorsToRole(java.lang.String role_, java.lang.String type_, java.lang.String[] id_) Adds users to the specified role.
void	clear() Removes all roles and actors.
boolean	containsActors() Returns true if there are actors in any role of the role map.
boolean	containsKey(java.lang.Object key_) Returns whether this role map contains the role specified.
boolean	containsValue(java.lang.Object value_) Not implemented.
java.util.Set	entrySet() Returns all of the entries in the role map.
boolean	equals(java.lang.Object obj) Compares this role map with another, and returns whether this role map contains exactly the same data as the other.
java.lang.Object	get(java.lang.Object key_) Returns the actors at the particular role.
java.lang.Object[]	getActorsInRole(java.lang.String role_, java.lang.String type_) Returns all of the actors at the given role and of the given type.
java.lang.Integer	getAggregateSecurity() Gets the aggregate security bitmap for the object.
java.util.Set<java.lang.Long>	getAllGroupIds() Returns all the group ids in this role map.
java.util.Set<java.lang.String>	getAllUsernames() Returns all the usernames in this role map.
protected Role	getRole(java.lang.String roleName)
protected java.lang.String[]	getRoleNames()
Role[]	getRoles() Returns an array of Role objects for all the roles stored in this role map.
java.lang.Integer	getSecurity() Gets the security bitmap for the object.
int	hashCode() Returns a hash code for the role map.
protected void	init(RoleMap rm)
boolean	isEmpty() Returns whether this role map contains no roles.
java.util.Set	keySet() Returns all of the roles in the role map.
void	mergeWith(RoleMap newRM) Merges this role map with the given new role map.
java.lang.Object	put(java.lang.Object key_, java.lang.Object value_) Returns the users and groups in the given role.
void	putAll(java.util.Map t_) Not supported.
java.lang.Object	remove(java.lang.Object key_) Remove all users and groups at the role.
void	removeActorsFromRole(java.lang.String role_, java.lang.String type_, java.lang.Long[] id_) Removes groups from the specified role.
void	removeActorsFromRole(java.lang.String role_, java.lang.String type_, java.lang.String[] id_) Removes users from the specified role.
protected void	removeAllRoles()
void	setActorsInRole(java.lang.String role_, java.lang.String type_, java.lang.Long[] id_) Sets the actors in the given role at the given type.
void	setActorsInRole(java.lang.String role_, java.lang.String type_, java.lang.String[] id_) Sets the actors in the specified role.
void	setAggregateSecurity(java.lang.Integer aggregateSecurity_) Sets the aggregate security bitmap for the object.
protected void	setRole(Role role)
void	setRoles(java.util.Collection<? extends Role> rolesSet) Removes any roles that are currently set and sets the roles to the given data.
void	setRoles(Role[] roles) Removes any roles that are currently set and sets the roles to the given data.
void	setSecurity(java.lang.Integer security_) Sets the security bitmap for the object.
int	size() Returns the number of roles in the role map.
java.lang.String	toString()
java.lang.String	toXML() Converts this role map to xml and returns it as a string.
void	toXML(java.lang.StringBuilder buffer_) Converts this role map node to XML and stores it in a StringBuilder.
java.util.Collection	values() Returns all of the users and groups at any roles.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

toXML

Field Detail

TYPE_USER

public static final java.lang.String TYPE_USER

See Also:

Constant Field Values

TYPE_USER_UUIDS

public static final java.lang.String TYPE_USER_UUIDS

See Also:

Constant Field Values

TYPE_AGGREGATE_USER

public static final java.lang.String TYPE_AGGREGATE_USER

See Also:

Constant Field Values

TYPE_GROUP

public static final java.lang.String TYPE_GROUP

See Also:

Constant Field Values

TYPE_GROUP_UUIDS

public static final java.lang.String TYPE_GROUP_UUIDS

See Also:

Constant Field Values

TYPE_AGGREGATE_GROUP

public static final java.lang.String TYPE_AGGREGATE_GROUP

See Also:

Constant Field Values

SECURITY_KEY

public static final java.lang.String SECURITY_KEY

See Also:

Constant Field Values

AGGREGATE_SECURITY_KEY

public static final java.lang.String AGGREGATE_SECURITY_KEY

See Also:

Constant Field Values

Constructor Detail

RoleMap

public RoleMap()

Method Detail

init

protected void init(RoleMap rm)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXML

public java.lang.String toXML()

Converts this role map to xml and returns it as a string.

Specified by:

toXML in interface XMLable

Returns:

a String containing the XML serialization of this palette item

toXML

public void toXML(java.lang.StringBuilder buffer_)

Converts this role map node to XML and stores it in a StringBuilder.

Specified by:

toXML in interface XMLable

Parameters:

buffer_ - the StringBuilder to append the XML to

size

public int size()

Returns the number of roles in the role map.

Specified by:

size in interface java.util.Map

Returns:

the number of roles in the role map

isEmpty

public boolean isEmpty()

Returns whether this role map contains no roles.

Specified by:

isEmpty in interface java.util.Map

Returns:

true if the map contains no roles; false otherwise

containsKey

public boolean containsKey(java.lang.Object key_)

Returns whether this role map contains the role specified.

Specified by:

containsKey in interface java.util.Map

Parameters:

key_ - the role to check for

Returns:

true if the map contains the specified role; false otherwise

containsValue

public boolean containsValue(java.lang.Object value_)

Not implemented.

Specified by:

containsValue in interface java.util.Map

Parameters:

value_ - The object to look for.

Returns:

false

get

public java.lang.Object get(java.lang.Object key_)

Returns the actors at the particular role.

Specified by:

get in interface java.util.Map

Parameters:

key_ - the role to get the actors at

Returns:

a Map containing the users and groups, where the keys are the types TYPE_USER or TYPE_GROUP and the values are Array objects of usernames (Strings) and group IDs (Longs) respectively.

put

public java.lang.Object put(java.lang.Object key_,
                            java.lang.Object value_)

Returns the users and groups in the given role.

Specified by:

put in interface java.util.Map

Parameters:

key_ - the role

value_ - a Map containing the users and groups, where the keys are the types TYPE_USER or TYPE_GROUP and the values are Array objects of usernames (Strings) and group IDs (Longs) respectively.

Returns:

the previous value

remove

public java.lang.Object remove(java.lang.Object key_)

Remove all users and groups at the role.

Specified by:

remove in interface java.util.Map

Parameters:

key_ - The key of the object to remove from the role map.

Returns:

a Map with the previous users and groups in the role, where the keys are the types (TYPE_USER or TYPE_GROUP) and the values are Array objects of usernames (Strings) and group IDs (Longs) respectively.

putAll

public void putAll(java.util.Map t_)

Not supported.

Specified by:

putAll in interface java.util.Map

Parameters:

t_ - value does not matter

Throws:

UnsupportedOperatorException - always

clear

public void clear()

Removes all roles and actors.

Specified by:

clear in interface java.util.Map

keySet

public java.util.Set keySet()

Returns all of the roles in the role map.

Specified by:

keySet in interface java.util.Map

Returns:

a Set containing the roles

values

public java.util.Collection values()

Returns all of the users and groups at any roles.

Specified by:

values in interface java.util.Map

Returns:

a Collection containing all of the user and group Map objects, where for each Map, the keys are the types TYPE_USER or TYPE_GROUP and the values are Array objects of usernames (Strings) and group IDs (Longs) respectively.

entrySet

public java.util.Set entrySet()

Returns all of the entries in the role map.

Specified by:

entrySet in interface java.util.Map

Returns:

a Set containing Map.Entry objects, where the keys in the entries are the roles, and the values are the Map objects

See Also:

values()

equals

public boolean equals(java.lang.Object obj)

Compares this role map with another, and returns whether this role map contains exactly the same data as the other.

Specified by:

equals in interface java.util.Map

Overrides:

equals in class java.lang.Object

Parameters:

obj - the other role map

Returns:

true, if this rolemap equals o_; else false

hashCode

public int hashCode()

Returns a hash code for the role map.

Specified by:

hashCode in interface java.util.Map

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

getActorsInRole

public java.lang.Object[] getActorsInRole(java.lang.String role_,
                                          java.lang.String type_)

Returns all of the actors at the given role and of the given type.

Parameters:

role_ - the role to get users for

type_ - TYPE_USER or TYPE_GROUP

Returns:

an Array of the actor IDs (String for users, Long for groups)

See Also:

setActorsInRole(String, String, String[])

containsActors

public boolean containsActors()

Returns true if there are actors in any role of the role map.

Returns:

true if there are actors in any role of the role map

setActorsInRole

public void setActorsInRole(java.lang.String role_,
                            java.lang.String type_,
                            java.lang.Long[] id_)

Sets the actors in the given role at the given type.

Parameters:

role_ - the role. This parameter is required.

type_ - should always be TYPE_GROUP

id_ - the group ids

Throws:

java.lang.NullPointerException - if the role is not specified.

See Also:

getActorsInRole(String, String)

setActorsInRole

public void setActorsInRole(java.lang.String role_,
                            java.lang.String type_,
                            java.lang.String[] id_)

Sets the actors in the specified role.

Parameters:

role_ - the role. This parameter is required.

type_ - should always be TYPE_USER

id_ - the usernames of the users

Throws:

java.lang.NullPointerException - if the role is not specified.

See Also:

getActorsInRole(String, String)

addActorsToRole

public void addActorsToRole(java.lang.String role_,
                            java.lang.String type_,
                            java.lang.Long[] id_)
                     throws java.lang.NullPointerException

Adds groups to the specified role.

Parameters:

role_ - the role. This parameter is required. Example: ContentRoleMap.AUTHOR, ContentRoleMap.VIEWER...

type_ - should always be RoleMap.TYPE_GROUP

id_ - the group ids

Throws:

java.lang.NullPointerException - if the role is not specified.

addActorsToRole

public void addActorsToRole(java.lang.String role_,
                            java.lang.String type_,
                            java.lang.String[] id_)
                     throws java.lang.NullPointerException

Adds users to the specified role.

Parameters:

role_ - the role. This parameter is required. Example: ContentRoleMap.AUTHOR, ContentRoleMap.VIEWER...

type_ - should always be RoleMap.TYPE_USER

id_ - the usernames of the users to add

Throws:

java.lang.NullPointerException - if the role is not specified.

removeActorsFromRole

public void removeActorsFromRole(java.lang.String role_,
                                 java.lang.String type_,
                                 java.lang.Long[] id_)

Removes groups from the specified role.

Parameters:

role_ - the role

type_ - should always be TYPE_GROUP

id_ - the group ids to remove

removeActorsFromRole

public void removeActorsFromRole(java.lang.String role_,
                                 java.lang.String type_,
                                 java.lang.String[] id_)

Removes users from the specified role.

Parameters:

role_ - the role

type_ - should always be TYPE_USER

id_ - the usernames to remove

setSecurity

public void setSecurity(java.lang.Integer security_)

Sets the security bitmap for the object. Only currently exists for Content. For possible values for Content, see ContentConstants.SEC_XXX. May be null

Parameters:

security_ - the security map

See Also:

getSecurity()

getSecurity

public java.lang.Integer getSecurity()

Gets the security bitmap for the object. Only currently exists for Content. For possible values for Content, see ContentConstants.SEC_XXX. May be null

Returns:

the security map

See Also:

setSecurity(Integer)

setAggregateSecurity

public void setAggregateSecurity(java.lang.Integer aggregateSecurity_)

Sets the aggregate security bitmap for the object. Only currently exists for Content. For possible values for Content, see ContentConstants.SEC_XXX. May be null

Parameters:

aggregateSecurity_ - the aggregate security map

See Also:

getAggregateSecurity()

getAggregateSecurity

public java.lang.Integer getAggregateSecurity()

Gets the aggregate security bitmap for the object. Only currently exists for Content. For possible values for Content, see ContentConstants.SEC_XXX. May be null

Returns:

the aggregate security map

See Also:

setAggregateSecurity(Integer)

mergeWith

public void mergeWith(RoleMap newRM)

Merges this role map with the given new role map. Only the fields TYPE_USER and TYPE_GROUP are merged. All other fields are left unchanged. The following rules are used to merge the users and groups:

1. The merged role map should be the union of the existing and new role maps.
2. When the same user/group is present in both the existing and new role maps, the role from the NEW role map should be used for the user/group.

Parameters:

newRM - The new role map to merge with this (existing/old) role map.

getAllGroupIds

public java.util.Set<java.lang.Long> getAllGroupIds()

Returns all the group ids in this role map.

getAllUsernames

public java.util.Set<java.lang.String> getAllUsernames()

Returns all the usernames in this role map.

getRoles

public Role[] getRoles()

Returns an array of Role objects for all the roles stored in this role map.

setRoles

public void setRoles(Role[] roles)

Removes any roles that are currently set and sets the roles to the given data. If the given array is null or empty the existing roles are cleared. The security vector (SECURITY_KEY) is not affected by this call.

Parameters:

roles - The roles data to set in the role map.

setRoles

public void setRoles(java.util.Collection<? extends Role> rolesSet)

Removes any roles that are currently set and sets the roles to the given data. If the given array is null or empty the existing roles are cleared. mimic the call with input as an array of Roles The security vector (SECURITY_KEY) is not affected by this call.

Parameters:

rolesSet - The set of roles data to set in the role map.

getRoleNames

protected java.lang.String[] getRoleNames()

removeAllRoles

protected void removeAllRoles()

getRole

protected Role getRole(java.lang.String roleName)

setRole

protected void setRole(Role role)