com.beasys.commerce.axiom.contact
Class UserManagerBean

java.lang.Object
  |
  +--com.beasys.commerce.axiom.contact.UserManagerBean

All Implemented Interfaces:

javax.ejb.EnterpriseBean, SchemaManagerConstants, java.io.Serializable, javax.ejb.SessionBean, UserManagementConstants

public class UserManagerBean

extends java.lang.Object

implements javax.ejb.SessionBean, UserManagementConstants

This is the public interface class for the user management session bean. It provides functionality for creating and removing users and groups, manipulating user/group relationships, and accessing system level information for users and groups.

Version:

$Revision$, $Date$

Author:

original: Tim Breeden, latest: $Author$

See Also:

Serialized Form

Fields inherited from interface com.beasys.commerce.axiom.contact.UserManagementConstants

ANONYMOUS_PROFILE, CACHED_PROFILE, DEFAULT_SCOPE, DEFAULT_SUCCESSOR, DEFAULT_SUCCESSOR_HOME, DEFAULT_SUCCESSOR_JNDI, DEFAULT_SUCCESSOR_PK, DEFAULT_USER, DEFAULT_USER_HOME, DEFAULT_USER_JNDI, DEFAULT_USER_PK, GROUP, GROUP_ENTITY_HOME, PROFILE_MGR, PROFILE_SUCCESSOR, PROFILE_USER, REALM_CONFIG, RESERVED_SCOPE, USER, USER_ENTITY_HOME, USER_MGR

Fields inherited from interface com.beasys.commerce.foundation.property.SchemaManagerConstants

APPLICATION_INIT_TYPE, CATALOG_TYPE, CONTENT_TYPE, REQUEST_TYPE, SCHEMA, SCHEMA_GROUPS, SESSION_TYPE, USER_TYPE

Constructor Summary

UserManagerBean()

Method Summary

