public class ContentRoleMap extends RoleMap
This class represents the access permissions for an element in the collaboration center.
Copyright: Copyright (c) 2002, 2003
Company: Appian Corporation
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADMINISTRATOR
Role with administrative access.
|
static java.lang.String[] |
ALL_ROLES |
static java.lang.String |
AUTHOR
Role with read/write access.
|
static java.lang.String |
DENY_ADMINISTRATOR
Explicitly deny administrative access.
|
static java.lang.String |
DENY_AUTHOR
Explicitly deny read/write access.
|
static java.lang.String |
DENY_READER
Explicitly deny read-only access.
|
static java.lang.String |
READER
Role with read-only access.
|
AGGREGATE_SECURITY_KEY, SECURITY_KEY, TYPE_AGGREGATE_GROUP, TYPE_AGGREGATE_USER, TYPE_GROUP, TYPE_GROUP_UUIDS, TYPE_USER, TYPE_USER_UUIDS
DEFAULT_BUFFER_SIZE
Constructor and Description |
---|
ContentRoleMap() |
Modifier and Type | Method and Description |
---|---|
void |
addAdministratorGroups(java.lang.Long... grids_)
Appends to the groups who have administrative permissions.
|
void |
addAdministrators(java.lang.String... unames_)
Appends to the users who have administrative permissions.
|
void |
addAuthorGroups(java.lang.Long... grids_)
Appends to the groups who have authoring (read/write) permissions.
|
void |
addAuthors(java.lang.String... unames_)
Appends to the users who have authoring (read/write) permissions.
|
void |
addDenyAdministratorGroups(java.lang.Long... grids_)
Appends to the groups who have been explicitly denied administrative permissions.
|
void |
addDenyAdministrators(java.lang.String... unames_)
Appends to the users who have been explicitly denied administrative permissions.
|
void |
addDenyAuthorGroups(java.lang.Long... grids_)
Appends to the groups who have been explicitly denied authoring (read/write) permissions.
|
void |
addDenyAuthors(java.lang.String... unames_)
Appends to the users who have been explicitly denied authoring (read/write) permissions.
|
void |
addDenyReaderGroups(java.lang.Long... grids_)
Appends to the groups who have been explicitly denied read-only permissions.
|
void |
addDenyReaders(java.lang.String... unames_)
Appends to the users who have been explicitly denied read-only permissions.
|
void |
addReaderGroups(java.lang.Long... grids_)
Appends to the groups who have read-only permissions.
|
void |
addReaders(java.lang.String... unames_)
Appends to the users who have read-only permissions.
|
java.lang.Long[] |
getAdministratorGroups()
Retrieves the groups who have administrative permissions.
|
java.lang.String[] |
getAdministrators()
Retrieves the users who have administrative permissions.
|
java.lang.Long[] |
getAggregateAdministratorGroups()
Retrieves the groups who have administrative permissions aggregated via the chain of parent object.
|
java.lang.String[] |
getAggregateAdministrators()
Retrieves the users who have administrative permissions aggregated via the chain of parent objects.
|
java.lang.Long[] |
getAggregateAuthorGroups()
Retrieves the groups who have authoring permissions aggregated via the chain of parent objects.
|
java.lang.String[] |
getAggregateAuthors()
Retrieves the users who have authoring permissions aggregated via the chain of parent objects.
|
java.lang.Long[] |
getAggregateDenyAdministratorGroups()
Retrieves the groups who have been explicitly denied administrative permissions aggregated via the chain of parent objects.
|
java.lang.String[] |
getAggregateDenyAdministrators()
Retrieves the users who have been explicitly denied administrative permissions aggregated via the chain of parent objects.
|
java.lang.Long[] |
getAggregateDenyAuthorGroups()
Retrieves the groups who have been explicitly denied authoring permissions aggregated via the chain of parent objects.
|
java.lang.String[] |
getAggregateDenyAuthors()
Retrieves the users who have been explicitly denied authoring permissions aggregated via the chain of parent objects.
|
java.lang.Long[] |
getAggregateDenyReaderGroups()
Retrieves the groups who have been explicitly denied read-only permissions aggregated via the chain of parent objects.
|
java.lang.String[] |
getAggregateDenyReaders()
Retrieves the users who have been explicitly denied read-only permissions aggregated via the chain of parent objects.
|
java.lang.Long[] |
getAggregateReaderGroups()
Retrieves the groups who have read-only permissions aggregated via the chain of parent objects.
|
java.lang.String[] |
getAggregateReaders()
Retrieves the users who have read-only permissions aggregated via the chain of parent objects.
|
java.lang.Long[] |
getAuthorGroups()
Retrieves the groups who have authoring (read/write) permissions.
|
java.lang.String[] |
getAuthors()
Retrieves the users who have authoring (read/write) permissions.
|
java.lang.Long[] |
getDenyAdministratorGroups()
Retrieves the groups who have been explicitly denied administrative permissions.
|
java.lang.String[] |
getDenyAdministrators()
Retrieves the users who have been explicitly denied administrative permissions.
|
java.lang.Long[] |
getDenyAuthorGroups()
Retrieves the groups who have authoring (read/write) permissions.
|
java.lang.String[] |
getDenyAuthors()
Retrieves the users who have authoring (read/write) permissions.
|
java.lang.Long[] |
getDenyReaderGroups()
Retrieves the groups who have been explicitly denied read-only permissions.
|
java.lang.String[] |
getDenyReaders()
Retrieves the users who have been explicitly denied read-only permissions.
|
java.lang.Long[] |
getReaderGroups()
Retrieves the groups who have read-only permissions.
|
java.lang.String[] |
getReaders()
Retrieves the users who have read-only permissions.
|
protected ContentRole |
getRole(java.lang.String roleName) |
ContentRole[] |
getRoles()
Returns an array of ContentRole objects for every Content role
(see
ContentConstants.ROLE_MAP_ROLES ). |
boolean |
isPublic()
Indicates that the content is public.
|
void |
mergeWith(RoleMap newRM)
Merges this role map with the given new role map.
|
void |
removeAdministratorGroups(java.lang.Long... grids_)
Deletes from the groups who have administrative permissions.
|
void |
removeAdministrators(java.lang.String... unames_)
Deletes from the users who have administrative permissions.
|
protected void |
removeAllRoles() |
void |
removeAuthorGroups(java.lang.Long... grids_)
Delete from the groups who have authoring (read/write) permissions.
|
void |
removeAuthors(java.lang.String... unames_)
Delete from the users who have authoring (read/write) permissions.
|
void |
removeDenyAdministratorGroups(java.lang.Long... grids_)
Deletes from the groups who have been explicitly denied administrative permissions.
|
void |
removeDenyAdministrators(java.lang.String... unames_)
Deletes from the users who have been explicitly denied administrative permissions.
|
void |
removeDenyAuthorGroups(java.lang.Long... grids_)
Delete from the groups who have been explicitly denied authoring (read/write) permissions.
|
void |
removeDenyAuthors(java.lang.String... unames_)
Delete from the users who have been explicitly denied authoring (read/write) permissions.
|
void |
removeDenyReaderGroups(java.lang.Long... grids_)
Delete from the groups who have been explicitly denied read-only permissions.
|
void |
removeDenyReaders(java.lang.String... unames_)
Delete from the users who have been explicitly denied read-only permissions.
|
void |
removeReaderGroups(java.lang.Long... grids_)
Delete from the groups who have read-only permissions.
|
void |
removeReaders(java.lang.String... unames_)
Delete from the users who have read-only permissions.
|
void |
setAdministratorGroups(java.lang.Long... grids_)
Sets the groups who have administrative permissions.
|
void |
setAdministrators(java.lang.String... unames_)
Sets the users who have administrative permissions.
|
void |
setAuthorGroups(java.lang.Long... grids_)
Sets the groups who have authoring (read/write) permissions.
|
void |
setAuthors(java.lang.String... unames_)
Sets the users who have authoring (read/write) permissions.
|
void |
setDenyAdministratorGroups(java.lang.Long... grids_)
Sets the groups who have been explicitly denied administrative permissions.
|
void |
setDenyAdministrators(java.lang.String... unames_)
Sets the users who have been explicitly denied administrative permissions.
|
void |
setDenyAuthorGroups(java.lang.Long... grids_)
Sets the groups who have been explicitly denied authoring (read/write) permissions.
|
void |
setDenyAuthors(java.lang.String... unames_)
Sets the users who have been explicitly denied authoring (read/write) permissions.
|
void |
setDenyReaderGroups(java.lang.Long... grids_)
Sets the groups who have been explicitly denied authoring read-only permissions.
|
void |
setDenyReaders(java.lang.String... unames_)
Sets the users who have been explicitly denied read-only permissions.
|
void |
setPublic(boolean secPublic) |
void |
setReaderGroups(java.lang.Long... grids_)
Sets the groups who have authoring read-only permissions.
|
void |
setReaders(java.lang.String... unames_)
Sets the users who have read-only permissions.
|
protected void |
setRole(Role role) |
void |
setRoles(java.util.Collection<? extends Role> roles)
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.
|
java.lang.String |
toString() |
static java.lang.String |
toStringSecurityVector(java.lang.Integer contentSecurityVector) |
addActorsToRole, addActorsToRole, clear, containsActors, containsKey, containsValue, entrySet, equals, get, getActorsInRole, getAggregateSecurity, getAllGroupIds, getAllUsernames, getRoleNames, getSecurity, hashCode, init, isEmpty, keySet, put, putAll, remove, removeActorsFromRole, removeActorsFromRole, setActorsInRole, setActorsInRole, setAggregateSecurity, setSecurity, size, toXML, toXML, values
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final java.lang.String READER
public static final java.lang.String AUTHOR
public static final java.lang.String ADMINISTRATOR
public static final java.lang.String DENY_READER
public static final java.lang.String DENY_AUTHOR
public static final java.lang.String DENY_ADMINISTRATOR
public static final java.lang.String[] ALL_ROLES
public java.lang.String[] getAdministrators()
setAdministrators(String[])
public java.lang.String[] getAggregateAdministrators()
public java.lang.Long[] getAdministratorGroups()
setAdministratorGroups(Long[])
public java.lang.Long[] getAggregateAdministratorGroups()
public void setAdministrators(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the usersgetAdministrators()
public void setAdministratorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupsgetAdministratorGroups()
public void addAdministrators(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the users to be addedpublic void addAdministratorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groups to be addedpublic void removeAdministrators(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the users to be deletedpublic void removeAdministratorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groups to be deletedpublic java.lang.String[] getAuthors()
setAuthors(String[])
public java.lang.String[] getAggregateAuthors()
public java.lang.Long[] getAuthorGroups()
setAuthorGroups(Long[])
public java.lang.Long[] getAggregateAuthorGroups()
public java.lang.String[] getReaders()
setReaders(String[])
public java.lang.String[] getAggregateReaders()
public java.lang.Long[] getReaderGroups()
setReaderGroups(Long[])
public java.lang.Long[] getAggregateReaderGroups()
public void setAuthors(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the usersgetAuthors()
public void setAuthorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupsgetAuthorGroups()
public void setReaders(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the usersgetReaders()
public void setReaderGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupsgetReaderGroups()
public void addAuthors(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the userspublic void addAuthorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupspublic void addReaders(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the userspublic void addReaderGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupspublic void removeAuthors(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the userspublic void removeAuthorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupspublic void removeReaders(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the userspublic void removeReaderGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupspublic java.lang.String[] getDenyAdministrators()
setDenyAdministrators(String[])
public java.lang.String[] getAggregateDenyAdministrators()
public java.lang.Long[] getDenyAdministratorGroups()
setDenyAdministratorGroups(Long[])
public java.lang.Long[] getAggregateDenyAdministratorGroups()
public void setDenyAdministrators(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the usersgetDenyAdministrators()
public void setDenyAdministratorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupsgetDenyAdministratorGroups()
public void addDenyAdministrators(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the users to be addedpublic void addDenyAdministratorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groups to be addedpublic void removeDenyAdministrators(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the users to be deletedpublic void removeDenyAdministratorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groups to be deletedpublic java.lang.String[] getDenyAuthors()
setDenyAuthors(String[])
public java.lang.String[] getAggregateDenyAuthors()
public java.lang.Long[] getDenyAuthorGroups()
setDenyAuthorGroups(Long[])
public java.lang.Long[] getAggregateDenyAuthorGroups()
public java.lang.String[] getDenyReaders()
setDenyReaders(String[])
public java.lang.String[] getAggregateDenyReaders()
public java.lang.Long[] getDenyReaderGroups()
setDenyReaderGroups(Long[])
public java.lang.Long[] getAggregateDenyReaderGroups()
public void setDenyAuthors(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the usersgetDenyAuthors()
public void setDenyAuthorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupsgetDenyAuthorGroups()
public void setDenyReaders(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the usersgetDenyReaders()
public void setDenyReaderGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupsgetDenyReaderGroups()
public void addDenyAuthors(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the userspublic void addDenyAuthorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupspublic void addDenyReaders(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the userspublic void addDenyReaderGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupspublic void removeDenyAuthors(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the userspublic void removeDenyAuthorGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupspublic void removeDenyReaders(java.lang.String... unames_)
unames_
- a list containing the unique IDs of the userspublic void removeDenyReaderGroups(java.lang.Long... grids_)
grids_
- a list containing the unique IDs of the groupspublic boolean isPublic()
public void setPublic(boolean secPublic)
isPublic()
public ContentRole[] getRoles()
ContentConstants.ROLE_MAP_ROLES
).public void setRoles(Role[] roles)
public void setRoles(java.util.Collection<? extends Role> roles)
protected void removeAllRoles()
removeAllRoles
in class RoleMap
protected ContentRole getRole(java.lang.String roleName)
public void mergeWith(RoleMap newRM)
RoleMap
RoleMap.TYPE_USER
and
RoleMap.TYPE_GROUP
are merged. All other fields are left unchanged.
The following rules are used to merge the users and groups:
public static java.lang.String toStringSecurityVector(java.lang.Integer contentSecurityVector)
Copyright © 2003-2024 Appian Corporation. All Rights Reserved.