org.opennms.web.springframework.security

Class SpringSecurityUserDaoImpl

java.lang.Object

org.opennms.web.springframework.security.SpringSecurityUserDaoImpl

All Implemented Interfaces:

SpringSecurityUserDao, org.springframework.beans.factory.InitializingBean

public class SpringSecurityUserDaoImpl
extends Object
implements SpringSecurityUserDao, org.springframework.beans.factory.InitializingBean

Implements the interface to allow Tomcat to check our users.xml file to authenticate users.

This class is Tomcat-specific and will not be portable to other servlet containers. It relies on packages supplied with Tomcat.

Author:

Lawrence Karnowski, Eric Molitor

Field Summary

Fields inherited from interface org.opennms.web.springframework.security.SpringSecurityUserDao

ROLE_USER

Constructor Summary

Constructors

Constructor and Description
SpringSecurityUserDaoImpl() Constructor for SpringSecurityUserDaoImpl.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() afterPropertiesSet
protected Collection<? extends org.springframework.security.core.GrantedAuthority>	getAuthoritiesByUsername(String username) getAuthoritiesByUsername
protected org.springframework.security.core.GrantedAuthority	getAuthority(String role)
SpringSecurityUser	getByUsername(String username) getByUsername
GroupManager	getGroupManager()
long	getGroupsLastModified() getGroupsLastModified
String	getMagicUsersConfigurationFile() getMagicUsersConfigurationFile
long	getMagicUsersLastModified() getMagicUsersLastModified
UserManager	getUserManager()
String	getUsersConfigurationFile() getUsersConfigurationFile
long	getUsersLastModified() getUsersLastModified
boolean	isUseGroups() isUseGroups
void	parseMagicUsers() Parses the magic-users.properties file into two mappings: from magic username to password, and from magic role to authorized users of that role.
void	setGroupManager(GroupManager mgr)
void	setGroupsConfigurationFile(String groupsConfigurationFile) setGroupsConfigurationFile
void	setMagicUsersConfigurationFile(String magicUsersConfigurationFile) setMagicUsersConfigurationFile
void	setUseGroups(boolean useGroups) setUseGroups
void	setUserManager(UserManager mgr)
void	setUsersConfigurationFile(String usersConfigurationFile) setUsersConfigurationFile

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringSecurityUserDaoImpl

public SpringSecurityUserDaoImpl()

Constructor for SpringSecurityUserDaoImpl.

Method Detail

parseMagicUsers

public void parseMagicUsers()
                     throws org.springframework.dao.DataRetrievalFailureException

Parses the magic-users.properties file into two mappings: from magic username to password, and from magic role to authorized users of that role.

Throws:

org.springframework.dao.DataRetrievalFailureException

getAuthority

protected org.springframework.security.core.GrantedAuthority getAuthority(String role)

getAuthoritiesByUsername

protected Collection<? extends org.springframework.security.core.GrantedAuthority> getAuthoritiesByUsername(String username)

getAuthoritiesByUsername

Parameters:

username - a String object.

Returns:

an array of org.springframework.security.GrantedAuthority objects.

setUsersConfigurationFile

public void setUsersConfigurationFile(String usersConfigurationFile)

setUsersConfigurationFile

Parameters:

usersConfigurationFile - a String object.

setGroupsConfigurationFile

public void setGroupsConfigurationFile(String groupsConfigurationFile)

setGroupsConfigurationFile

Parameters:

groupsConfigurationFile - a String object.

setUseGroups

public void setUseGroups(boolean useGroups)

setUseGroups

Parameters:

useGroups - a boolean.

getUsersConfigurationFile

public String getUsersConfigurationFile()

getUsersConfigurationFile

Returns:

a String object.

setMagicUsersConfigurationFile

public void setMagicUsersConfigurationFile(String magicUsersConfigurationFile)

setMagicUsersConfigurationFile

Parameters:

magicUsersConfigurationFile - a String object.

getMagicUsersConfigurationFile

public String getMagicUsersConfigurationFile()

getMagicUsersConfigurationFile

Returns:

a String object.

getByUsername

public SpringSecurityUser getByUsername(String username)

getByUsername

Specified by:

getByUsername in interface SpringSecurityUserDao

Parameters:

username - a String object.

Returns:

a OnmsUser object.

getMagicUsersLastModified

public long getMagicUsersLastModified()

getMagicUsersLastModified

Returns:

a long.

getUsersLastModified

public long getUsersLastModified()

getUsersLastModified

Returns:

a long.

getGroupsLastModified

public long getGroupsLastModified()

getGroupsLastModified

Returns:

a long.

isUseGroups

public boolean isUseGroups()

isUseGroups

Returns:

a boolean.

getUserManager

public UserManager getUserManager()

setUserManager

public void setUserManager(UserManager mgr)

getGroupManager

public GroupManager getGroupManager()

setGroupManager

public void setGroupManager(GroupManager mgr)

afterPropertiesSet

public void afterPropertiesSet()

afterPropertiesSet

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean