Package cz.metacentrum.perun.core.api

Interface SecurityTeamsManager

All Known Implementing Classes:

SecurityTeamsManagerEntry

public interface SecurityTeamsManager

Author:

Ondrej Velisek <ondrejvelisek@gmail.com>

Method Summary

Modifier and Type	Method	Description
void	addAdmin(PerunSession perunSession, SecurityTeam securityTeam, Group group)	Create group as security admins group of given security team (all users in group will have security admin rights)
void	addAdmin(PerunSession perunSession, SecurityTeam securityTeam, User user)	create security admin from given user and add him as security admin of given security team
void	addUserToBlacklist(PerunSession perunSession, SecurityTeam securityTeam, User user, String description)	Add User to black list of security team to filter him out.
SecurityTeam	createSecurityTeam(PerunSession perunSession, SecurityTeam securityTeam)	Create new SecurityTeam.
void	deleteSecurityTeam(PerunSession perunSession, SecurityTeam securityTeam)	Delete SecurityTeam.
void	deleteSecurityTeam(PerunSession perunSession, SecurityTeam securityTeam, boolean forceDelete)	Delete SecurityTeam.
List<Group>	getAdminGroups(PerunSession sess, SecurityTeam securityTeam)	Deprecated.
List<User>	getAdmins(PerunSession perunSession, SecurityTeam securityTeam, boolean onlyDirectAdmins)	Deprecated.
List<SecurityTeam>	getAllSecurityTeams(PerunSession perunSession)	get all security teams in perun system
List<User>	getBlacklist(PerunSession perunSession, Facility facility)	get union of blacklists of all security teams assigned to facility
List<User>	getBlacklist(PerunSession perunSession, SecurityTeam securityTeam)	get list of blacklisted users by security team
List<Pair<User,String>>	getBlacklistWithDescription(PerunSession perunSession, Facility facility)	get union of blacklists of all security teams assigned to facility containing also description
List<Pair<User,String>>	getBlacklistWithDescription(PerunSession perunSession, SecurityTeam securityTeam)	get list of blacklisted users by security team containing also description
SecurityTeam	getSecurityTeamById(PerunSession perunSession, int id)	Find existing SecurityTeam by ID.
SecurityTeam	getSecurityTeamByName(PerunSession perunSession, String name)	Find existing SecurityTeam by name.
List<SecurityTeam>	getSecurityTeams(PerunSession perunSession)	Get list of SecurityTeams by access rights - PERUNADMIN : all teams - SECURITYADMIN : teams where user is admin
void	removeAdmin(PerunSession perunSession, SecurityTeam securityTeam, Group group)	Remove security admin role for given security team from group
void	removeAdmin(PerunSession perunSession, SecurityTeam securityTeam, User user)	Remove security admin role for given security team from user
void	removeUserFromBlacklist(PerunSession perunSession, SecurityTeam securityTeam, User user)	remove user from blacklist of given security team
SecurityTeam	updateSecurityTeam(PerunSession perunSession, SecurityTeam securityTeam)	Updates SecurityTeam.

Method Details

addAdmin

void addAdmin(PerunSession perunSession,
 SecurityTeam securityTeam,
 User user)
       throws PrivilegeException,
SecurityTeamNotExistsException,
UserNotExistsException,
AlreadyAdminException,
RoleCannotBeManagedException,
RoleCannotBeSetException

create security admin from given user and add him as security admin of given security team

Parameters:

perunSession -

securityTeam -

user - user who will became a security administrator

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

SecurityTeamNotExistsException

UserNotExistsException

AlreadyAdminException

RoleCannotBeManagedException

RoleCannotBeSetException

addAdmin

void addAdmin(PerunSession perunSession,
 SecurityTeam securityTeam,
 Group group)
       throws PrivilegeException,
SecurityTeamNotExistsException,
GroupNotExistsException,
AlreadyAdminException,
RoleCannotBeManagedException,
RoleCannotBeSetException

Create group as security admins group of given security team (all users in group will have security admin rights)

Parameters:

perunSession -

securityTeam -

group - group which members will became a security administrators

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

SecurityTeamNotExistsException

GroupNotExistsException

AlreadyAdminException

RoleCannotBeManagedException

RoleCannotBeSetException

addUserToBlacklist

void addUserToBlacklist(PerunSession perunSession,
 SecurityTeam securityTeam,
 User user,
 String description)
                 throws PrivilegeException,
SecurityTeamNotExistsException,
UserNotExistsException,
UserAlreadyBlacklistedException

Add User to black list of security team to filter him out.

Description of adding can be null.

Parameters:

perunSession -

securityTeam -

user -

description -

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

SecurityTeamNotExistsException

UserNotExistsException

UserAlreadyBlacklistedException

createSecurityTeam

SecurityTeam createSecurityTeam(PerunSession perunSession,
 SecurityTeam securityTeam)
                         throws PrivilegeException,
SecurityTeamExistsException

Create new SecurityTeam.

Parameters:

perunSession -

securityTeam - SecurityTeam object with prefilled name

Returns:

Newly created Security team with new id

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin.

SecurityTeamExistsException

deleteSecurityTeam

void deleteSecurityTeam(PerunSession perunSession,
 SecurityTeam securityTeam)
                 throws PrivilegeException,
SecurityTeamNotExistsException,
RelationExistsException

Delete SecurityTeam.

Parameters:

perunSession -

securityTeam -

Throws:

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

InternalErrorException

SecurityTeamNotExistsException

RelationExistsException - if team is assigned to any facility or has blacklisted users.

deleteSecurityTeam

void deleteSecurityTeam(PerunSession perunSession,
 SecurityTeam securityTeam,
 boolean forceDelete)
                 throws PrivilegeException,
SecurityTeamNotExistsException,
RelationExistsException

Delete SecurityTeam.

Parameters:

perunSession -

securityTeam -

forceDelete - TRUE if Team should be forcefully deleted.

Throws:

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

InternalErrorException

SecurityTeamNotExistsException

RelationExistsException - if forceDelete == FALSE and team is assigned to any facility or has blacklisted users.

getAdminGroups

@Deprecated
List<Group> getAdminGroups(PerunSession sess,
 SecurityTeam securityTeam)
                    throws PrivilegeException,
SecurityTeamNotExistsException

Deprecated.

Gets list of all group administrators of the SecurityTeam.

Parameters:

sess -

securityTeam -

Returns:

list of Group that are admins in the SecurityTeam.

Throws:

InternalErrorException

PrivilegeException

SecurityTeamNotExistsException

getAdmins

@Deprecated
List<User> getAdmins(PerunSession perunSession,
 SecurityTeam securityTeam,
 boolean onlyDirectAdmins)
              throws PrivilegeException,
SecurityTeamNotExistsException

Deprecated.

get all security admins of given security team

Parameters:

perunSession -

securityTeam -

onlyDirectAdmins - if true, get only direct user administrators (if false, get both direct and indirect)

Returns:

list of users which are admis of given security team

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

SecurityTeamNotExistsException

getAllSecurityTeams

List<SecurityTeam> getAllSecurityTeams(PerunSession perunSession)
                                throws PrivilegeException

get all security teams in perun system

Parameters:

perunSession -

Returns:

List of SecurityTeams or empty List

Throws:

InternalErrorException

PrivilegeException

getBlacklist

List<User> getBlacklist(PerunSession perunSession,
 SecurityTeam securityTeam)
                 throws PrivilegeException,
SecurityTeamNotExistsException

get list of blacklisted users by security team

Parameters:

perunSession -

securityTeam -

Returns:

list of blacklisted users by security team

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

SecurityTeamNotExistsException

getBlacklist

List<User> getBlacklist(PerunSession perunSession,
 Facility facility)
                 throws PrivilegeException,
FacilityNotExistsException

get union of blacklists of all security teams assigned to facility

Parameters:

perunSession -

facility -

Returns:

list of blacklisted users for facility

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

FacilityNotExistsException

getBlacklistWithDescription

List<Pair<User,String>> getBlacklistWithDescription(PerunSession perunSession,
 SecurityTeam securityTeam)
                                             throws PrivilegeException,
SecurityTeamNotExistsException

get list of blacklisted users by security team containing also description

Parameters:

perunSession -

securityTeam -

Returns:

List of Pairs with blacklisted users by security team

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

SecurityTeamNotExistsException

getBlacklistWithDescription

List<Pair<User,String>> getBlacklistWithDescription(PerunSession perunSession,
 Facility facility)
                                             throws PrivilegeException,
FacilityNotExistsException

get union of blacklists of all security teams assigned to facility containing also description

Parameters:

perunSession -

facility -

Returns:

List of Pairs with blacklisted users for facility

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

FacilityNotExistsException

getSecurityTeamById

SecurityTeam getSecurityTeamById(PerunSession perunSession,
 int id)
                          throws PrivilegeException,
SecurityTeamNotExistsException

Find existing SecurityTeam by ID.

Parameters:

perunSession -

id -

Returns:

security team with given id

Throws:

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

InternalErrorException

SecurityTeamNotExistsException

getSecurityTeamByName

SecurityTeam getSecurityTeamByName(PerunSession perunSession,
 String name)
                            throws PrivilegeException,
SecurityTeamNotExistsException

Find existing SecurityTeam by name.

Parameters:

perunSession -

name -

Returns:

security team with given name

Throws:

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

InternalErrorException

SecurityTeamNotExistsException

getSecurityTeams

List<SecurityTeam> getSecurityTeams(PerunSession perunSession)
                             throws PrivilegeException

Get list of SecurityTeams by access rights - PERUNADMIN : all teams - SECURITYADMIN : teams where user is admin

Parameters:

perunSession -

Returns:

List of SecurityTeams or empty ArrayList

Throws:

InternalErrorException

PrivilegeException

removeAdmin

void removeAdmin(PerunSession perunSession,
 SecurityTeam securityTeam,
 User user)
          throws PrivilegeException,
SecurityTeamNotExistsException,
UserNotExistsException,
UserNotAdminException,
RoleCannotBeManagedException

Remove security admin role for given security team from user

Parameters:

perunSession -

securityTeam -

user -

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

SecurityTeamNotExistsException

UserNotExistsException

UserNotAdminException

RoleCannotBeManagedException

removeAdmin

void removeAdmin(PerunSession perunSession,
 SecurityTeam securityTeam,
 Group group)
          throws PrivilegeException,
SecurityTeamNotExistsException,
GroupNotExistsException,
GroupNotAdminException,
RoleCannotBeManagedException

Remove security admin role for given security team from group

Parameters:

perunSession -

securityTeam -

group -

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

SecurityTeamNotExistsException

GroupNotExistsException

GroupNotAdminException

RoleCannotBeManagedException

removeUserFromBlacklist

void removeUserFromBlacklist(PerunSession perunSession,
 SecurityTeam securityTeam,
 User user)
                      throws PrivilegeException,
SecurityTeamNotExistsException,
UserNotExistsException,
UserAlreadyRemovedException

remove user from blacklist of given security team

Parameters:

perunSession -

securityTeam -

user - user who will became a security administrator

Throws:

InternalErrorException

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

SecurityTeamNotExistsException

UserNotExistsException

UserAlreadyRemovedException

updateSecurityTeam

SecurityTeam updateSecurityTeam(PerunSession perunSession,
 SecurityTeam securityTeam)
                         throws PrivilegeException,
SecurityTeamNotExistsException,
SecurityTeamExistsException

Updates SecurityTeam.

Parameters:

perunSession -

securityTeam -

Returns:

returns updated SecurityTeam

Throws:

PrivilegeException - Can do only PerunAdmin or SecurityAdmin of the SecurityTeam

InternalErrorException

SecurityTeamNotExistsException

SecurityTeamExistsException