void	addGroupToGroup(java.lang.String parentGroup, java.lang.String childGroup) Adds childGroup as a child of parentGroup.
void	addUserToGroup(java.lang.String username, java.lang.String groupName) Adds a user to a group.
void	authenticate(java.lang.String username, java.lang.String password) Throws an AuthenticationException if the user is not a valid user or credentials are invalid.
protected void	authorizeUserModification(java.lang.String username)
void	changeGroupName(java.lang.String oldGroupName, java.lang.String newGroupName) Changes the name of an existing group.
Group	createGroup(java.lang.String groupName, java.lang.String parentName) Creates a group.
User	createUser(java.lang.String username, java.lang.String password) Creates a user.
User	createUser(java.lang.String username, java.lang.String password, java.lang.String profileType) Creates a user of a specific type, based on entries in the UnifiedProfileType tools.
void	ejbActivate() This method is required by the EJB Specification, but is not used by this class.
void	ejbCreate() Creates the session bean.
void	ejbPassivate() This method is required by the EJB Specification, but is not used by this class.
void	ejbRemove() This method is required by the EJB Specification, but is not used by this class.
java.lang.String[]	getAllGroupNames() Get the names of all the groups in the system.
java.lang.String[]	getCachedGroupNamesForUser(java.lang.String username) Returns the list of group names of which a user is a member, from a pre-calculated cache.
java.lang.String[]	getChildGroupNames(java.lang.String parentGroup) Gets the names of all child groups.
Group[]	getChildGroups(java.lang.String parentGroup) Gets all the child groups of a given group.
protected java.util.Map	getDefaultScopedProperties(java.lang.String pkString, java.lang.String home) Returns a map of propertyName->propertyMetaData objects for any null-scoped properties that are set for the given user or group.
java.util.Map	getDefaultScopedPropertiesForGroup(java.lang.String groupname) Returns a map of propertyName->propertyMetaData objects for any null-scoped properties that are set for the given group.
java.util.Map	getDefaultScopedPropertiesForUser(java.lang.String username) Returns a map of propertyName->propertyMetaData objects for any null-scoped properties that are set for the given user.
java.util.Map	getDynamicPropertiesForGroup(java.lang.String name, java.lang.String scopeName, java.lang.String schemaGroupName) Returns a map of propertyName->propertyMetaData objects for any dynamically defined properties (properties that are not defined in a PropertySet) for a group.
java.util.Map	getDynamicPropertiesForUser(java.lang.String username, java.lang.String scopeName, java.lang.String schemaGroupName) Returns a map of propertyName->propertyMetaData objects for any dynamically defined properties (properties that are not defined in a PropertySet) for a user.
long	getGroupId(java.lang.String groupName) Returns the unique numeric id for a group.
java.lang.String	getGroupName(long id) Returns the name of the group that corresponds to this numeric id.
java.lang.String[]	getGroupNamesForUser(java.lang.String username) Returns the list of group names of which a user is a member.
Group[]	getGroupsForUser(java.lang.String username) Returns the list of groups of which a user is a member.
java.lang.String	getParentGroupName(java.lang.String childGroupName) Retrieves the parent group name for a group.
UnifiedProfileType	getProfileTypeForUser(java.lang.String username)
protected javax.ejb.SessionContext	getSessionContext()
java.lang.String[]	getTopLevelGroupNames() Get the names of all of the groups that do not have parents
Group[]	getTopLevelGroups() Get all of the group entities that do not have parents
long	getUserId(java.lang.String username) Returns the unique numeric id for a user.
java.lang.String	getUserName(long id) Returns the name of the user that corresponds to this numeric id.
java.lang.String[]	getUserNames(java.lang.String searchExpression, int limit) Returns an array users' names matching the search expression Handled through SPI
java.lang.String[]	getUserNamesForGroup(java.lang.String groupName, java.lang.String searchExpression, int limit) Returns a group's list of members in the form of users' names
User	getUserObject(java.lang.String username) Returns a user profile for a user.
User[]	getUsersForGroup(java.lang.String groupname, java.lang.String searchExpression, int limit) Returns a group's list of members as user objects
boolean	isDescendant(java.lang.String parentGroupName, java.lang.String childGroupName) Indicates whether the group referenced by the child name is a descendant of the group referenced by the parent name.
void	removeGroup(java.lang.String groupName) Removes a group from the system.
void	removeGroupFromGroup(java.lang.String parentGroup, java.lang.String childGroup) Removes childGroup from parentGroup.
void	removeUser(java.lang.String username) Removes a user from the system.
void	removeUser(java.lang.String username, java.lang.String profileType) Removes a user from the system as a specific profile type.
void	removeUserFromGroup(java.lang.String username, java.lang.String groupName) Removes a user from a group.
void	setPassword(java.lang.String username, java.lang.String password) Sets the password in the database for a user, encrypted using MD5.
void	setSessionContext(javax.ejb.SessionContext ctx) Sets the session context.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserManagerBean

public UserManagerBean()

Method Detail

ejbCreate

public void ejbCreate()

Creates the session bean.

ejbActivate

public void ejbActivate()

This method is required by the EJB Specification, but is not used by this class.

Specified by:

ejbActivate in interface javax.ejb.SessionBean

ejbRemove

public void ejbRemove()

This method is required by the EJB Specification, but is not used by this class.

Specified by:

ejbRemove in interface javax.ejb.SessionBean

ejbPassivate

public void ejbPassivate()

This method is required by the EJB Specification, but is not used by this class.

Specified by:

ejbPassivate in interface javax.ejb.SessionBean

setSessionContext

public final void setSessionContext(javax.ejb.SessionContext ctx)

Sets the session context.

Specified by:

setSessionContext in interface javax.ejb.SessionBean

Parameters:

ctx - Context for session

getSessionContext

protected javax.ejb.SessionContext getSessionContext()

authenticate

public void authenticate(java.lang.String username,
                         java.lang.String password)
                  throws AuthenticationException,
                         UserManagementException

Throws an AuthenticationException if the user is not a valid user or credentials are invalid.

Parameters:

username - the username for the user

password - the password for the user

Throws:

AuthenticationException - if the user is not a valid user or credentials are incorrect

UserManagementException - if a system error occurs

getUserObject

public User getUserObject(java.lang.String username)
                   throws UserManagementException

Returns a user profile for a user.

Parameters:

username - the username for the user

Returns:

