Package org.craftercms.studio.api.v1.service.security

Interface SecurityService

All Known Implementing Classes:

SecurityServiceImpl

public interface SecurityService

Author:

Dejan Brkic

Method Summary

Modifier and Type	Method	Description
int	getAllUsersTotal()	Get all users
org.springframework.security.core.Authentication	getAuthentication()	Deprecated. use SecurityService.getAuthentication() instead
String	getCurrentUser()	Deprecated. use SecurityService.getCurrentUser() instead
List<NormalizedRole>	getUserGlobalRoles(long userId, String username)
Set<String>	getUserPermissions(String site, String path, String user)
Map<String,Object>	getUserProfile(String user)
Map<String,Object>	getUserProfileByGitName(String gitName)	Get user by git name.
Set<String>	getUserRoles(String site)
Set<NormalizedRole>	getUserRoles(String site, String user)
Set<NormalizedRole>	getUserRoles(String site, String user, boolean includeGlobal)
boolean	isSiteAdmin(String username, String site)	Check if given user is site admin
boolean	isSystemAdmin(String username)	Check if given user has system_admin role
boolean	userExists(String username)	Check if user exists

Method Details

getCurrentUser

@Deprecated
String getCurrentUser()

Deprecated.

use SecurityService.getCurrentUser() instead

Returns the username of the current user OR NULL if no user is authenticated

Returns:

current user

getAuthentication

@Deprecated
org.springframework.security.core.Authentication getAuthentication()

Deprecated.

use SecurityService.getAuthentication() instead

Returns the Authentication for the current user or null if not user is authenticated.

Returns:

authentication

getUserRoles

Set<String> getUserRoles(String site)

getUserRoles

Set<NormalizedRole> getUserRoles(String site,
 String user)

getUserRoles

Set<NormalizedRole> getUserRoles(String site,
 String user,
 boolean includeGlobal)

getUserProfile

Map<String,Object> getUserProfile(String user)
                           throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

getUserProfileByGitName

Map<String,Object> getUserProfileByGitName(String gitName)
                                    throws ServiceLayerException,
UserNotFoundException

Get user by git name. Special use case because git stores user as string of first and last name separated by ' '

Parameters:

gitName - first and last name separated with ' '

Returns:

user

Throws:

ServiceLayerException - general service error

UserNotFoundException - user not found

getUserPermissions

Set<String> getUserPermissions(String site,
 String path,
 String user)

userExists

boolean userExists(String username)
            throws ServiceLayerException

Check if user exists

Parameters:

username - username

Returns:

true if user exists

Throws:

ServiceLayerException - general service error

getAllUsersTotal

int getAllUsersTotal()
              throws ServiceLayerException

Get all users

Returns:

number of all users

Throws:

ServiceLayerException - general service error

isSiteAdmin

boolean isSiteAdmin(String username,
 String site)

Check if given user is site admin

Parameters:

username - user

site - site identifier

Returns:

true if user belongs to admin group

isSystemAdmin

boolean isSystemAdmin(String username)

Check if given user has system_admin role

Parameters:

username - user

Returns:

true if user is system_admin, false otherwise

getUserGlobalRoles

List<NormalizedRole> getUserGlobalRoles(long userId,
 String username)
                                 throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException