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

Class TestSecurityProvider

java.lang.Object

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

All Implemented Interfaces:

SecurityProvider

public class TestSecurityProvider
extends Object
implements SecurityProvider

Constructor Summary

Constructors

Constructor and Description
TestSecurityProvider()

Method Summary

Modifier and Type	Method and Description
void	addConfigWritePermission(String path, String group)
void	addContentWritePermission(String path, String group)
void	addUserGroup(String groupName)
void	addUserGroup(String parentGroup, String groupName)
boolean	addUserToGroup(String siteId, String groupName, String user) Add user to the group
String	authenticate(String username, String password)
boolean	changePassword(String username, String current, String newPassword) Change password
boolean	createGroup(String groupName, String description, String siteId, boolean externallyManaged) Create group with given parameters
boolean	createUser(String username, String password, String firstName, String lastName, String email, boolean externallyManaged) Create new user with given parameters
boolean	deleteGroup(String siteId, String groupName) Delete group with given site id and group name
boolean	deleteUser(String username) Delete user with given username
boolean	enableUser(String username, boolean enabled) Enable/disable user with given username
List<Map<String,Object>>	getAllGroups(int start, int number) Get all groups
List<Map<String,Object>>	getAllUsers(int start, int number) Get all users
int	getAllUsersTotal() Get all users
String	getCurrentToken()
String	getCurrentUser()
Map<String,Object>	getGroup(String site, String group) Get group for given site id with given group name
List<Map<String,Object>>	getGroupsPerSite(String site, int start, int number) Get all groups for given site
int	getGroupsPerSiteTotal(String site) Get number of all groups for given site
Set<String>	getUserGroups(String user)
Set<String>	getUserGroupsPerSite(String user, String site)
Map<String,Object>	getUserProfile(String user)
List<Map<String,Object>>	getUsersPerGroup(String site, String group, int start, int number) Get all users for given site and group
int	getUsersPerGroupTotal(String site, String group) Get number of all users for given site and group
List<Map<String,Object>>	getUsersPerSite(String site, int start, int number) Get all users for given site
int	getUsersPerSiteTotal(String site) Get number of all users for given site
Map<String,Object>	getUserStatus(String username) Get status for given user
boolean	groupExists(String siteId, String groupName) Check if a group exists
boolean	isSystemUser(String username) Check if given user is a system user
boolean	logout()
boolean	removeUserFromGroup(String siteId, String groupName, String user) Remove user from the group
boolean	setUserPassword(String username, String newPassword) Set user password
boolean	updateGroup(String siteId, String groupName, String description) Update group with given parameters
boolean	updateUser(String username, String firstName, String lastName, String email) Update user details
boolean	userExists(String username) Check if a user exists
boolean	userExistsInGroup(String siteId, String groupName, String username) Check if a user is in a group or not
boolean	validateTicket(String ticket)

Methods inherited from class java.lang.Object

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

Constructor Detail

TestSecurityProvider

public TestSecurityProvider()

Method Detail

getUserGroups

public Set<String> getUserGroups(String user)

Specified by:

getUserGroups in interface SecurityProvider

getUserGroupsPerSite

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

Specified by:

getUserGroupsPerSite in interface SecurityProvider

getCurrentUser

public String getCurrentUser()

Specified by:

getCurrentUser in interface SecurityProvider

getUserProfile

public Map<String,Object> getUserProfile(String user)

Specified by:

getUserProfile in interface SecurityProvider

validateTicket

public boolean validateTicket(String ticket)

Specified by:

validateTicket in interface SecurityProvider

authenticate

public String authenticate(String username,
                           String password)

Specified by:

authenticate in interface SecurityProvider

addUserGroup

public void addUserGroup(String groupName)

Specified by:

addUserGroup in interface SecurityProvider

addUserGroup

public void addUserGroup(String parentGroup,
                         String groupName)

Specified by:

addUserGroup in interface SecurityProvider

addUserToGroup

