com.appiancorp.suiteapi.common

Class Role

java.lang.Object

com.appiancorp.suiteapi.common.Role

All Implemented Interfaces:

java.lang.Comparable<Role>

Direct Known Subclasses:

ContentRole

public class Role
extends java.lang.Object
implements java.lang.Comparable<Role>

Holds the data for an individual role within a role map.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Role.PermissionMergeStrategy Takes a set of existing permissions and a set of new permissions and decides how to combine them into a result set.

Field Summary

Fields

Modifier and Type	Field and Description
static Role.PermissionMergeStrategy	ADDING_STRATEGY Returns the result of adding newPermissions to existingPermissions.
static com.google.common.base.Function<Role,java.lang.String>	asRoleName
static Role.PermissionMergeStrategy	REMOVING_STRATEGY Returns the result of removing newPermissions from existingPermissions.
static Role.PermissionMergeStrategy	REPLACING_STRATEGY Returns newPermissions.

Constructor Summary

Constructors

Constructor and Description
Role()
Role(Role r) Copy constructor.
Role(java.lang.String name) Creates a role with the given name and empty id/uuid sets.
Role(java.lang.String name, java.util.Set<java.lang.String> usernames, java.util.Set<java.lang.Long> groupIds, java.util.Set<java.lang.String> userUuids, java.util.Set<java.lang.String> groupUuids) Creates a role with the given name and the given ids/uuids.
Role(java.lang.String name, java.lang.String[] usernames, java.lang.Long[] groupIds) Creates a role with the given name and the given ids/uuids.
Role(java.lang.String name, java.lang.String[] usernames, java.lang.Long[] groupIds, java.lang.String[] userUuids, java.lang.String[] groupUuids) Creates a role with the given name and the given ids/uuids.

Method Summary

Modifier and Type	Method and Description
static java.util.Set<Role>	addPermissions(java.util.Set<Role> existingPermissions, java.util.Set<Role> permissionsToAdd) Returns a new Set<Role> with permissions (groups and users) from permissionsToAdd added to existingPermissions.
static Role	applyRole(Role existingRole, Role newRole, Role.PermissionMergeStrategy strategy) Returns a new Role that is the result of applying the strategy to existingRole and newRole.
static java.util.Set<Role>	applyRoleMap(java.util.Set<Role> existingRoleMap, java.util.Set<Role> newRoleMap, Role.PermissionMergeStrategy strategy) Returns a new Set<Role> that is the result of applying the permission strategy to matching pairs of Roles from existingRoleMap and newRoleMap.
int	compareTo(Role otherRole)
boolean	equals(java.lang.Object obj) Returns true if the given object is a non-null Role object that has the same name as this Role.
java.util.Set<java.lang.Long>	getGroupIds() Returns the ids of the groups that have this role.
java.util.Set<java.lang.String>	getGroupUuids() Returns the UUIDs of the groups that have this role.
java.lang.String	getName() Returns the name of this role.
java.util.Set<java.lang.String>	getUsernames() Returns the usernames of the users that have this role.
java.util.Set<java.lang.String>	getUserUuids() Returns the UUIDs of the users that have this role.
int	hashCode() Returns the hash code for this Role, calculated as the hash code of this Role's name.
static java.util.Set<Role>	removePermissions(java.util.Set<Role> existingPermissions, java.util.Set<Role> permissionsToRemove) Returns a new Set<Role> with permissions (groups and users) from permissionsToRemove removed from existingPermissions.
void	setGroupIds(java.util.Set<java.lang.Long> groupIds)
void	setGroupUuids(java.util.Set<java.lang.String> groupUuids)
void	setName(java.lang.String name)
void	setUsernames(java.util.Set<java.lang.String> userIds)
void	setUserUuids(java.util.Set<java.lang.String> userUuids)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

asRoleName

public static final com.google.common.base.Function<Role,java.lang.String> asRoleName

ADDING_STRATEGY

