Package ubic.gemma.web.controller.common.auditAndSecurity

Interface SecurityController

All Known Implementing Classes:

SecurityControllerImpl

public interface SecurityController

Note: do not use parameterized collections as parameters for ajax methods in this class! Type information is lost during proxy creation so DWR can't figure out what type of collection the method should take. See bug 2756. Use arrays instead.

Author:

paul

Method Summary

Modifier and Type	Method	Description
boolean	addUserToGroup(String userName, String groupName)
String	createGroup(String groupName)
void	deleteGroup(String groupName)	AJAX
Integer	getAuthenticatedUserCount()
Collection<String>	getAuthenticatedUserNames()
Collection<UserGroupValueObject>	getAvailableGroups()	AJAX
Collection<SidValueObject>	getAvailablePrincipalSids()	Return a list of principals that is users
Collection<SidValueObject>	getAvailableSids()	AJAX, but administrator-only!
Collection<UserValueObject>	getGroupMembers(String groupName)
SecurityInfoValueObject	getSecurityInfo(EntityDelegator ed)
Collection<SecurityInfoValueObject>	getUsersData(String currentGroup, boolean privateOnly)	AJAX
boolean	makeGroupReadable(EntityDelegator ed, String groupName)
boolean	makeGroupWriteable(EntityDelegator ed, String groupName)
boolean	makePrivate(EntityDelegator ed)
boolean	makePublic(EntityDelegator ed)
boolean	removeGroupReadable(EntityDelegator ed, String groupName)
boolean	removeGroupWriteable(EntityDelegator ed, String groupName)
boolean	removeUsersFromGroup(String[] userNames, String groupName)
void	setExpressionExperimentService(ExpressionExperimentService expressionExperimentService)
SecurityInfoValueObject	updatePermission(SecurityInfoValueObject settings)
void	updatePermissions(SecurityInfoValueObject[] settings)

Method Detail

addUserToGroup

boolean addUserToGroup(String userName,
                       String groupName)

createGroup

String createGroup(String groupName)

deleteGroup

void deleteGroup(String groupName)

AJAX

Parameters:

groupName - group name

Throws:

DataIntegrityViolationException - cannot remove a group if it is being used to set any permission, remove permission settings first (is thrown if the acl_entry table has rows with this sid)

getAuthenticatedUserCount

Integer getAuthenticatedUserCount()

getAuthenticatedUserNames

Collection<String> getAuthenticatedUserNames()

getAvailableGroups

Collection<UserGroupValueObject> getAvailableGroups()

AJAX

Returns:

List of group names the user can add members to and/or give permissions on objects to.

getAvailablePrincipalSids

Collection<SidValueObject> getAvailablePrincipalSids()

Return a list of principals that is users

Returns:

SidValueObjects

getAvailableSids

Collection<SidValueObject> getAvailableSids()

AJAX, but administrator-only!

Returns:

SID VOs

getGroupMembers

Collection<UserValueObject> getGroupMembers(String groupName)

getSecurityInfo

SecurityInfoValueObject getSecurityInfo(EntityDelegator ed)

getUsersData

Collection<SecurityInfoValueObject> getUsersData(String currentGroup,
                                                 boolean privateOnly)

AJAX

Parameters:

currentGroup - A specific group that we're focusing on. Can be null. Used to populate client-side checkboxes to show permissions.

privateOnly - Only show data that are private (non-publicly readable); otherwise show all the data for the user. This option is probably of most use to administrators.

Returns:

security info VO

makeGroupReadable

boolean makeGroupReadable(EntityDelegator ed,
                          String groupName)

makeGroupWriteable

boolean makeGroupWriteable(EntityDelegator ed,
                           String groupName)

makePrivate

boolean makePrivate(EntityDelegator ed)

makePublic

boolean makePublic(EntityDelegator ed)

removeGroupReadable

boolean removeGroupReadable(EntityDelegator ed,
                            String groupName)

removeGroupWriteable

boolean removeGroupWriteable(EntityDelegator ed,
                             String groupName)

removeUsersFromGroup

boolean removeUsersFromGroup(String[] userNames,
                             String groupName)

setExpressionExperimentService

void setExpressionExperimentService(ExpressionExperimentService expressionExperimentService)

updatePermission

SecurityInfoValueObject updatePermission(SecurityInfoValueObject settings)

updatePermissions

void updatePermissions(SecurityInfoValueObject[] settings)