Package com.randomnoun.common.security.impl

Class SpringSecurityLoaderImpl

java.lang.Object

com.randomnoun.common.security.impl.SpringSecurityLoaderImpl

All Implemented Interfaces:

SecurityLoader

public class SpringSecurityLoaderImpl
extends Object
implements SecurityLoader

An implementation of the SecurityLoader class, using the Spring framework to populate the SecurityContext from a JDBC datasource.

This security context used to optionally take a customerId (used to partition users across separate SaaS contexts), or an applicationId (used to partition permissions across separate software products). If not defined, then these columns did not need to be present in the database. This functionality has been deprecated.

I think we had String userids at one point as well, so look out for that.

This class has a number of initialisation properties that are specific to this class (in addition to those initialisation properties that are set by the SecurityContext itself):

• INIT_JDBCTEMPLATE - The Spring JdbcTemplate class used to retrieve information from a database.
• INIT_DATABASE_VENDOR - Set to one of the SqlGenerator.DATABASE_* constants, which specifies what syntax of SQL to use (DB2, Oracle or SqlServer).

Author:

knoxg

Field Summary

Fields

Modifier and Type	Field	Description
final CamelCaser	auditCamelCaser	Column renamer for the SECURITYAUDITS table
static final String	INIT_CASE_INSENSITIVE_OBJ	Boolean object version of SecurityContext.INIT_CASE_INSENSITIVE string; set to false if missing
static final String	INIT_DATABASE_VENDOR	Database vendor for generated SQL.
static final String	INIT_JDBCTEMPLATE	Initialisation property key to set JdbcTemplate.
static final org.apache.log4j.Logger	logger	Logger for this class
final CamelCaser	permissionCamelCaser	Column renamer for the PERMISSION table
final CamelCaser	roleCamelCaser	Column renamer for the shouty ROLETABLE table
final CamelCaser	userCamelCaser	Column renamer for the USERS table

Constructor Summary

Constructors

Constructor	Description
SpringSecurityLoaderImpl()

Method Summary

Modifier and Type	Method	Description
void	initialise(Map<String,Object> properties)	Initialise this loader.
List<String>	loadAllActivities(String resourceName)	Retrieve a list of all the activities that can be applied to resource for the current application context.
List<Permission>	loadAllPermissions()	Return a List of all Permissions available to this application
List<String>	loadAllResources()	Retrieve a list of all the resources under security for the current application context.
List<Map<String,Object>>	loadAllRoleDetails()	Returns List of maps, where each map represents the details of a particular role.
List<Permission>	loadAllRolePermissions()	Load all role permissions.
List<String>	loadAllRoles()	Retrieve a list of all the roles that can be applied to a user for the current application context.
List<Map<String,Object>>	loadAllUserDetails()	Returns List of maps, where each map represents the details of a particular user.
List<User>	loadAllUsers()	Retrieve a list of users in the current application context.
List<Permission>	loadRolePermissions(String role)	Return List of Permission associated with a particular role
User	loadUser(long userId)	Load a user.
List<Permission>	loadUserPermissions(User user)	Retrieve per-user permission objects.
List<Permission>	loadUserRolePermissions(User user)	Return List of Permissions containing permissions contained for all roles for a particular user.
List<String>	loadUserRoles(User user)	Retrieve a list of roles applied to a particular user for the current application context.
void	resetSecurityContext()	Resets the security context.
void	saveRolePermissions(String role, List<Permission> rolePermissions)	Persists the permission information for this role to the database.
void	saveUserRolesAndPermissions(User user, List<String> roles, List<Permission> userPermissions)	Persists the role and permission information recorded for this user to the database.

Methods inherited from class java.lang.Object

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

Field Details

logger

public static final org.apache.log4j.Logger logger

Logger for this class

INIT_JDBCTEMPLATE

public static final String INIT_JDBCTEMPLATE

Initialisation property key to set JdbcTemplate.

See Also:

• Constant Field Values

INIT_DATABASE_VENDOR

public static final String INIT_DATABASE_VENDOR

Database vendor for generated SQL. Should be one of the SqlGenerator.DB_* constants

See Also:

• Constant Field Values

INIT_CASE_INSENSITIVE_OBJ

public static final String INIT_CASE_INSENSITIVE_OBJ

Boolean object version of SecurityContext.INIT_CASE_INSENSITIVE string; set to false if missing

See Also:

• Constant Field Values

roleCamelCaser

public final CamelCaser roleCamelCaser

Column renamer for the shouty ROLETABLE table

userCamelCaser

public final CamelCaser userCamelCaser

Column renamer for the USERS table

permissionCamelCaser

public final CamelCaser permissionCamelCaser

Column renamer for the PERMISSION table

auditCamelCaser

public final CamelCaser auditCamelCaser

Column renamer for the SECURITYAUDITS table

Constructor Details

SpringSecurityLoaderImpl

public SpringSecurityLoaderImpl()

Method Details

initialise

public void initialise(Map<String,Object> properties)

Initialise this loader.

The properties Map passed into this method must contain the following attributes. jdbcTemplate - a JdbcTemplate object connected to a datasource databaseVendor - one of the SqlGenerator.DATABASE_* constants, defining what syntax of SQL to generate from this class.

Specified by:

initialise in interface SecurityLoader

Parameters:

properties - Initialisation properties for this loader.

See Also:

• SecurityLoader.initialise(java.util.Map)

loadAllRolePermissions

public List<Permission> loadAllRolePermissions()
                                        throws IOException

