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 and Description
protected AuditServiceInternal	auditServiceInternal
protected AuthenticationChain	authenticationChain
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 UserDetailsManager	userDetailsManager
protected UserServiceInternal	userServiceInternal

Fields inherited from interface org.craftercms.studio.api.v1.service.security.SecurityService

STUDIO_SESSION_TOKEN_ATRIBUTE

Constructor Summary

Constructors

Constructor and Description
SecurityServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	addGlobalGroupRoles(Set<String> roles, List<String> groups, PermissionsConfigTO rolesConfig)
protected void	addGlobalUserRoles(String user, Set<String> roles, PermissionsConfigTO rolesConfig)
protected void	addGroupRoles(Set<String> roles, String site, List<String> groups, PermissionsConfigTO rolesConfig) get roles by groups
protected void	addUserRoles(Set<String> roles, String site, String user) add user roles
String	authenticate(String username, String password) authenticate a user.
boolean	changePassword(String username, String current, String newPassword) Change password
int	getAllUsersTotal() Get all users
AuditServiceInternal	getAuditServiceInternal()
Authentication	getAuthentication() Returns the Authentication for the current user or null if not user is authenticated.
AuthenticationChain	getAuthenticationChain()
ConfigurationService	getConfigurationService()
ContentService	getContentService()
ContentTypeService	getContentTypeService()
String	getCurrentToken()
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()
protected String	getJobOrEventTicket()
String	getPermissionsFileName()
protected String	getPermissionsKey(String site, String filename)
String	getRoleMappingsFileName()
protected Map<String,List<String>>	getRoles(List<org.dom4j.Node> nodes, Map<String,List<String>> rolesMap)
int	getSessionTimeout()
SiteService	getSiteService()
StudioConfiguration	getStudioConfiguration()
String	getSystemSite()
UserDetailsManager	getUserDetailsManager()
Set<String>	getUserPermissions(String site, String path, List<String> groups)
Set<String>	getUserPermissions(String site, String path, String user, List<String> groups)
Map<String,Object>	getUserProfile(String user)
Map<String,Object>	getUserProfileByGitName(String gitName) Get user by git name.
Set<String>	getUserRoles(String site)
Set<String>	getUserRoles(String site, String user)
Set<String>	getUserRoles(String site, String user, boolean includeGlobal)
UserServiceInternal	getUserServiceInternal()
boolean	isAuthenticatedSMTP()
boolean	isSiteAdmin(String username, String site) Check if given user is site admin
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)
boolean	logout()
protected Set<String>	populateUserGlobalPermissions(String path, Set<String> roles, PermissionsConfigTO permissionsConfig)
protected Set<String>	populateUserPermissions(String site, String path, Set<String> roles, PermissionsConfigTO permissionsConfig) populate user permissions
void	reloadConfiguration(String site)
void	reloadGlobalConfiguration()
boolean	resetPassword(String username, String newPassword) Reset user password
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setAuthenticationChain(AuthenticationChain authenticationChain)
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	setUserDetailsManager(UserDetailsManager userDetailsManager)
Map<String,Object>	setUserPassword(String token, String newPassword) Set user password - forgot password token
void	setUserServiceInternal(UserServiceInternal userServiceInternal)
boolean	userExists(String username) Check if user exists
boolean	validateSession(javax.servlet.http.HttpServletRequest request) Validate user's active session
boolean	validateTicket(String ticket)
boolean	validateToken(String token) Forgot password token to validate

Methods inherited from class java.lang.Object

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

Field Detail

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

userDetailsManager

protected UserDetailsManager userDetailsManager

freeMarkerConfig

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

groupService

protected GroupService groupService

userServiceInternal

protected UserServiceInternal userServiceInternal

authenticationChain

protected AuthenticationChain authenticationChain

configurationService

protected ConfigurationService configurationService

auditServiceInternal

protected AuditServiceInternal auditServiceInternal

siteService

protected SiteService siteService

Constructor Detail

SecurityServiceImpl

public SecurityServiceImpl()

Method Detail

authenticate

public String authenticate(String username,
                           String password)
                    throws Exception

Description copied from interface: SecurityService

authenticate a user. returns ticket

Specified by:

authenticate in interface SecurityService

Throws:

Exception

validateTicket

public boolean validateTicket(String ticket)

Specified by:

validateTicket in interface SecurityService

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

getCurrentToken

public String getCurrentToken()

Specified by:

getCurrentToken in interface SecurityService

getUserProfile

public 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

UserNotFoundException

getUserPermissions

