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

Class SecurityServiceImpl

java.lang.Object

org.craftercms.studio.impl.v1.service.security.SecurityServiceImpl

All Implemented Interfaces:

SecurityService

public class SecurityServiceImpl
extends Object
implements SecurityService

Author:

Dejan Brkic

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditServiceInternal	auditServiceInternal
protected com.google.common.cache.Cache<String,PermissionsConfigTO>	cache
protected ConfigurationService	configurationService
protected ContentService	contentService
protected ContentTypeService	contentTypeService
protected org.springframework.mail.javamail.JavaMailSender	emailService
protected org.springframework.mail.javamail.JavaMailSender	emailServiceNoAuth
protected org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig>	freeMarkerConfig
protected GeneralLockService	generalLockService
protected GroupService	groupService
protected SiteService	siteService
protected StudioConfiguration	studioConfiguration
protected UserServiceInternal	userServiceInternal

Constructor Summary

Constructors

Constructor	Description
SecurityServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addGlobalGroupRoles(Set<NormalizedRole> roles, List<String> groups, PermissionsConfigTO rolesConfig)
protected void	addGlobalUserRoles(String user, Set<NormalizedRole> roles, PermissionsConfigTO rolesConfig)
protected void	addUserRoles(Set<NormalizedRole> roles, String site, String user)	add user roles
int	getAllUsersTotal()	Get all users
AuditServiceInternal	getAuditServiceInternal()
org.springframework.security.core.Authentication	getAuthentication()	Returns the Authentication for the current user or null if not user is authenticated.
ConfigurationService	getConfigurationService()
ContentService	getContentService()
ContentTypeService	getContentTypeService()
String	getCurrentUser()	Returns the username of the current user OR NULL if no user is authenticated
String	getDefaultFromAddress()
org.springframework.mail.javamail.JavaMailSender	getEmailService()
org.springframework.mail.javamail.JavaMailSender	getEmailServiceNoAuth()
org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig>	getFreeMarkerConfig()
GeneralLockService	getGeneralLockService()
String	getGlobalConfigPath()
String	getGlobalPermissionsFileName()
String	getGlobalRoleMappingsFileName()
GroupService	getGroupService()
String	getPermissionsFileName()
protected String	getPermissionsKey(String site, String filename)
String	getRoleMappingsFileName()
protected Map<NormalizedGroup,List<NormalizedRole>>	getRoles(List<org.dom4j.Node> nodes, Map<NormalizedGroup,List<NormalizedRole>> rolesMap)
int	getSessionTimeout()
SiteService	getSiteService()
StudioConfiguration	getStudioConfiguration()
String	getSystemSite()
@Valid List<NormalizedRole>	getUserGlobalRoles(long userId, String username)
@Valid Set<String>	getUserPermissions(String site, String path, String user)
@Valid Map<String,Object>	getUserProfile(String user)
Map<String,Object>	getUserProfileByGitName(String gitName)	Get user by git name.
@Valid Set<String>	getUserRoles(String site)
@Valid Set<NormalizedRole>	getUserRoles(String site, String user)
@Valid Set<NormalizedRole>	getUserRoles(String site, String user, boolean includeGlobal)
UserServiceInternal	getUserServiceInternal()
boolean	isAuthenticatedSMTP()
@jakarta.validation.Valid boolean	isSiteAdmin(String username, String site)	Check if given user is site admin
@jakarta.validation.Valid boolean	isSystemAdmin(String username)	Check if given user has system_admin role
protected PermissionsConfigTO	loadConfiguration(String site, String filename)
protected PermissionsConfigTO	loadGlobalPermissionsConfiguration()
protected PermissionsConfigTO	loadGlobalRolesConfiguration()
protected void	loadPermissions(String siteId, org.dom4j.Element root, PermissionsConfigTO config)
protected void	loadRoles(org.dom4j.Element root, PermissionsConfigTO config)
protected Set<String>	populateUserGlobalPermissions(String path, Set<NormalizedRole> roles, PermissionsConfigTO permissionsConfig)
protected Set<String>	populateUserPermissions(String site, String path, Set<NormalizedRole> roles, PermissionsConfigTO permissionsConfig)	populate user permissions
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setCache(com.google.common.cache.Cache<String,PermissionsConfigTO> cache)
void	setConfigurationService(ConfigurationService configurationService)
void	setContentService(ContentService contentService)
void	setContentTypeService(ContentTypeService contentTypeService)
void	setEmailService(org.springframework.mail.javamail.JavaMailSender emailService)
void	setEmailServiceNoAuth(org.springframework.mail.javamail.JavaMailSender emailServiceNoAuth)
void	setFreeMarkerConfig(org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig> freeMarkerConfig)
void	setGeneralLockService(GeneralLockService generalLockService)
void	setGroupService(GroupService groupService)
void	setSiteService(SiteService siteService)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	setUserServiceInternal(UserServiceInternal userServiceInternal)
@jakarta.validation.Valid boolean	userExists(String username)	Check if user exists

Methods inherited from class java.lang.Object

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

Field Details

contentTypeService

protected ContentTypeService contentTypeService

contentService

protected ContentService contentService

generalLockService

protected GeneralLockService generalLockService

studioConfiguration

protected StudioConfiguration studioConfiguration

emailService

protected org.springframework.mail.javamail.JavaMailSender emailService

emailServiceNoAuth

protected org.springframework.mail.javamail.JavaMailSender emailServiceNoAuth

freeMarkerConfig

protected org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig> freeMarkerConfig

groupService

protected GroupService groupService

userServiceInternal

protected UserServiceInternal userServiceInternal

configurationService

protected ConfigurationService configurationService

auditServiceInternal

protected AuditServiceInternal auditServiceInternal

siteService

protected SiteService siteService

cache

protected com.google.common.cache.Cache<String,PermissionsConfigTO> cache

Constructor Details

SecurityServiceImpl

public SecurityServiceImpl()

Method Details

getCurrentUser

public String getCurrentUser()

Description copied from interface: SecurityService

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

Specified by:

getCurrentUser in interface SecurityService

Returns:

current user

getUserProfile

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

Specified by:

getUserProfile in interface SecurityService

Throws:

ServiceLayerException

UserNotFoundException

getUserProfileByGitName

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

Description copied from interface: SecurityService

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

Specified by:

getUserProfileByGitName in interface SecurityService

Parameters:

gitName - first and last name separated with ' '

Returns:

user

Throws:

ServiceLayerException - general service error

UserNotFoundException - user not found

getUserPermissions

@Valid
public @Valid Set<String> getUserPermissions(String site,
 String path,
 String user)

Specified by:

getUserPermissions in interface SecurityService

addGlobalUserRoles

protected void addGlobalUserRoles(String user,
 Set<NormalizedRole> roles,
 PermissionsConfigTO rolesConfig)

addGlobalGroupRoles

protected void addGlobalGroupRoles(Set<NormalizedRole> roles,
 List<String> groups,
 PermissionsConfigTO rolesConfig)

populateUserGlobalPermissions

protected Set<String> populateUserGlobalPermissions(String path,
 Set<NormalizedRole> roles,
 PermissionsConfigTO permissionsConfig)

getPermissionsKey

protected String getPermissionsKey(String site,
 String filename)

addUserRoles

protected void addUserRoles(Set<NormalizedRole> roles,
 String site,
 String user)

add user roles

Parameters:

roles -

site -

user -

getUserRoles

@Valid
public @Valid Set<String> getUserRoles(String site)

Specified by:

getUserRoles in interface SecurityService

getUserRoles

@Valid
public @Valid Set<NormalizedRole> getUserRoles(String site,
 String user)

Specified by:

getUserRoles in interface SecurityService

getUserRoles

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

Specified by:

getUserRoles in interface SecurityService

populateUserPermissions

protected Set<String> populateUserPermissions(String site,
 String path,
 Set<NormalizedRole> roles,
 PermissionsConfigTO permissionsConfig)

populate user permissions

Parameters:

site -

path -

roles -

permissionsConfig -

loadConfiguration

protected PermissionsConfigTO loadConfiguration(String site,
 String filename)

loadRoles

protected void loadRoles(org.dom4j.Element root,
 PermissionsConfigTO config)

getRoles

protected Map<NormalizedGroup,List<NormalizedRole>> getRoles(List<org.dom4j.Node> nodes,
 Map<NormalizedGroup,List<NormalizedRole>> rolesMap)

loadPermissions