public boolean addUserToGroup(String siteId,
                              String groupName,
                              String user)

Description copied from interface: SecurityProvider

Add user to the group

Specified by:

addUserToGroup in interface SecurityProvider

Parameters:

siteId - site id

groupName - group name

user - username

getCurrentToken

public String getCurrentToken()

Specified by:

getCurrentToken in interface SecurityProvider

groupExists

public boolean groupExists(String siteId,
                           String groupName)

Description copied from interface: SecurityProvider

Check if a group exists

Specified by:

groupExists in interface SecurityProvider

Parameters:

siteId - site Id

groupName - group name

Returns:

true if group exists, false otherwise

userExists

public boolean userExists(String username)

Description copied from interface: SecurityProvider

Check if a user exists

Specified by:

userExists in interface SecurityProvider

Parameters:

username - username

Returns:

true if user exists, false otherwise

userExistsInGroup

public boolean userExistsInGroup(String siteId,
                                 String groupName,
                                 String username)

Description copied from interface: SecurityProvider

Check if a user is in a group or not

Specified by:

userExistsInGroup in interface SecurityProvider

Parameters:

siteId - site

groupName - group name

username - username

Returns:

true if user exists in that group, false otherwise

logout

public boolean logout()

Specified by:

logout in interface SecurityProvider

addContentWritePermission

public void addContentWritePermission(String path,
                                      String group)

Specified by:

addContentWritePermission in interface SecurityProvider

addConfigWritePermission

public void addConfigWritePermission(String path,
                                     String group)

Specified by:

addConfigWritePermission in interface SecurityProvider

createUser

public boolean createUser(String username,
                          String password,
                          String firstName,
                          String lastName,
                          String email,
                          boolean externallyManaged)

Description copied from interface: SecurityProvider

Create new user with given parameters

Specified by:

createUser in interface SecurityProvider

Parameters:

username - username

password - password

firstName - User's first name

lastName - User's last name

email - User's email address

externallyManaged - true if externally managed, otherwise false

Returns:

true if success, otherwise false

deleteUser

public boolean deleteUser(String username)

Description copied from interface: SecurityProvider

Delete user with given username

Specified by:

deleteUser in interface SecurityProvider

Returns:

true if user is deleted

updateUser

public boolean updateUser(String username,
                          String firstName,
                          String lastName,
                          String email)

Description copied from interface: SecurityProvider

Update user details

Specified by:

updateUser in interface SecurityProvider

Returns:

true if user details are successfully updated

enableUser

public boolean enableUser(String username,
                          boolean enabled)

Description copied from interface: SecurityProvider

Enable/disable user with given username

Specified by:

enableUser in interface SecurityProvider

Parameters:

username - username

enabled - true: enable user; false: disable user

Returns:

true if user is successfully enabled

getUserStatus

public Map<String,Object> getUserStatus(String username)

Description copied from interface: SecurityProvider

Get status for given user

Specified by:

getUserStatus in interface SecurityProvider

Returns:

user status

createGroup

public boolean createGroup(String groupName,
                           String description,
                           String siteId,
                           boolean externallyManaged)

Description copied from interface: SecurityProvider

Create group with given parameters

Specified by:

createGroup in interface SecurityProvider

externallyManaged - true if externally managed, otherwise false

Returns:

true if group is successfully created

getAllUsers

public List<Map<String,Object>> getAllUsers(int start,
                                            int number)

Description copied from interface: SecurityProvider

Get all users

Specified by:

getAllUsers in interface SecurityProvider

Returns:

List of all users

getAllUsersTotal

public int getAllUsersTotal()

Description copied from interface: SecurityProvider

Get all users

Specified by:

getAllUsersTotal in interface SecurityProvider

Returns:

List of all users

getUsersPerSite

public List<Map<String,Object>> getUsersPerSite(String site,
                                                int start,
                                                int number)

Description copied from interface: SecurityProvider

Get all users for given site

Specified by:

getUsersPerSite in interface SecurityProvider

number - @return

getUsersPerSiteTotal

public int getUsersPerSiteTotal(String site)
                         throws SiteNotFoundException

Description copied from interface: SecurityProvider

Get number of all users for given site

Specified by:

getUsersPerSiteTotal in interface SecurityProvider

Returns:

total number of users per site

Throws:

SiteNotFoundException

getGroup

public Map<String,Object> getGroup(String site,
                                   String group)

Description copied from interface: SecurityProvider

Get group for given site id with given group name

Specified by:

getGroup in interface SecurityProvider

Parameters:

site - site id

group - group name

Returns:

group details

getAllGroups

public List<Map<String,Object>> getAllGroups(int start,
                                             int number)

Description copied from interface: SecurityProvider

Get all groups

Specified by:

getAllGroups in interface SecurityProvider

Parameters:

start - start index

number - Number of records to retrieve in the result set

Returns:

list of all groups and its details

getGroupsPerSite

public List<Map<String,Object>> getGroupsPerSite(String site,
                                                 int start,
                                                 int number)

Description copied from interface: SecurityProvider

Get all groups for given site

Specified by:

getGroupsPerSite in interface SecurityProvider

Parameters:

site - site id

Returns:

list of groups per site

getGroupsPerSiteTotal

public int getGroupsPerSiteTotal(String site)

Description copied from interface: SecurityProvider

Get number of all groups for given site

Specified by:

getGroupsPerSiteTotal in interface SecurityProvider

Parameters:

site - site id

Returns:

total number of groups

getUsersPerGroup

public List<Map<String,Object>> getUsersPerGroup(String site,
                                                 String group,
                                                 int start,
                                                 int number)

Description copied from interface: SecurityProvider

Get all users for given site and group

Specified by:

getUsersPerGroup in interface SecurityProvider

Parameters:

site - site id

group - group name

start - start index

number - number of records to retrieve in the result set

Returns:

list of users of the group paginated

getUsersPerGroupTotal

public int getUsersPerGroupTotal(String site,
                                 String group)
                          throws GroupNotFoundException

Description copied from interface: SecurityProvider

Get number of all users for given site and group

Specified by:

getUsersPerGroupTotal in interface SecurityProvider

Parameters:

site - site id

group - group name

Returns:

total number of users for given group

Throws:

GroupNotFoundException

updateGroup

public boolean updateGroup(String siteId,
                           String groupName,
                           String description)

Description copied from interface: SecurityProvider

Update group with given parameters

Specified by:

updateGroup in interface SecurityProvider

Returns:

true if group is successfully updated

deleteGroup

public boolean deleteGroup(String siteId,
                           String groupName)

Description copied from interface: SecurityProvider

Delete group with given site id and group name

Specified by:

deleteGroup in interface SecurityProvider

Returns:

true if group is successfully deleted

removeUserFromGroup

public boolean removeUserFromGroup(String siteId,
                                   String groupName,
                                   String user)

Description copied from interface: SecurityProvider

Remove user from the group

Specified by:

removeUserFromGroup in interface SecurityProvider

Parameters:

siteId - site id

groupName - group name

user - username

changePassword

public boolean changePassword(String username,
                              String current,
                              String newPassword)

Description copied from interface: SecurityProvider

Change password

Specified by:

changePassword in interface SecurityProvider

Parameters:

username - username

current - current password

newPassword - new password

Returns:

true if password is succcessfully changed

setUserPassword

public boolean setUserPassword(String username,
                               String newPassword)

Description copied from interface: SecurityProvider

Set user password

Specified by:

setUserPassword in interface SecurityProvider

Parameters:

username - username

newPassword - new password

Returns:

true if password is successfully set

isSystemUser

public boolean isSystemUser(String username)
                     throws UserNotFoundException

Description copied from interface: SecurityProvider

Check if given user is a system user

Specified by:

isSystemUser in interface SecurityProvider

Parameters:

username - username

Returns:

true if user is system user

Throws:

UserNotFoundException