public Set<String> getUserPermissions(String site,
                                      String path,
                                      List<String> groups)

Specified by:

getUserPermissions in interface SecurityService

getUserPermissions

public Set<String> getUserPermissions(String site,
                                      String path,
                                      String user,
                                      List<String> groups)

Specified by:

getUserPermissions in interface SecurityService

addGlobalUserRoles

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

addGlobalGroupRoles

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

populateUserGlobalPermissions

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

getPermissionsKey

protected String getPermissionsKey(String site,
                                   String filename)

addUserRoles

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

add user roles

Parameters:

roles -

site -

user -

getUserRoles

public Set<String> getUserRoles(String site)

Specified by:

getUserRoles in interface SecurityService

getUserRoles

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

Specified by:

getUserRoles in interface SecurityService

getUserRoles

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

Specified by:

getUserRoles in interface SecurityService

addGroupRoles

protected void addGroupRoles(Set<String> roles,
                             String site,
                             List<String> groups,
                             PermissionsConfigTO rolesConfig)

get roles by groups

Parameters:

site -

groups -

rolesConfig -

populateUserPermissions

protected Set<String> populateUserPermissions(String site,
                                              String path,
                                              Set<String> 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<String,List<String>> getRoles(List<org.dom4j.Node> nodes,
                                            Map<String,List<String>> rolesMap)

loadPermissions

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

loadGlobalPermissionsConfiguration

protected PermissionsConfigTO loadGlobalPermissionsConfiguration()

loadGlobalRolesConfiguration

protected PermissionsConfigTO loadGlobalRolesConfiguration()

reloadConfiguration

public void reloadConfiguration(String site)

Specified by:

reloadConfiguration in interface SecurityService

reloadGlobalConfiguration

public void reloadGlobalConfiguration()

Specified by:

reloadGlobalConfiguration in interface SecurityService

logout

public boolean logout()
               throws SiteNotFoundException

Specified by:

logout in interface SecurityService

Throws:

SiteNotFoundException

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

validateToken

public boolean validateToken(String token)
                      throws UserNotFoundException,
                             UserExternallyManagedException,
                             ServiceLayerException

Description copied from interface: SecurityService

Forgot password token to validate

Specified by:

validateToken in interface SecurityService

Parameters:

token - token

Returns:

true if given token is valid

Throws:

UserNotFoundException

UserExternallyManagedException

ServiceLayerException

changePassword

public boolean changePassword(String username,
                              String current,
                              String newPassword)
                       throws PasswordDoesNotMatchException,
                              UserExternallyManagedException,
                              ServiceLayerException

Description copied from interface: SecurityService

Change password

Specified by:

changePassword in interface SecurityService

Parameters:

username - username

current - current password

newPassword - new password

Returns:

true if user's password is successfully changed

Throws:

PasswordDoesNotMatchException

UserExternallyManagedException

ServiceLayerException

setUserPassword

public Map<String,Object> setUserPassword(String token,
                                          String newPassword)
                                   throws UserNotFoundException,
                                          UserExternallyManagedException,
                                          ServiceLayerException

Description copied from interface: SecurityService

Set user password - forgot password token

Specified by:

setUserPassword in interface SecurityService

Parameters:

token - forgot password token

newPassword - new password

Returns:

true if uses's password is successfully set

Throws:

UserNotFoundException

UserExternallyManagedException

ServiceLayerException

resetPassword

public boolean resetPassword(String username,
                             String newPassword)
                      throws UserNotFoundException,
                             UserExternallyManagedException,
                             ServiceLayerException

Description copied from interface: SecurityService

Reset user password

Specified by:

resetPassword in interface SecurityService

Parameters:

username - username

newPassword - new password

Returns:

true if user's password is successfully reset

Throws:

UserNotFoundException

UserExternallyManagedException

ServiceLayerException

isSiteAdmin

public 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

public 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

validateSession

public boolean validateSession(javax.servlet.http.HttpServletRequest request)
                        throws ServiceLayerException

Description copied from interface: SecurityService

Validate user's active session

Specified by:

validateSession in interface SecurityService

Returns:

true if user session is valid

Throws:

ServiceLayerException

getAuthentication

public 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

getJobOrEventTicket

protected String getJobOrEventTicket()

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)

getUserDetailsManager

public UserDetailsManager getUserDetailsManager()

setUserDetailsManager

public void setUserDetailsManager(UserDetailsManager userDetailsManager)

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)

getAuthenticationChain

public AuthenticationChain getAuthenticationChain()

setAuthenticationChain

public void setAuthenticationChain(AuthenticationChain authenticationChain)

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)