protected void loadPermissions(String siteId,
 org.dom4j.Element root,
 PermissionsConfigTO config)

loadGlobalPermissionsConfiguration

protected PermissionsConfigTO loadGlobalPermissionsConfiguration()

loadGlobalRolesConfiguration

protected PermissionsConfigTO loadGlobalRolesConfiguration()

getAllUsersTotal

public int getAllUsersTotal()
                     throws ServiceLayerException

Description copied from interface: SecurityService

Get all users

Specified by:

getAllUsersTotal in interface SecurityService

Returns:

number of all users

Throws:

ServiceLayerException - general service error

isSystemAdmin

@Valid
public @jakarta.validation.Valid boolean isSystemAdmin(String username)

Description copied from interface: SecurityService

Check if given user has system_admin role

Specified by:

isSystemAdmin in interface SecurityService

Parameters:

username - user

Returns:

true if user is system_admin, false otherwise

isSiteAdmin

@Valid
public @jakarta.validation.Valid boolean isSiteAdmin(String username,
 String site)

Description copied from interface: SecurityService

Check if given user is site admin

Specified by:

isSiteAdmin in interface SecurityService

Parameters:

username - user

site - site identifier

Returns:

true if user belongs to admin group

userExists

@Valid
public @jakarta.validation.Valid boolean userExists(String username)
                                             throws ServiceLayerException

Description copied from interface: SecurityService

Check if user exists

Specified by:

userExists in interface SecurityService

Parameters:

username - username

Returns:

true if user exists

Throws:

ServiceLayerException - general service error

getAuthentication

public org.springframework.security.core.Authentication getAuthentication()

Description copied from interface: SecurityService

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

Specified by:

getAuthentication in interface SecurityService

Returns:

authentication

getUserGlobalRoles

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

Specified by:

getUserGlobalRoles in interface SecurityService

Throws:

ServiceLayerException

UserNotFoundException

getRoleMappingsFileName

public String getRoleMappingsFileName()

getPermissionsFileName

public String getPermissionsFileName()

getGlobalConfigPath

public String getGlobalConfigPath()

getGlobalRoleMappingsFileName

public String getGlobalRoleMappingsFileName()

getGlobalPermissionsFileName

public String getGlobalPermissionsFileName()

getSessionTimeout

public int getSessionTimeout()

isAuthenticatedSMTP

public boolean isAuthenticatedSMTP()

getDefaultFromAddress

public String getDefaultFromAddress()

getSystemSite

public String getSystemSite()

getContentTypeService

public ContentTypeService getContentTypeService()

setContentTypeService

public void setContentTypeService(ContentTypeService contentTypeService)

getContentService

public ContentService getContentService()

setContentService

public void setContentService(ContentService contentService)

getGeneralLockService

public GeneralLockService getGeneralLockService()

setGeneralLockService

public void setGeneralLockService(GeneralLockService generalLockService)

getStudioConfiguration

public StudioConfiguration getStudioConfiguration()

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

getEmailService

public org.springframework.mail.javamail.JavaMailSender getEmailService()

setEmailService

public void setEmailService(org.springframework.mail.javamail.JavaMailSender emailService)

getEmailServiceNoAuth

public org.springframework.mail.javamail.JavaMailSender getEmailServiceNoAuth()

setEmailServiceNoAuth

public void setEmailServiceNoAuth(org.springframework.mail.javamail.JavaMailSender emailServiceNoAuth)

getFreeMarkerConfig

public org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig> getFreeMarkerConfig()

setFreeMarkerConfig

public void setFreeMarkerConfig(org.springframework.beans.factory.ObjectFactory<org.springframework.web.servlet.view.freemarker.FreeMarkerConfig> freeMarkerConfig)

getGroupService

public GroupService getGroupService()

setGroupService

public void setGroupService(GroupService groupService)

getUserServiceInternal

public UserServiceInternal getUserServiceInternal()

setUserServiceInternal

public void setUserServiceInternal(UserServiceInternal userServiceInternal)

getConfigurationService

public ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getAuditServiceInternal

public AuditServiceInternal getAuditServiceInternal()

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

getSiteService

public SiteService getSiteService()

setSiteService

public void setSiteService(SiteService siteService)

setCache

public void setCache(com.google.common.cache.Cache<String,PermissionsConfigTO> cache)