a user profile for a user

Throws:

UserManagmentException - if a system error occurs

createUser

public User createUser(java.lang.String username,
                       java.lang.String password)
                throws UserAlreadyExistsException,
                       UserManagementException,
                       InvalidUsernameException,
                       InvalidPasswordException,
                       ReservedUsernameException

Creates a user.

Parameters:

username - the username for the new user

password - the password for the new user

Throws:

InvalidPasswordException - if the password is malformed or otherwise invalid

InvalidUsernameException - if the username is malformed or otherwise invalid

UserAlreadyExistsException - if the username is already in use

UserManagmentException - if a system error occurs

createUser

public User createUser(java.lang.String username,
                       java.lang.String password,
                       java.lang.String profileType)
                throws UserAlreadyExistsException,
                       java.rmi.RemoteException,
                       UserManagementException,
                       InvalidUsernameException,
                       InvalidPasswordException

Creates a user of a specific type, based on entries in the UnifiedProfileType tools. The newly created user will be returned as a User, but can be casted to the correct type.

Parameters:

username - the username for the new user

password - the password for the new user

profileType - the name of the profile type for the new user

Returns:

the new user

Throws:

InvalidPasswordException - if the password is malformed or otherwise invalid

InvalidUsernameException - if the username is malformed or otherwise invalid

UserAlreadyExistsException - if the username is already in use

UserManagmentException - if a system error occurs

setPassword

public void setPassword(java.lang.String username,
                        java.lang.String password)
                 throws InvalidPasswordException,
                        UserManagementException

Sets the password in the database for a user, encrypted using MD5.

Parameters:

username - the username of the user

password - the new password for the user

Throws:

InvalidPasswordException - if the password is malformed or otherwise invalid

UserManagmentException - if a system error occurs

createGroup

public Group createGroup(java.lang.String groupName,
                         java.lang.String parentName)
                  throws InvalidGroupNameException,
                         GroupAlreadyExistsException,
                         UserManagementException,
                         ReservedGroupNameException

Creates a group.

Parameters:

groupName - the name for the new group

parentName - the name for the new group's parent. If null the newly-created group is a top level group.

Throws:

GroupAlreadyExistsException - if the group name is already in use

InvalidGroupNameException - if the group name is malformed or otherwise invalid

UserManagmentException - if a system error occurs

removeUser

public void removeUser(java.lang.String username)
                throws UserManagementException

Removes a user from the system.

Parameters:

username - the username of the user to remove

Throws:

UserManagmentException - if a system error occurs

removeUser

public void removeUser(java.lang.String username,
                       java.lang.String profileType)
                throws UserManagementException,
                       java.rmi.RemoteException

Removes a user from the system as a specific profile type. This ensures that data specific to a profile type will get cleaned up correctly.

Parameters:

username - the username of the user to remove

profileType - the type of user

Throws:

UserManagmentException - if a system error occurs

removeGroup

public void removeGroup(java.lang.String groupName)
                 throws UserManagementException

Removes a group from the system.

Parameters:

groupName - the name of the group to remove

Throws:

UserManagmentException - if a system error occurs

addUserToGroup

public void addUserToGroup(java.lang.String username,
                           java.lang.String groupName)
                    throws UserManagementException

Adds a user to a group.

Parameters:

username - the username of the user to add

groupName - the name to the group to which the user should be added

Throws:

UserManagmentException - if a system error occurs

removeUserFromGroup

public void removeUserFromGroup(java.lang.String username,
                                java.lang.String groupName)
                         throws UserManagementException

Removes a user from a group.

Parameters:

username - the username of the user to remove

groupName - the name of the group from which the user should be removed

Throws:

UserManagmentException - if a system error occurs

getAllGroupNames

public java.lang.String[] getAllGroupNames()
                                    throws UserManagementException

Get the names of all the groups in the system.

Returns:

an array of group names

Throws:

UserManagmentException - if a system error occurs

getTopLevelGroupNames

public java.lang.String[] getTopLevelGroupNames()
                                         throws UserManagementException

Get the names of all of the groups that do not have parents

Returns:

an array of group names

Throws:

UserManagmentException - if a system error occurs