public static final Role.PermissionMergeStrategy ADDING_STRATEGY

Returns the result of adding newPermissions to existingPermissions. If any new permissions already exist, they are ignored.

REMOVING_STRATEGY

public static final Role.PermissionMergeStrategy REMOVING_STRATEGY

Returns the result of removing newPermissions from existingPermissions.

REPLACING_STRATEGY

public static final Role.PermissionMergeStrategy REPLACING_STRATEGY

Returns newPermissions.

Constructor Detail

Role

public Role()

Role

public Role(java.lang.String name)

Creates a role with the given name and empty id/uuid sets.

Role

public Role(java.lang.String name,
            java.util.Set<java.lang.String> usernames,
            java.util.Set<java.lang.Long> groupIds,
            java.util.Set<java.lang.String> userUuids,
            java.util.Set<java.lang.String> groupUuids)

Creates a role with the given name and the given ids/uuids. Adding/removing to/from the given sets will affect the created role. If null is passed in for one of the sets, the role will use a new empty set instead.

Role

public Role(java.lang.String name,
            java.lang.String[] usernames,
            java.lang.Long[] groupIds)

Creates a role with the given name and the given ids/uuids.

Role

public Role(java.lang.String name,
            java.lang.String[] usernames,
            java.lang.Long[] groupIds,
            java.lang.String[] userUuids,
            java.lang.String[] groupUuids)

Creates a role with the given name and the given ids/uuids.

Role

public Role(Role r)

Copy constructor. Creates a role with the same data as the given role (the new role will have its own sets, so changes to the original role will not affect the new role).

Method Detail

equals

public boolean equals(java.lang.Object obj)

Returns true if the given object is a non-null Role object that has the same name as this Role. Returns false otherwise.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns the hash code for this Role, calculated as the hash code of this Role's name.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getName

public java.lang.String getName()

Returns the name of this role.

setName

public void setName(java.lang.String name)

getUsernames

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

Returns the usernames of the users that have this role.

setUsernames

public void setUsernames(java.util.Set<java.lang.String> userIds)

getUserUuids

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

Returns the UUIDs of the users that have this role. This field is not populated except when using the IX API.

setUserUuids

public void setUserUuids(java.util.Set<java.lang.String> userUuids)

getGroupIds

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

Returns the ids of the groups that have this role.

setGroupIds

public void setGroupIds(java.util.Set<java.lang.Long> groupIds)

getGroupUuids

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

Returns the UUIDs of the groups that have this role. This field is not populated except when using the IX API.

setGroupUuids

public void setGroupUuids(java.util.Set<java.lang.String> groupUuids)

compareTo

public int compareTo(Role otherRole)

Specified by:

compareTo in interface java.lang.Comparable<Role>

addPermissions

public static java.util.Set<Role> addPermissions(java.util.Set<Role> existingPermissions,
                                                 java.util.Set<Role> permissionsToAdd)

Returns a new Set<Role> with permissions (groups and users) from permissionsToAdd added to existingPermissions.

removePermissions

public static java.util.Set<Role> removePermissions(java.util.Set<Role> existingPermissions,
                                                    java.util.Set<Role> permissionsToRemove)

Returns a new Set<Role> with permissions (groups and users) from permissionsToRemove removed from existingPermissions.

applyRoleMap

public static java.util.Set<Role> applyRoleMap(java.util.Set<Role> existingRoleMap,
                                               java.util.Set<Role> newRoleMap,
                                               Role.PermissionMergeStrategy strategy)

Returns a new Set<Role> that is the result of applying the permission strategy to matching pairs of Roles from existingRoleMap and newRoleMap. Roles are matched up by role name.

applyRole

public static Role applyRole(Role existingRole,
                             Role newRole,
                             Role.PermissionMergeStrategy strategy)

Returns a new Role that is the result of applying the strategy to existingRole and newRole. For example, if the strategy was ADDING_STRATEGY, this would return a new Role with the groups and users of both newRole and existingRole.