org.sakaiproject.component.privacy

Class PrivacyManagerImpl

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

org.sakaiproject.component.privacy.PrivacyManagerImpl

All Implemented Interfaces:

org.sakaiproject.api.privacy.PrivacyManager, org.sakaiproject.authz.api.AuthzGroupAdvisor, org.springframework.beans.factory.InitializingBean

public class PrivacyManagerImpl
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements org.sakaiproject.api.privacy.PrivacyManager, org.sakaiproject.authz.api.AuthzGroupAdvisor

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	defaultViewable
protected int	maxResultSetNumber
protected Boolean	overrideViewable
protected boolean	userRecordHasPrecedence

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface org.sakaiproject.api.privacy.PrivacyManager

DEFAULT_PRIVACY_KEY, HIDDEN, PRIVACY_PREFS, SYSTEM_RECORD_TYPE, USER_RECORD_TYPE, VISIBLE

Constructor Summary

Constructors

Constructor and Description
PrivacyManagerImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
Set	findHidden(String contextId, Set userIds)
Set	findViewable(String contextId, Set userIds)
String	getDefaultPrivacyState(String userId)
Set	getViewableState(String contextId, Boolean value, String recordType)
Map	getViewableState(String contextId, String recordType)
void	groupUpdate(org.sakaiproject.authz.api.AuthzGroup group, String userId, String roleId)
void	init()
boolean	isViewable(String contextId, String userId)
void	remove(org.sakaiproject.authz.api.AuthzGroup group)
void	setAuthzGroupService(org.sakaiproject.authz.api.AuthzGroupService authzGroupService)
void	setDefaultPrivacyState(String userId, String visibility)
void	setDefaultViewable(boolean defaultViewable) A 'true' value will set privacy enabled for a user whose privacy settings are not known.
void	setMaxResultSetNumber(int maxResultSetNumber) Set maximum result set number for database query, defulat is 1000.
void	setOverrideViewable(Boolean overrideViewable) A 'true' value will make all users viewable in the system.
void	setPreferencesService(org.sakaiproject.user.api.PreferencesService preferencesService)
void	setUserRecordHasPrecedence(boolean userRecordHasPrecedence) A 'true' value indicates that a user record has precedence over a system record.
void	setViewableState(String contextId, Map userViewableState, String recordType)
void	setViewableState(String contextId, String userId, Boolean value, String recordType)
void	update(org.sakaiproject.authz.api.AuthzGroup group)
boolean	userMadeSelection(String contextId, String userId)

Methods inherited from class org.springframework.orm.hibernate3.support.HibernateDaoSupport

checkDaoConfig, convertHibernateAccessException, createHibernateTemplate, getHibernateTemplate, getSession, getSession, getSessionFactory, releaseSession, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultViewable

protected boolean defaultViewable

overrideViewable

protected Boolean overrideViewable

userRecordHasPrecedence

protected boolean userRecordHasPrecedence

maxResultSetNumber

protected int maxResultSetNumber

Constructor Detail

PrivacyManagerImpl

public PrivacyManagerImpl()

Method Detail

init

public void init()

destroy

public void destroy()

findViewable

public Set findViewable(String contextId,
               Set userIds)

Specified by:

findViewable in interface org.sakaiproject.api.privacy.PrivacyManager

findHidden

public Set findHidden(String contextId,
             Set userIds)

Specified by:

findHidden in interface org.sakaiproject.api.privacy.PrivacyManager

getViewableState

public Set getViewableState(String contextId,
                   Boolean value,
                   String recordType)

Specified by:

getViewableState in interface org.sakaiproject.api.privacy.PrivacyManager

getViewableState

public Map getViewableState(String contextId,
                   String recordType)

Specified by:

getViewableState in interface org.sakaiproject.api.privacy.PrivacyManager

isViewable

public boolean isViewable(String contextId,
                 String userId)

Specified by:

isViewable in interface org.sakaiproject.api.privacy.PrivacyManager

userMadeSelection

public boolean userMadeSelection(String contextId,
                        String userId)

Specified by:

userMadeSelection in interface org.sakaiproject.api.privacy.PrivacyManager

setViewableState

public void setViewableState(String contextId,
                    String userId,
                    Boolean value,
                    String recordType)

Specified by:

setViewableState in interface org.sakaiproject.api.privacy.PrivacyManager

setViewableState

public void setViewableState(String contextId,
                    Map userViewableState,
                    String recordType)

Specified by:

setViewableState in interface org.sakaiproject.api.privacy.PrivacyManager

update

public void update(org.sakaiproject.authz.api.AuthzGroup group)

Specified by:

update in interface org.sakaiproject.authz.api.AuthzGroupAdvisor

groupUpdate

public void groupUpdate(org.sakaiproject.authz.api.AuthzGroup group,
               String userId,
               String roleId)

Specified by:

groupUpdate in interface org.sakaiproject.authz.api.AuthzGroupAdvisor

remove

public void remove(org.sakaiproject.authz.api.AuthzGroup group)

Specified by:

remove in interface org.sakaiproject.authz.api.AuthzGroupAdvisor

setDefaultPrivacyState

public void setDefaultPrivacyState(String userId,
                          String visibility)

Specified by:

setDefaultPrivacyState in interface org.sakaiproject.api.privacy.PrivacyManager

getDefaultPrivacyState

public String getDefaultPrivacyState(String userId)

Specified by:

getDefaultPrivacyState in interface org.sakaiproject.api.privacy.PrivacyManager

setDefaultViewable

public void setDefaultViewable(boolean defaultViewable)

A 'true' value will set privacy enabled for a user whose privacy settings are not known. A 'false' value will set privacy disabled for a user whose privacy settings are not known (i.e. no data found). The default behavior will be to show users or make them viewable.

Parameters:

defaultViewable - the defaultViewable to set

setOverrideViewable

public void setOverrideViewable(Boolean overrideViewable)

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; i.e. null).

Parameters:

overrideViewable - the overrideViewable to set

setUserRecordHasPrecedence

public void setUserRecordHasPrecedence(boolean userRecordHasPrecedence)

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

Parameters:

userRecordHasPrecedence - the userRecordHasPrecedence to set

setMaxResultSetNumber

public void setMaxResultSetNumber(int maxResultSetNumber)

Set maximum result set number for database query, defulat is 1000.

Parameters:

maxResultSetNumber - the maxResultSetNumber to set

setPreferencesService

public void setPreferencesService(org.sakaiproject.user.api.PreferencesService preferencesService)

setAuthzGroupService

public void setAuthzGroupService(org.sakaiproject.authz.api.AuthzGroupService authzGroupService)