getTopLevelGroups

public Group[] getTopLevelGroups()
                          throws UserManagementException

Get all of the group entities that do not have parents

Returns:

an array of group entities

Throws:

UserManagmentException - if a system error occurs

getGroupNamesForUser

public java.lang.String[] getGroupNamesForUser(java.lang.String username)
                                        throws UserManagementException

Returns the list of group names of which a user is a member.

Parameters:

username - the username of the user

Returns:

the list of groups of which a user is a member

Throws:

UserManagmentException - if a system error occurs

getCachedGroupNamesForUser

public java.lang.String[] getCachedGroupNamesForUser(java.lang.String username)
                                              throws UserManagementException

Returns the list of group names of which a user is a member, from a pre-calculated cache. Use this in a system where there is a deep group hierarchy, or just a large number of groups, for performance gains. The refresh interval of the GroupCache startup class should be tuned to minimize data inconsistencies caused by pre-calculating this information.

Parameters:

username - the username of the user

Returns:

the list of groups of which a user is a member

Throws:

UserManagmentException - if a system error occurs

getUserNamesForGroup

public java.lang.String[] getUserNamesForGroup(java.lang.String groupName,
                                               java.lang.String searchExpression,
                                               int limit)
                                        throws UserManagementException

Returns a group's list of members in the form of users' names

Parameters:

groupName - the name of the group

searchExpression - a search expression such as "J* Smith" - however if using a realm other than the default com.beasys.commerce.axiom.contact.security.RDBMSRealm, then the searchExpression must be an exact username

limit - a limit of results to return

Throws:

UserManagmentException - if a system error occurs

getGroupsForUser

public Group[] getGroupsForUser(java.lang.String username)
                         throws UserManagementException

Returns the list of groups of which a user is a member.

Parameters:

username - the username of the user

Returns:

the list of groups of which a user is a member

Throws:

UserManagmentException - if a system error occurs

getUsersForGroup

public User[] getUsersForGroup(java.lang.String groupname,
                               java.lang.String searchExpression,
                               int limit)
                        throws UserManagementException

Returns a group's list of members as user objects

Parameters:

groupName - the name of the group

searchExpression - a search expression such as "J* Smith" - however if using a realm other than the default com.beasys.commerce.axiom.contact.security.RDBMSRealm, then the searchExpression must be an exact username

limit - a limit of results to return

Throws:

UserManagmentException - if a system error occurs

getUserNames

public java.lang.String[] getUserNames(java.lang.String searchExpression,
                                       int limit)
                                throws UserManagementException

Returns an array users' names matching the search expression Handled through SPI

Parameters:

searchExpression - a search expression such as "J* Smith" - however if using a realm other than the default com.beasys.commerce.axiom.contact.security.RDBMSRealm, then the searchExpression must be an exact username

limit - a limit of results to return

Throws:

UserManagmentException - if a system error occurs

addGroupToGroup

public void addGroupToGroup(java.lang.String parentGroup,
                            java.lang.String childGroup)
                     throws UserManagementException

Adds childGroup as a child of parentGroup.

Parameters:

parentGroup - the name of the parent group

childGroup - the name of the group to add

Throws:

UserManagmentException - if a system error occurs

removeGroupFromGroup

public void removeGroupFromGroup(java.lang.String parentGroup,
                                 java.lang.String childGroup)
                          throws UserManagementException

Removes childGroup from parentGroup.

Parameters:

parentGroup - the name of the parent group

childGroup - the name of the group to remove

Throws:

UserManagmentException - if a system error occurs

getChildGroupNames

public java.lang.String[] getChildGroupNames(java.lang.String parentGroup)
                                      throws UserManagementException

Gets the names of all child groups.

Parameters:

parentGroup - the group whose children to retrieve

Returns:

an array of the names of this group's children

Throws:

UserManagmentException - if a system error occurs

getChildGroups

public Group[] getChildGroups(java.lang.String parentGroup)
                       throws UserManagementException

Gets all the child groups of a given group.

Parameters:

parentGroup - the group whose children to retrieve

Returns:

an array of this group's children

Throws:

UserManagmentException - if a system error occurs

changeGroupName

public void changeGroupName(java.lang.String oldGroupName,
                            java.lang.String newGroupName)
                     throws UserManagementException

Changes the name of an existing group.

Parameters:

oldGroupName - the old group name

newGroupName - the new group name

Throws:

UserManagmentException - if a system error occurs

getParentGroupName

public java.lang.String getParentGroupName(java.lang.String childGroupName)
                                    throws UserManagementException

Retrieves the parent group name for a group.

Parameters:

childGroupName - the name of the group whose parent group name is sought

Returns:

parent group name; null if no parent

Throws:

UserManagmentException - if a system error occurs

isDescendant

public boolean isDescendant(java.lang.String parentGroupName,
                            java.lang.String childGroupName)
                     throws UserManagementException

Indicates whether the group referenced by the child name is a descendant of the group referenced by the parent name.

Parameters:

childGroupName - the potential descendant

parentGroupName - the potential ancestor

Returns:

whether the child descends the parent

Throws:

UserManagmentException - if a system error occurs

getGroupId

public long getGroupId(java.lang.String groupName)
                throws UserManagementException

Returns the unique numeric id for a group.

Parameters:

groupName - the name of the group

Throws:

UserManagmentException - if a system error occurs

getUserId

public long getUserId(java.lang.String username)
               throws UserManagementException

Returns the unique numeric id for a user.

Parameters:

username - the name of the user

Throws:

UserManagmentException - if a system error occurs

getGroupName

public java.lang.String getGroupName(long id)
                              throws UserManagementException

Returns the name of the group that corresponds to this numeric id.

Parameters:

id - the numeric id representing the group

Throws:

UserManagmentException - if a system error occurs

getUserName

public java.lang.String getUserName(long id)
                             throws UserManagementException

Returns the name of the user that corresponds to this numeric id.

Parameters:

id - the numeric id representing the user

Throws:

UserManagmentException - if a system error occurs

getDefaultScopedPropertiesForUser

public java.util.Map getDefaultScopedPropertiesForUser(java.lang.String username)
                                                throws UserManagementException

Returns a map of propertyName->propertyMetaData objects for any null-scoped properties that are set for the given user.

Parameters:

username - the username representing the user

Throws:

UserManagmentException - if a system error occurs

getDefaultScopedPropertiesForGroup

public java.util.Map getDefaultScopedPropertiesForGroup(java.lang.String groupname)
                                                 throws UserManagementException

Returns a map of propertyName->propertyMetaData objects for any null-scoped properties that are set for the given group.

Parameters:

groupName - the group name representing the user

Throws:

UserManagmentException - if a system error occurs

getDefaultScopedProperties

protected java.util.Map getDefaultScopedProperties(java.lang.String pkString,
                                                   java.lang.String home)
                                            throws UserManagementException

Returns a map of propertyName->propertyMetaData objects for any null-scoped properties that are set for the given user or group.

Parameters:

pkString - the identifier of the user or group

home - the home name of the user or group

Throws:

UserManagmentException - if a system error occurs

getDynamicPropertiesForUser

public java.util.Map getDynamicPropertiesForUser(java.lang.String username,
                                                 java.lang.String scopeName,
                                                 java.lang.String schemaGroupName)
                                          throws UserManagementException

Returns a map of propertyName->propertyMetaData objects for any dynamically defined properties (properties that are not defined in a PropertySet) for a user.

Parameters:

username - the name of the user

Throws:

UserManagmentException - if a system error occurs

getDynamicPropertiesForGroup

public java.util.Map getDynamicPropertiesForGroup(java.lang.String name,
                                                  java.lang.String scopeName,
                                                  java.lang.String schemaGroupName)
                                           throws UserManagementException

Returns a map of propertyName->propertyMetaData objects for any dynamically defined properties (properties that are not defined in a PropertySet) for a group.

Parameters:

groupname - the name of the group

Throws:

UserManagmentException - if a system error occurs

getProfileTypeForUser

public UnifiedProfileType getProfileTypeForUser(java.lang.String username)
                                         throws UserManagementException

authorizeUserModification

protected void authorizeUserModification(java.lang.String username)