Package com.kheops.jmap.server.security

Class AbstractSsoUserManager

java.lang.Object

com.kheops.jmap.server.security.AbstractSsoUserManager

All Implemented Interfaces:

ExternalAuthenticationService, UserManager, Serializable

Direct Known Subclasses:

OidcUserManager, Saml2UserManager

public abstract class AbstractSsoUserManager
extends Object
implements UserManager, ExternalAuthenticationService

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JMapCipher	cipher
static final String	GROUP_ADMINISTRATORS

Fields inherited from interface com.kheops.jmap.server.security.UserManager

USERMANAGER_CONF_HOME, USERMANAGER_PROPS_FILENAME, USERMANAGER_PROPS_NAME, USERNAME_ADMINISTRATOR, USERNAME_ANONYMOUS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSsoUserManager(String databaseDriver, String databaseUrl, String databaseUser, String databasePassword)

Method Summary

Modifier and Type	Method	Description
boolean	addGroup(Group group)	Adds a group to the user manager.
void	addListener(UserManagerListener userManagerListener)	Adds a listener for user or group changes.
boolean	addMemberToGroup(Group group, User user)	Adds a user to a group.
boolean	addUser(User user)	Adds a user to the user manager.
Principal	authenticate(String username, String password)	Authenticates a user with the specified username and password.
boolean	deleteGroup(String name)	Deletes a group from the user manager.
boolean	deleteUser(String username)	Deletes a user from the user manager.
void	destroy()	Closes this UserManager and resets all registered ACL's.
protected void	fireGroupChangedEvent(Group group)
ExternalAuthenticatorInfo	getExternalAuthenticator()	Returns an ExternalAuthenticatorInfo that will be used on the client side to create a new instance of the ExternalAuthenticator to use.
String	getFriendlyName()	Returns the friendly name for this user manager.
Group	getGroup(String name)	Returns the group that corresponds to the specified group name.
User	getUser(String username)	Returns the user that corresponds to the specified username.
Group[]	groups()	Returns all groups managed by the user manager.
boolean	init()	This method will be used by the implementor to do the necessary initialization
boolean	isReadOnly()	Returns whether this user manager is read only.
boolean	load(Properties properties)
void	removeListener(UserManagerListener userManagerListener)	Removes a listener for user or group changes.
boolean	removeMemberFromGroup(Group group, User user)	Removes a user from a group.
Properties	save()
void	setFriendlyName(String friendlyName)	Sets a friendly name for this user manager.
boolean	supportsGroups()	Returns whether this user manager supports groups.
boolean	updateUser(User user)	Sets new information for a user.
protected void	updateUserToken(String username, String token)
User[]	users()	Returns all users managed by the user manager.
void	validate()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kheops.jmap.server.security.ExternalAuthenticationService

validateAuthenticationToken

Methods inherited from interface com.kheops.jmap.server.security.UserManager

getName, getVersion, search, supportsChangePassword

Field Details

GROUP_ADMINISTRATORS

public static final String GROUP_ADMINISTRATORS

See Also:

• Constant Field Values

cipher

protected transient JMapCipher cipher

Constructor Details

AbstractSsoUserManager

protected AbstractSsoUserManager(String databaseDriver,
 String databaseUrl,
 String databaseUser,
 String databasePassword)

Method Details

init

public boolean init()

Description copied from interface: UserManager

This method will be used by the implementor to do the necessary initialization

Specified by:

init in interface UserManager

addUser

public boolean addUser(User user)
                throws SecurityException

Description copied from interface: UserManager

Adds a user to the user manager.

Specified by:

addUser in interface UserManager

Parameters:

user - the corresponding user to be added.

Returns:

true if the user was added successfully.

Throws:

SecurityException

addGroup

public boolean addGroup(Group group)
                 throws SecurityException

Description copied from interface: UserManager

Adds a group to the user manager.

Specified by:

addGroup in interface UserManager

Parameters:

group - the corresponding group to be added.

Returns:

true if the group was added successfully.

Throws:

SecurityException

deleteUser

public boolean deleteUser(String username)
                   throws SecurityException

Description copied from interface: UserManager

Deletes a user from the user manager.

Specified by:

deleteUser in interface UserManager

Parameters:

username - the corresponding user to be deleted

Returns:

true if the user was deleted successfully.

Throws:

SecurityException

deleteGroup

public boolean deleteGroup(String name)
                    throws SecurityException

Description copied from interface: UserManager

Deletes a group from the user manager.

Specified by:

deleteGroup in interface UserManager

Parameters:

name - the corresponding group to be added.

Returns:

true if the group was deleted successfully.

Throws:

SecurityException

updateUser

public boolean updateUser(User user)
                   throws SecurityException

Description copied from interface: UserManager

Sets new information for a user.

Specified by:

updateUser in interface UserManager

Parameters:

user - the new information to set.

Throws:

SecurityException

updateUserToken

protected void updateUserToken(String username,
 String token)

getUser

public User getUser(String username)
             throws SecurityException

Description copied from interface: UserManager

Returns the user that corresponds to the specified username.

Specified by:

getUser in interface UserManager

Parameters:

username - the username to search.

Returns:

the corresponding User instance.

Throws:

SecurityException

getGroup

public Group getGroup(String name)
               throws SecurityException

Description copied from interface: UserManager

Returns the group that corresponds to the specified group name.

Specified by:

getGroup in interface UserManager

Parameters:

name - the name to search.

Returns:

the corresponding Group instance.

Throws:

SecurityException

users

public User[] users()
             throws SecurityException

Description copied from interface: UserManager

Returns all users managed by the user manager.

Specified by:

users in interface UserManager

Returns:

an User array containing all the users.

Throws:

SecurityException

groups

public Group[] groups()
               throws SecurityException

Description copied from interface: UserManager

Returns all groups managed by the user manager.

Specified by:

groups in interface UserManager

Returns:

an Group array containing all the groups

Throws:

SecurityException

authenticate

public Principal authenticate(String username,
 String password)
                       throws SecurityException

Description copied from interface: UserManager

Authenticates a user with the specified username and password.

Specified by:

authenticate in interface UserManager

Parameters:

username - the username to use.

password - the password to use.

Returns:

if the authentication was successful, the user that corresponds to the specified username is returned. Otherwise, null is returned.

Throws:

SecurityException

addMemberToGroup

public boolean addMemberToGroup(Group group,
 User user)
                         throws SecurityException

Description copied from interface: UserManager

Adds a user to a group.

Specified by:

addMemberToGroup in interface UserManager

Parameters:

group - the corresponding group where the user should be added.

user - to be added to the group.

Throws:

SecurityException

removeMemberFromGroup

public boolean removeMemberFromGroup(Group group,
 User user)
                              throws SecurityException

Description copied from interface: UserManager

Removes a user from a group.

Specified by:

removeMemberFromGroup in interface UserManager

Parameters:

group - the corresponding group where the user should be removed.

user - to be removed to the group.

Throws:

SecurityException

load

public boolean load(Properties properties)
             throws SecurityException

Specified by:

load in interface UserManager

Throws:

SecurityException

save

public Properties save()

Specified by:

save in interface UserManager

isReadOnly

public boolean isReadOnly()

Description copied from interface: UserManager

Returns whether this user manager is read only.

Specified by:

isReadOnly in interface UserManager

Returns:

true if read only, false otherwise

supportsGroups

public boolean supportsGroups()

Description copied from interface: UserManager

Returns whether this user manager supports groups.

Specified by:

supportsGroups in interface UserManager

Returns:

true if groups are supported, false otherwise

setFriendlyName

public void setFriendlyName(String friendlyName)

Description copied from interface: UserManager

Sets a friendly name for this user manager.

Specified by:

setFriendlyName in interface UserManager

Parameters:

friendlyName - a friendly name

getFriendlyName

public String getFriendlyName()

Description copied from interface: UserManager

Returns the friendly name for this user manager. If none sets, it returns the name of this user manager.

Specified by:

getFriendlyName in interface UserManager

Returns:

friendly name

fireGroupChangedEvent

protected void fireGroupChangedEvent(Group group)
                              throws SecurityException

Throws:

SecurityException

addListener

public void addListener(UserManagerListener userManagerListener)

Description copied from interface: UserManager

Adds a listener for user or group changes.

Specified by:

addListener in interface UserManager

Parameters:

userManagerListener - the listener object

removeListener

public void removeListener(UserManagerListener userManagerListener)

Description copied from interface: UserManager

Removes a listener for user or group changes.

Specified by:

removeListener in interface UserManager

Parameters:

userManagerListener - the listener object

getExternalAuthenticator

public ExternalAuthenticatorInfo getExternalAuthenticator()

Description copied from interface: ExternalAuthenticationService

Returns an ExternalAuthenticatorInfo that will be used on the client side to create a new instance of the ExternalAuthenticator to use.

Specified by:

getExternalAuthenticator in interface ExternalAuthenticationService

Returns:

the ExternalAuthenticatorInfo instance to use on the client side.

validate

public void validate()
              throws SecurityException

Specified by:

validate in interface UserManager

Throws:

SecurityException

destroy

public void destroy()

Description copied from interface: UserManager

Closes this UserManager and resets all registered ACL's.

Specified by:

destroy in interface UserManager