Load all role permissions. Return a structured list of application specific Permission objects which is used to preload the SecurityContext rolePermission cache. Each permission returned must be a role-based Permission.

Specified by:

loadAllRolePermissions in interface SecurityLoader

Returns:

A List of Permission objects for all roles in the current application. Does not return Permissions that are not explicitly associated with a role in the security table.

Throws:

IOException - if an error occured loading from the database. This IOException will always contain a spring DataAccessException which can be accessed in its .getCause() method.

See Also:

• SecurityLoader.loadAllRolePermissions()

loadUserPermissions

public List<Permission> loadUserPermissions(User user)
                                     throws IOException

Retrieve per-user permission objects. Returns the list of permissions assigned to this user.

Specified by:

loadUserPermissions in interface SecurityLoader

Throws:

IOException - if an error occured loading from the database. This IOException will always contain a spring DataAccessException which can be accessed in its .getCause() method.

See Also:

• invalid reference

  com.randomnoun.common.security.SecurityLoader#loadUserPermission()

loadUserRoles

public List<String> loadUserRoles(User user)

Retrieve a list of roles applied to a particular user for the current application context.

Specified by:

loadUserRoles in interface SecurityLoader

Returns:

List of roles, represented as Strings

See Also:

• invalid reference

  com.randomnoun.common.security.SecurityLoader#loadRolesForUser()

loadRolePermissions

public List<Permission> loadRolePermissions(String role)

Return List of Permission associated with a particular role

Specified by:

loadRolePermissions in interface SecurityLoader

Parameters:

role -

Returns:

A List of Permission objects that apply to that role

loadUserRolePermissions

public List<Permission> loadUserRolePermissions(User user)

Return List of Permissions containing permissions contained for all roles for a particular user.

Note that if a user contains multiple roles that have permissions that apply to the same activity/resource combinations, then that will be reflected in the returned list.

Specified by:

loadUserRolePermissions in interface SecurityLoader

Parameters:

userid - Name of user we are interested in.

Returns:

A List of Maps

loadAllPermissions

public List<Permission> loadAllPermissions()

Return a List of all Permissions available to this application

Specified by:

loadAllPermissions in interface SecurityLoader

Returns:

a List of Permissions available to this application

loadUser

public User loadUser(long userId)
              throws IOException

Description copied from interface: SecurityLoader

Load a user. Will not load any role or permission data for that user.

Will probably throw an IOException if the user doesn't exist.

Specified by:

loadUser in interface SecurityLoader

Returns:

a User object.

Throws:

IOException

loadAllUsers

public List<User> loadAllUsers()
                        throws IOException

Retrieve a list of users in the current application context. Return a list of User objects representing all users contained in this security context. Permission information relating to that user is not populated unless the 'populatePermission' parameter is set to true.

The information returned by this function may be cached, depending on the initialisation properties of the security context.

Specified by:

loadAllUsers in interface SecurityLoader

Returns:

A List of Users.

Throws:

IOException - if an error occured loading from the database. This IOException will always contain a spring DataAccessException which can be accessed via

invalid reference

java.io.Throwable#getCause

method.

See Also:

• SecurityLoader.loadAllUsers()

loadAllResources

public List<String> loadAllResources()

Retrieve a list of all the resources under security for the current application context.

Specified by:

loadAllResources in interface SecurityLoader

Returns:

List of maps, each map represents resource

See Also:

• SecurityLoader.loadAllResources()

loadAllActivities

public List<String> loadAllActivities(String resourceName)

Retrieve a list of all the activities that can be applied to resource for the current application context.

Specified by:

loadAllActivities in interface SecurityLoader

Parameters:

resourceName - The resource we wish to retrieve activities for

Returns:

List of maps, each map represents an activity.

See Also:

• invalid reference

  com.randomnoun.common.security.SecurityLoader#loadAllActivities()

loadAllRoles

public List<String> loadAllRoles()

Retrieve a list of all the roles that can be applied to a user for the current application context.

Specified by:

loadAllRoles in interface SecurityLoader

Returns:

List of maps, each map represents a role.

See Also:

• SecurityLoader.loadAllRoles()

loadAllRoleDetails

public List<Map<String,Object>> loadAllRoleDetails()

Returns List of maps, where each map represents the details of a particular role.

Specified by:

loadAllRoleDetails in interface SecurityLoader

Returns:

A List of Roles, in Map format.

loadAllUserDetails

public List<Map<String,Object>> loadAllUserDetails()

Returns List of maps, where each map represents the details of a particular user.

Specified by:

loadAllUserDetails in interface SecurityLoader

Returns:

A List of Users, in Map format.

resetSecurityContext

public void resetSecurityContext()

Resets the security context.

This security context holds no state, so this method does nothing.

Specified by:

resetSecurityContext in interface SecurityLoader

saveUserRolesAndPermissions

public void saveUserRolesAndPermissions(User user,
 List<String> roles,
 List<Permission> userPermissions)
                                 throws IOException

Description copied from interface: SecurityLoader

Persists the role and permission information recorded for this user to the database. Existing role and permission information in the database will be removed.

Specified by:

saveUserRolesAndPermissions in interface SecurityLoader

Parameters:

user - The user to persist

Throws:

IOException

saveRolePermissions

public void saveRolePermissions(String role,
 List<Permission> rolePermissions)
                         throws IOException

Description copied from interface: SecurityLoader

Persists the permission information for this role to the database. Existing permission information in the database will be removed.

Specified by:

saveRolePermissions in interface SecurityLoader

Throws:

IOException