public class UserDirectoryTools extends GenericService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
UserDirectoryTools() |
Modifier and Type | Method and Description |
---|---|
boolean |
addUserToOrganization(java.lang.Object pUserId,
java.lang.Object pOrganizationId)
This method adds a user specified by a given user id to an
organization specified by a given organization id
|
boolean |
assignRolesToUser(java.util.Collection pRoleIds,
java.lang.Object pUserId)
This method looks for a collection of roles using the passed in
pRoleIds parameter and assigns them to the user
associated with the pUserId
|
boolean |
assignRolesToUser(java.lang.Object[] pRoleIds,
java.lang.Object pUserId)
This method looks for an array of roles using the passed in
pRoleIds parameter and assigns them to the user
associated with the pUserId
|
void |
doStartService()
This method ensures that the
userDirectory property
is set before any method calls are made |
java.util.Collection |
getAllRolesForUser(java.lang.Object pUserId)
Given a UserId, this method returns a collection containing
all assigned roles, relative roles, and roles inherited
from ancestor organizations.
|
UserDirectory |
getUserDirectory()
Gets the userDirectory property
|
boolean |
removeAllRolesFromUser(java.lang.Object pUserId)
This method removes all assigned roles from a user specified
by a given user id.
|
boolean |
removeRolesFromUser(java.util.Collection pRoleIds,
java.lang.Object pUserId)
This method removes roles associated with the given role ids from
a user specified by a given user id.
|
boolean |
removeRolesFromUser(java.lang.Object[] pRoleIds,
java.lang.Object pUserId)
This method removes roles associated with the given role ids from
a user specified by a given user id.
|
boolean |
removeUserFromOrganization(java.lang.Object pUserId,
java.lang.Object pOrganizationId)
This method removes a user specified by a given user id from
an organization specified by a given organization id
|
boolean |
removeUserFromParentOrganization(java.lang.Object pUserId)
This method removes a user from its associated parent organization
|
void |
setUserDirectory(UserDirectory pUserDirectory)
Sets the userDirectory property
|
addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public void setUserDirectory(UserDirectory pUserDirectory)
pUserDirectory
- the user directory used to perform
operationspublic UserDirectory getUserDirectory()
public boolean assignRolesToUser(java.lang.Object[] pRoleIds, java.lang.Object pUserId)
pRoleIds
parameter and assigns them to the user
associated with the pUserId
pRoleIds
- the primary keys of the roles that will be
assigned to the userpUserId
- the primary key of the user that will have roles
assigned to itpublic java.util.Collection getAllRolesForUser(java.lang.Object pUserId)
pUserId
- the primary key of the user for which to get roles.public boolean assignRolesToUser(java.util.Collection pRoleIds, java.lang.Object pUserId)
pRoleIds
parameter and assigns them to the user
associated with the pUserId
pRoleIds
- the primary keys of the roles that will be
assigned to the userpUserId
- the primary key of the user that will have roles
assigned to itpublic boolean addUserToOrganization(java.lang.Object pUserId, java.lang.Object pOrganizationId)
pOrganizationId
- the primary key of the organization to
which the user is to be addedpUserId
- the primary key of the user to add to the
organizationpublic boolean removeRolesFromUser(java.lang.Object[] pRoleIds, java.lang.Object pUserId)
pRoleIds
- the primary keys of the roles that are to be
removed from the userpUserId
- the primary key of the userpublic boolean removeRolesFromUser(java.util.Collection pRoleIds, java.lang.Object pUserId)
pRoleIds
- the primary keys of the roles that are to be
removed from the userpUserId
- the primary key of the userpublic boolean removeUserFromOrganization(java.lang.Object pUserId, java.lang.Object pOrganizationId)
pUserId
- the primary key of the user to removepOrganizationId
- the primary key of the organization
the user is to be removed frompublic boolean removeUserFromParentOrganization(java.lang.Object pUserId)
pUserId
- the id of the user who will be removed from
its current parent organizationpublic boolean removeAllRolesFromUser(java.lang.Object pUserId)
pUserId
- the primary key of the user whose roles will be
removedpublic void doStartService() throws ServiceException
userDirectory
property
is set before any method calls are madedoStartService
in class GenericService
ServiceException
- if the userDirectory
property
is not set