Package com.randomnoun.common.security.impl

Class NullSecurityLoaderImpl

java.lang.Object

com.randomnoun.common.security.impl.NullSecurityLoaderImpl

All Implemented Interfaces:

SecurityLoader

public class NullSecurityLoaderImpl
extends Object
implements SecurityLoader

An implementation of the SecurityLoader class, that does absolutely nothing.

All methods do nothing or return empty lists, and searches for user or role IDs return -1.

Author:

knoxg

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.log4j.Logger	logger	Logger for this class

Constructor Summary

Constructors

Constructor	Description
NullSecurityLoaderImpl()

Method Summary

Modifier and Type	Method	Description
void	initialise(Map<String,Object> properties)	Initialise this loader.
List<String>	loadAllActivities(String resourceName)	Return a List of all activities in this security context for a given resource, identified by String.
List<Permission>	loadAllPermissions()	Return a List of all permissions in this security context, as Permission objects.
List<String>	loadAllResources()	Return a List of all resources in this security context, identified by String.
List<Map<String,Object>>	loadAllRoleDetails()	Return a List of all roles in this security context.
List<Permission>	loadAllRolePermissions()	Return a structured list of application specific Permission objects which is used to preload the SecurityContext rolePermission cache.
List<String>	loadAllRoles()	Return a List of all roles in this security context, identified by String.
List<Map<String,Object>>	loadAllUserDetails()	Return a List of all users in this security context.
List<User>	loadAllUsers()	Return a list of User objects representing all users contained in this security context.
List<Permission>	loadRolePermissions(String role)	Return List of Permission objects associated with a particular role
User	loadUser(long userId)	Load a user.
List<Permission>	loadUserPermissions(User user)	Returns the list of permissions assigned to this user.
List<Permission>	loadUserRolePermissions(User user)	Return a list of Permission objects associated with the roles possessed by a particular user.
List<String>	loadUserRoles(User user)	Returns the list of roles assigned to this user.
void	resetSecurityContext()	Informs any delegate security contexts to reset themselves.
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

Constructor Details

NullSecurityLoaderImpl

public NullSecurityLoaderImpl()

Method Details

initialise

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

Initialise this loader.

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

Description copied from interface: SecurityLoader

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

Throws:

IOException

loadRolePermissions

public List<Permission> loadRolePermissions(String role)
                                     throws IOException

Description copied from interface: SecurityLoader

Return List of Permission objects associated with a particular role

Specified by:

loadRolePermissions in interface SecurityLoader

Throws:

IOException

loadUserRolePermissions

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

Description copied from interface: SecurityLoader

Return a list of Permission objects associated with the roles possessed by a particular user. Equivalent to appending the results of calling SecurityLoader.loadRolePermissions(String) for each role that a user is in.

Specified by:

loadUserRolePermissions in interface SecurityLoader

Throws:

IOException

loadUserPermissions

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

Description copied from interface: SecurityLoader

Returns the list of permissions assigned to this user.

Specified by:

loadUserPermissions in interface SecurityLoader

Throws:

IOException

loadUserRoles

public List<String> loadUserRoles(User user)
                           throws IOException

Description copied from interface: SecurityLoader

Returns the list of roles assigned to this user.

Specified by:

loadUserRoles in interface SecurityLoader

Throws:

IOException

loadUser

public User loadUser(long userId)

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.

loadAllUsers

public List<User> loadAllUsers()
                        throws IOException

Description copied from interface: SecurityLoader

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

loadAllResources

public List<String> loadAllResources()
                              throws IOException

Description copied from interface: SecurityLoader

Return a List of all resources in this security context, identified by String.

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

Specified by:

loadAllResources in interface SecurityLoader

Returns:

A List of resources.

Throws:

IOException

loadAllActivities

public List<String> loadAllActivities(String resourceName)
                               throws IOException

Description copied from interface: SecurityLoader

Return a List of all activities in this security context for a given resource, identified by String.

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

Specified by:

loadAllActivities in interface SecurityLoader

Parameters:

resourceName - The resource we wish to retrieve activities for

Returns:

A List of activities.

Throws:

IOException

loadAllRoles

public List<String> loadAllRoles()
                          throws IOException

Description copied from interface: SecurityLoader

Return a List of all roles in this security context, identified by String.

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

Specified by:

loadAllRoles in interface SecurityLoader

Returns:

A List of Roles, just the name.

Throws:

IOException

loadAllPermissions

public List<Permission> loadAllPermissions()
                                    throws IOException

Description copied from interface: SecurityLoader

Return a List of all permissions in this security context, as Permission objects. (User, role and criteria fields will be left blank in these objects).

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

Specified by:

loadAllPermissions in interface SecurityLoader

Returns:

A List of Permission objects available to this application

Throws:

IOException

loadAllRoleDetails

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

Description copied from interface: SecurityLoader

Return a List of all roles in this security context. Each role is returned as a Map containing (by default) the keys roleId, roleName, description

Specified by:

loadAllRoleDetails in interface SecurityLoader

Returns:

A List of Roles, in Map format.

Throws:

IOException

loadAllUserDetails

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

Description copied from interface: SecurityLoader

Return a List of all users in this security context. Each user is returned as a Map containing (by default) the keys userId, name

Specified by:

loadAllUserDetails in interface SecurityLoader

Returns:

A List of Users, in Map format.

Throws:

IOException

resetSecurityContext

public void resetSecurityContext()
                          throws IOException

Description copied from interface: SecurityLoader

Informs any delegate security contexts to reset themselves.

Specified by:

resetSecurityContext in interface SecurityLoader

Throws:

IOException

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