public interface PrivacyManager
PrivacyManager maintains and queries user privacy settings
An implementation can modify the behavior of the Privacy Service within sakai.properties: privacy.manager.defaultViewable=true|false a 'true' value will set privacy enabled for a user whose privacy settings are unknown a 'false' value will set privacy disabled for a user whose privacy settings are unknown If this value is not set, the default behavior will be to show users or make them viewable. privacy.manager.overrideViewable=true|false a 'true' value will make all users viewable in the system a 'false' value will make all users hidden in the system Do not set this value for normal operation (non overridden behavior). privacy.manager.userRecordHasPrecedence=true|false a 'true' value indicates that a user record has precedence over a system record a 'false' value indicates that a system record has precedence over a user record
| Modifier and Type | Field and Description |
|---|---|
static String |
DEFAULT_PRIVACY_KEY |
static String |
HIDDEN |
static String |
PRIVACY_PREFS |
static String |
SYSTEM_RECORD_TYPE |
static String |
USER_RECORD_TYPE |
static String |
VISIBLE |
| Modifier and Type | Method and Description |
|---|---|
Set |
findHidden(String contextId,
Set userIds)
Get a set of users who have privacy enabled within a context.
|
Set |
findViewable(String contextId,
Set userIds)
Get a set of users who have privacy disabled within a context.
|
String |
getDefaultPrivacyState(String userId) |
Set |
getViewableState(String contextId,
Boolean value,
String recordType)
Get the state of the users within the specified context filtered by a Boolean value.
|
Map |
getViewableState(String contextId,
String recordType)
Get the state of the users within the specified context.
|
boolean |
isViewable(String contextId,
String userId)
Determine user privacy within the specified context.
|
void |
setDefaultPrivacyState(String userId,
String visibility) |
void |
setViewableState(String contextId,
Map userViewableState,
String recordType)
Set the state for each entry in the userMap.
|
void |
setViewableState(String contextId,
String userId,
Boolean value,
String recordType)
Set user's privacy setting within the specified context given a record type.
|
boolean |
userMadeSelection(String contextId,
String userId)
Determine if a user has specifically made a choice.
|
static final String SYSTEM_RECORD_TYPE
static final String USER_RECORD_TYPE
static final String VISIBLE
static final String HIDDEN
static final String PRIVACY_PREFS
static final String DEFAULT_PRIVACY_KEY
boolean isViewable(String contextId, String userId)
contextId - userId - (UUID)boolean userMadeSelection(String contextId, String userId)
contextId - userId - (UUID)Set findViewable(String contextId, Set userIds)
contextId - userIds - org.sakakproject.service.legacy.User.id objects (UUID)Set findHidden(String contextId, Set userIds)
contextId - userIds - org.sakakproject.service.legacy.User.id objects (UUID)Set getViewableState(String contextId, Boolean value, String recordType)
contextId - value - filter (True, False, NULL)recordType - is a UUID i.e. (getSystemRecordType(), getUserRecordType())Map getViewableState(String contextId, String recordType)
contextId - recordType - is a UUID i.e. (getSystemRecordType(), getUserRecordType())void setViewableState(String contextId, String userId, Boolean value, String recordType)
contextId - userId - (UUID)value - using three-valued logic (True, False, NULL)recordType - is a UUID i.e. (getSystemRecordType(), getUserRecordType())void setViewableState(String contextId, Map userViewableState, String recordType)
contextId - userMap - is a Map {key=userId, value=Boolean}recordType - is a UUID i.e. (getSystemRecordType(), getUserRecordType())Copyright © 2004–2018 Sakai Project. All rights reserved.